• Stars
    star
    294
  • Rank 141,303 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 7 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Command line application for generating static images of interactive plotly charts

Orca

orca logo

npm version MIT License

Orca is an Electron app that generates images and reports of Plotly things like plotly.js graphs, dash apps, dashboards from the command line. Additionally, Orca is the backbone of Plotly's Image Server. Orca is also an acronym for Open-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 plotly conda channel using:

$ conda install -c plotly plotly-orca

which makes the orca executable available on the path of current conda environment.

Method 2: npm

If you have Node.js installed (recommended v8.x), you can easily install Orca using npm as:

$ npm install -g [email protected] orca

which makes the orca executable available in your path.

Method 3: Docker

$ docker pull quay.io/plotly/orca

Usage

If no arguments are specified, it starts an Orca server on port 9091. You can publish the port to the outside world the usual way:

$ docker run -d -p 9091:9091 quay.io/plotly/orca

If the first argument is graph, it executes the command line application orca graph:

$ docker run -i quay.io/plotly/orca graph --help

Method 4: Standalone binaries

Alternatively, you can download the standalone Orca binaries corresponding to your operating system from the release 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.
$ which orca
/usr/local/bin/orca

$ orca --help
Plotly's image-exporting utilities

  Usage: orca [--version] [--help] <command> [<args>]
  ...

Windows

  • Extract the windows-release.zip file.
  • In the release folder, double-click on orca 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.
> orca --help
Plotly's image-exporting utilities

  Usage: orca [--version] [--help] <command> [<args>]
  ...
Windows References

Linux

  • Make the orca AppImage executable.
$ chmod +x orca-X.Y.Z-x86_64.AppImage
  • Create a symbolic link named orca somewhere on your PATH that points to the AppImage.
$ ln -s /path/to/orca-X.Y.Z-x86_64.AppImage /somewhere/on/PATH/orca
  • Open a new terminal and verify that the orca executable is available on your PATH.
$ which orca
/somewhere/on/PATH/orca

$ orca --help
Plotly's image-exporting utilities

  Usage: orca [--version] [--help] <command> [<args>]
  ...
Linux Troubleshooting: Cannot open shared object

The Electron runtime depends a several common system libraries. These libraries 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 error message like:

$ orca --help
orca: error while loading shared libraries: libgtk-x11-2.0.so.0:
cannot open shared object file: No such file or directory

These additional dependencies can be satisfied by installing:

  • The libgtk2.0-0 and libgconf-2-4 packages from your distribution's software repository.
  • The chromium-browser package from your distribution's software repository.
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 X11 by default. If you do not wish to install X11 on your server, you may install and run orca with Xvfb instead.

On Ubuntu Server, you can install Xvfb like this:

$ sudo apt-get install xvfb

To run orca under Xvfb, replace the symbolic link suggested above with a shell script that runs the orca AppImage executable using the xvfb-run command.

#!/bin/bash
xvfb-run -a /path/to/orca-X.Y.Z-x86_64.AppImage "$@"

Name this shell script orca and place it somewhere on your system PATH.

Linux References

Quick start

From the command line: Unix/MacOS:

$ orca graph '{ "data": [{"y": [1,2,1]}] }' -o fig.png

Windows:

orca graph "{ \"data\": [{\"y\": [1,2,1]}] }" -o fig.png

generates a PNG from the inputted plotly.js JSON attributes. Or,

$ orca graph https://plot.ly/~empet/14324.json --format svg

generates an SVG from a plotly.js JSON hosted on plot.ly.

When running

To print info about the supported arguments, run:

$ orca --help
$ orca <command> --help

To call orca from a Python script:

from subprocess import call
import json
import plotly

fig = {"data": [{"y": [1,2,1]}]}
call(['orca', 'graph', json.dumps(fig, cls=plotly.utils.PlotlyJSONEncoder)])

To call orca from an R script:

library(plotly)

p <- plot_ly(x = 1:10, y = 1:10, color = 1:10)
orca(p, "plot.svg")

API usage

