Getting started

Tony Hirst edited this page Jul 17, 2018 · 12 revisions

Tips for getting started with Stencila Desktop and Stencila packages for R, Python and Node.js.

Stencila Desktop

The Stencila Desktop is the main application that you'll use to read and write Stencila Documents. It's available as a binary executable for Windows, Mac, and Linux

Windows

Download the .exe file for the latest Stencila Desktop release then just double click on the .exe.

Mac

Download the .dmg file for the latest Stencila Desktop release then,

  • double click the .dmg to make its content available (name will show up in the Finder sidebar)
  • drag the application from the .dmg window into /Applications to install (may need an administrator password)
  • wait for the copy process to finish
  • eject the .dmg (by clicking the eject button in the Sidebar)

Thanks to patrix for these instructions.

Linux

Download the AppImage file for the latest Stencila Desktop release then,

  • double click on it and click yes to "Make executable and run".
  • or, at the command line,
$ chmod a+x stencila-desktop-*.AppImage
$ ./stencila-desktop-*.AppImage

AppImage is a format for distributing applications for Linux and, on most distributions, will not require the installation of any dependencies.

Stencila Docker images

If you have Docker installed our stencila/alpha Docker image is the easiest way to get started with execution contexts for Python, SQL, R and Node.js.

docker run -p 2100:2000 stencila/alpha

Stencila R Package

The R package provides an execution context for R. It isn't on CRAN yet, but you can install it using the devtools package from our Github repo,

devtools::install_github("stencila/r")

Then install the package's manifest so that it can be found by the Stencila Desktop and Stencila packages for other languages,

stencila:::register()

Stencila Python package

The Python package provides execution context's for Python and SQL. It isn't on PyPI yet, but you can install using pip from our Github repo:

pip install --user https://github.com/stencila/py/archive/master.zip

Then install the package's manifest so that it can be found by the Stencila Desktop and Stencila packages for other languages,

import stencila
stencila.register()

Stencila Node.js package

The Node.js package provides a Javascript (js) execution context. It is already bundled in Stencila Desktop so if you've already downloaded that you won't need to install it separately.

However, if you want to use Node.js within a Stencila document hosted in some other application you'll need to install this package. It's on NPM so just,

npm install stencila-node

Then install the package's manifest so that it can be found by the Stencila Desktop and Stencila packages for other languages,

node -e "require('stencila-node').install()"
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.