Ubuntu 18.04.1 LTS. Download the latest LTS version of Ubuntu, for desktop PCs and laptops. LTS stands for long-term support — which means five years, until April 2023, of free security and maintenance updates, guaranteed. For other versions of Ubuntu Desktop including torrents, the network installer, a list of local mirrors.
Orca is an Electron app that generates images and reports of Plotly things likeplotly.js graphs, dash apps, dashboards from the command line. Additionally,Orca is the backbone of Plotly's Image Server. Orca is also an acronym forOpen-source Report Creator App.
Visit plot.ly to learn more or visit the Plotly forum.
Follow @plotlygraphs on Twitter for Orca announcements.
Installation
Method 1: conda
If you have conda installed, you can easily install Orca from the plotlyconda channel using:
which makes the
orca
executable available on the path of current condaenvironment.Method 2: npm
If you have Node.js installed (recommended v8.x), you can easily install Orcausing npm as:
which makes the
orca
executable available in your path.Method 3: Standalone binaries
Alternatively, you can download the standalone Orca binaries corresponding toyour operating system from therelease page. Then, on
Mac OS
- Unzip the
mac-release.zip
file. - Double-click on the
orca-X.Y.Z.dmg
file. This will open an installation window. - Drag the orca icon into the
Applications
folder. - Open finder and navigate to the
Applications/
folder. - Right-click on the orca icon and select Open from the context menu.
- A password dialog will appear asking for permission to add orca to your system
PATH
. - Enter you password and click OK.
- This should open an Installation Succeeded window.
- Open a new terminal and verify that the orca executable is available on your
PATH
.
Windows
- Extract the
windows-release.zip
file. - In the
release
folder, double-click onorca Setup X.Y.Z
, this will create an orca icon on your Desktop. - Right-click on the orca icon and select Properties from the context menu.
- From the Shortcut tab, copy the directory in the Start in field.
- Add this Start in directory to you system
PATH
(see below). - Open a new Command Prompt and verify that the orca executable is available on your
PATH
.
Windows References
- How to set the path and environment variables in Windows: https://www.computerhope.com/issues/ch000549.htm
Linux
- Make the orca AppImage executable.
- Create a symbolic link named
orca
somewhere on yourPATH
that pointsto the AppImage.
- Open a new terminal and verify that the orca executable is available on your
PATH
.
Linux Troubleshooting: Cannot open shared object
The Electron runtime depends a several common system libraries. Theselibraries are pre-installed in most desktop Linux distributions(e.g. Ubuntu), but are not pre-installed on some server Linux distributions(e.g. Ubuntu Server). If a shared library is missing, you will see an errormessage like:
These additional dependencies can be satisfied by installing:
- The
libgtk2.0-0
andlibgconf-2-4
packages from your distribution'ssoftware repository. - The
google-chrome-stable
package from the Google Linux SoftwareRepository.
Linux Troubleshooting: Headless server configuration
The Electron runtime requires the presence of an active X11 display server,but many server Linux distributions (e.g. Ubuntu Server) do not include X11by default. If you do not wish to install X11 on your server, you mayinstall and run orca with Xvfb instead.
On Ubuntu Server, you can install Xvfb like this:
To run orca under Xvfb, replace the symbolic link suggested above with a shellscript that runs the orca AppImage executable using the
xvfb-run
command.Name this shell script
orca
and place it somewhere or your system PATH
.Linux References
- How to add directory to system path in Linux: https://www.computerhope.com/issues/ch001647.htm
- AppImage: https://appimage.org/
- Xvfb: https://en.wikipedia.org/wiki/Xvfb
Quick start
From the command line:Unix/MacOS:
Windows:
generates a PNG from the inputted plotly.js JSON attributes. Or,
generates an SVG from a plotly.js JSON hosted on plot.ly.
When running
To print info about the supported arguments, run:
To call
orca
from a Python script:To call
orca
from an R script:API usage
Using the
orca
npm module allows developers to build their ownPlotly exporting tool. We export two Electron app creator methods run
andserve
. Both methods return an Electron app
object (which is an eventlistener/emitter).To create a runner app:
then launch it with
electron main.js
Or, to create a server app:
then launch it with
electron main.js
Plotly's image server
Plotly's image server is dockerized and deployed here. See the
deployment/
README for more info.System dependencies
If you don't care about exporting EPS or EMF you can skip this section.
The environment you're installing this into may require Poppler for EPS exports and Inkscape for EMF exports.
Poppler installation via Aptitude (used by some *nix/BSD, e.g. Ubuntu)
Poppler installation via Homebrew (third-party package manager for Mac OS X)
Inkscape installation via Aptitude (used by some *nix/BSD, e.g. Ubuntu)
Inkscape installation via Homebrew (third-party package manager for Mac OS X)
Contributing
SeeCONTRIBUTING.md.You can also contact us if youwould like a specific feature added.
Tests and Linux builds | Mac OS build | Windows build |
---|
License
Code released under the MIT ©License.