Using the orca npm module allows developers to build their own Plotly exporting tool. We export two Electron app creator methods run and serve. Both methods return an Electron app object (which is an event listener/emitter).

To create a runner app:

// main.js

const orca = require('orca/src')

const app = orca.run({
  component: 'plotly-graph',
  input: 'path-to-file' || 'glob*' || url || '{data: [], layout: {}}' || [/* array of those */],
  debug: true
})

app.on('after-export', (info) => {
  fs.writeFile('output.png', info.body, (err) => console.warn(err))
})

// other available events:
app.on('after-export-all', () => {})
app.on('export-error', () => {})
app.on('renderer-error', () => {})

then launch it with electron main.js

Or, to create a server app:

// main.js

const orca = require('orca/src')

const app = orca.serve({
  port: 9090,
  component: 'component name ' || [{
    name: 'plotly-graph',
    path: /* path to module if none given, tries to resolve ${name} */,
    route: /* default to same as ${name} */,

    // other options passed to component methods
    options: {
      plotlyJS: '',
      mathjax: '',
      topojson: '',
      mapboxAccessToken: ''
    }
  }, {
    // other component
  }, {
    // other component ...
  }],

  debug: false || true
})

app.on('after-export', (info) => {
  console.log(info)
})

// other available events:
app.on('after-connect', () => {})
app.on('export-error', () => {})
app.on('renderer-error', () => {})

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)

$ apt-get install poppler-utils (requires `sudo` or root privileges)

Poppler installation via Homebrew (third-party package manager for Mac OS X)

$ brew install poppler

Inkscape installation via Aptitude (used by some *nix/BSD, e.g. Ubuntu)

$ apt-get install inkscape (requires `sudo` or root privileges)

Inkscape installation via Homebrew (third-party package manager for Mac OS X)

$ brew install inkscape

Contributing

See CONTRIBUTING.md. You can also contact us if you would like a specific feature added.

Tests and Linux builds Mac OS build Windows build Docker build
CircleCI Build Status AppVeyor Docker Repository on Quay

License

Code released under the MIT © License.

More Repositories

1

dash

Data Apps & Dashboards for Python. No JavaScript Required.
Python
19,422
star
2

plotly.js

Open-source JavaScript charting library behind Plotly and Dash
JavaScript
16,743
star
3

plotly.py

The interactive graphing library for Python ✨ This project now includes Plotly Express!
Python
15,980
star
4

falcon

Free, open-source SQL client for Windows and Mac 🦅
JavaScript
5,130
star
5

dash-sample-apps

Open-source demos hosted on Dash Gallery
Jupyter Notebook
3,133
star
6

plotly.R

An interactive graphing library for R
R
2,549
star
7

plotly.rs

Plotly for Rust
Rust
1,093
star
8

dash-recipes

A collection of scripts and examples created while answering questions from the greater Dash community
Python
989
star
9

react-plotly.js

A plotly.js React component from Plotly 📈
JavaScript
922
star
10

react-pivottable

React-based drag'n'drop pivot table with Plotly.js charts
JavaScript
907
star
11

jupyter-dash

Develop Dash apps in the Jupyter Notebook and JupyterLab
Python
906
star
12

plotly_express

Plotly Express - Simple syntax for complex charts. Now integrated into plotly.py!
Python
685
star
13

Plotly.NET

interactive graphing library for .NET programming languages 📈
F#
654
star
14

datasets

Datasets used in Plotly examples and documentation
HTML
637
star
15

dash-cytoscape

Interactive network visualization in Python and Dash, powered by Cytoscape.js
Python
592
star
16

dash-bio

Open-source bioinformatics components for Dash
Python
528
star
17

Dash.jl

Dash for Julia - A Julia interface to the Dash ecosystem for creating analytic web applications in Julia. No JavaScript required.
Julia
486
star
18

react-cytoscapejs

React component for Cytoscape.js network visualisations
JavaScript
472
star
19

react-chart-editor

Customizable React-based editor panel for Plotly charts
JavaScript
460
star
20

