/examples

A collection of Jupyter notebooks showing what you can do with the Almond Scala kernel.

Primary LanguageJupyter NotebookApache License 2.0Apache-2.0

Almond Examples Binder nbviewer

A collection of Jupyter notebooks showing what you can do with the Almond Scala kernel.

Run interactively on Binder

The easiest way to get started is to run the examples on Binder. All your need is a browser!

Binder is an amazing service that allows you to create an executable environment out of a Git repository containing Jupyter notebooks. That way, you can play with the examples and try new things without having to install anything locally.

See Notebook Output in nbviewer

You can view the notebooks directly on GitHub, as it has a basic renderer for Jupyter notebooks. It doesn't execute any JavaScript though, which severly limits its ability to show dynamically generated plots i.e. from plotly and vegas.

A much better option is to render them through nbviewer. nbviewer supports loading notebooks directly from a repo on GitHub.

List of all notebooks in this project in nbviewer

Running locally

An even better way to learn about Jupyter and Almond is to run it locally so you can try things out for yourself.

Via docker

We provide a docker image for the current almond version, based on the latest almond docker image. Run it with

docker run -it --rm -p 8888:8888 almondsh/examples:latest

Then copy the URL shown in the Docker output into your browser. To use JupyterLab instead of the classic Notebook interface, replace tree with lab after opening the URL.

Locally on your machine

To run these notebooks locally:

  1. Install Jupyter Notebook or JupyterLab
  2. Install an Almond kernel
  3. Clone the project and run jupyter notebook or jupyter lab in the project directory
  4. Open one of the example notebooks and play with it!