spectacle-editor

Drag and drop Spectacle editor.
JavaScript
442
star
21

dash-table

OBSOLETE: now part of https://github.com/plotly/dash
Python
421
star
22

documentation

Issue tracker for Plotly's open-source documentation.
419
star
23

dashR

Create data science and AI web apps in R
JavaScript
382
star
24

plotly_matlab

Plotly Graphing Library for MATLAB®
MATLAB
375
star
25

dash-docs

📖 ISSUE TRACKER ONLY for The Official Dash Userguide & Documentation https://dash.plotly.com/
Python
371
star
26

Kaleido

Fast static image export for web-based visualization libraries with zero dependencies
PostScript
362
star
27

jupyterlab-dash

An Extension for the Interactive development of Dash apps in JupyterLab
Python
360
star
28

dash-core-components

OBSOLETE: now part of https://github.com/plotly/dash
Python
270
star
29

dash-component-boilerplate

Get started creating your own Dash components here.
Python
269
star
30

IPython-plotly

A collection of data science IPython notebooks with Plotly graphs
HTML
266
star
31

angular-plotly.js

TypeScript
229
star
32

jupyterlab-chart-editor

JupyterLab extension for Plotly's react-chart-editor
TypeScript
213
star
33

arduino-api

Arduino library for real-time logging and streaming data to online plotly graphs
Python
209
star
34

dash-pivottable

react-pivottable in Dash
Python
192
star
35

dash-oil-and-gas-demo

Dash Demo App - New York Oil and Gas
Python
182
star
36

plotlyjs-flask-example

A simple plotly.js example served with flask
Python
179
star
37

dashboards

Superseded by Dash!
179
star
38

dash-detr

A User Interface for DETR built with Dash. 100% Python.
Python
178
star
39

dash-table-experiments

NO LONGER SUPPORTED - use https://github.com/plotly/dash-table instead
JavaScript
175
star
40

dash-ag-grid

Dash AG Grid is a high-performance and highly customizable component that wraps AG Grid, designed for creating rich datagrids.
Python
170
star
41

plotly-nodejs

node.js wrapper for Plotly's Chart Studio Streaming and REST APIs
JavaScript
166
star
42

colorlover

Color scales in Python for humans
Python
158
star
43

dash-html-components

OBSOLETE - now part of https://github.com/plotly/dash
Python
154
star
44

dash-svm

Interactive SVM Explorer, using Dash and scikit-learn
Python
153
star
45

Streaming-Demos

Demos of Plotly's Real-time Streaming API
Jupyter Notebook
149
star
46

dash-labs

Work-in-progress technical previews of potential future Dash features.
Python
139
star
47

dash-daq

Control components for Dash
JavaScript
137
star
48

dash-technical-charting

Powerful technical charting app/interface in pure Python
Python
133
star
49

dash-stock-tickers-demo-app

Dash Demo App - Stock Tickers
CSS
131
star
50

dash-vtk

Bringing vtk.js into Dash and Python
Python
120
star
51

dash-salesforce-crm

118
star
52

python-user-guide

MOVED!
115
star
53

dashboards.ly

Superseded by Dash!
HTML
107
star
54

dash-renderer

OBSOLETE has been merged into dash
JavaScript
97
star
55

Plotly.jl

A Julia interface to the plot.ly plotting library and cloud services
Julia
93
star
56

raspberrypi

Realtime Streaming with the Raspberry Pi and Plot.ly Python Library
Python
91
star
57

dash-deck

Bringing deck.gl and pydeck into Dash
JavaScript
90
star
58

dash-canvas

An interactive image editing component for Dash
Python
84
star
59

dash-image-processing

Dash Demo App - Image Processing App
Python
82
star
60

dash-volatility-surface

Volatility surface explorer in pure Python
Python
79
star
61

dash-player

Dash Component wrapping React-Player
Python
77
star
62

dash-world-cell-towers

A Dash app for exploring the world cell tower dataset provided by OpenCellid
Python
72
star
63

dash-auth

Basic Auth and Plotly Authentication for Dash Apps
Python
72
star
64

Dash.NET

F# interface to Dash- the most downloaded framework for building ML & data science web apps
F#
68
star
65

dash-alternative-viz

Dash components & demos to create Altair, Matplotlib, Highcharts , and Bokeh graphs within Dash apps.
JavaScript
67
star
66

dash-heroku-template

Fool-proof template for deploying Dash apps on Heroku
Python
64
star
67

simple-example-chart-apps

Some very simple apps to demonstrate the chart types on the Plotly website.
CSS
54
star
68

postMessage-API

Bind custom interactivity to embedded Plotly graphs
HTML
52
star
69

graphing-library-docs

Plotly's graphing libraries documentation.
Jupyter Notebook
52
star
70

rasterly

Rapidly generate raster images from large datasets in R with Plotly.js
R
48
star
71

dash-opioid-epidemic-demo

US county data for poision-induced deaths, years 1999-2015
HTML
48
star
72

dash-redis-celery-periodic-updates

Demo apps now maintained in https://github.com/plotly/dash-enterprise-docs
Python
48
star
73

dash-dangerously-set-inner-html

Dash component to dangerously set inner raw HTML
Python
45
star
74

dash-px

Simple Dash app using Plotly Express
Python
43
star
75

dash-sunburst

Dash / React + D3 tutorial: Sunburst diagrams
Python
43
star
76

dash-network

A tutorial & demo on how to port the D3 force-layout network diagram to Dash
JavaScript
43
star
77

academy

CSS
42
star
78

public-health

⚕ Tutorials for public health crossfilter dashboards
42
star
79

ruby-api

A Ruby wrapper to the plot.ly REST API.
Ruby
41
star
80

react-colorscales

A React UI component for picking and modifying colorscales
JavaScript
37
star
81

dash-yield-curve

Remake of the NYTimes yield curve demo
CSS
37
star
82

dash-app-stylesheets

Hosting Dash app stylesheets
CSS
36
star
83

plotly.github.io

Help pages for Chart Studio
CSS
35
star
84

dash-dbx-sql

Simple Dash app demonstrating connection to Databricks via the Python SQL connector
Python
35
star
85

plotly-notebook-js

A package for using plotly in Tonicdev and Jupyter notebooks.
JavaScript
34
star
86

canvas-portal

Gallery of examples for dash-canvas
CSS
34
star
87

dash-brain-surface-viewer

Dash app for viewing brain surfaces saved as MNI files. Data from https://github.com/aces/brainbrowser
Python
33
star
88

dash-components-archetype

Deprecated. A Builder archetype for Dash component suites. See the new version here: https://github.com/plotly/dash-component-boilerplate
JavaScript
32
star
89

R-User-Guide

The Official User-Guide to Plotly's R API and ggplotly
31
star
90

plotly.js-crossfilter.js

A simple example showing Plotly.js and Crossfilter.js working together.
JavaScript
31
star
91

all-in-ai-demo-app

Dash application presented by Nathan Drezner at the All in AI (https://allinevent.ai/) conference in Montreal on September 27, 2023
Python
31
star
92

plotly-webpack

Example repo for bundling plotly.js with webpack and browserify
JavaScript
30
star
93

spotfire

Create D3.js visualizations in spotfire with Plotly
29
star
94

dash-alternative-viz-demo

Components for using Dash with Matplotlib, Seaborn, Bokeh, Holoviews, and Altair.
Python
28
star
95

dashdub

Convert speech to text with Dash & Python
Jupyter Notebook
28
star
96

plotcon-2017-plotlyjs-workshop

Syllabus and materials for plotly.js workshop at PLOTCON 2017
28
star
97

workshop

Plotly API Hardware Use Cases
Arduino
27
star
98

react-ipython-notebook

React component for nbconvert.js
JavaScript
27
star
99

excel-plugin

Plotly Excel Plugin
C#
26
star
100

dash-datashader

A demo app for visualizing hundreds of millions of data points interactively with Dash and Datashader.
Python
25
star