almond-sh / examples

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

Almond Examples

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

Run interactively in Deepnote

You can also try Almond very quickly by cloning this Deepnote project with Almond kernel and examples. Deepnote offers hosted notebooks with real-time collaboration capabilities for free.

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!

examples's Issues

objects extending app are not executed in the REPL

Objects extending app are not executed in the REPL

example:
in variances.ipynb

object CovarianceTest extends App { ...

->
defined object CovarianceTest

but nothing happens!

but adding:
CovarianceTest.main(Array.empty)

->
Whiskers
Tom
Fido
Rex

defined object CovarianceTest

Add a Spark example

It would be great to have a Spark example based on https://github.com/alexarchambault/ammonite-spark.

• Create the example notebook
• Investigate how to run a minimal standalone Spark cluster in binder running in local mode works

Consider adding ReviewNB for better notebook diffs

ReviewNB is a GitHub app that gives you nice notebook diffs like nbdime but integrated in PRs and with review support.

Because we're dealing mostly with notebooks in this repo I think adding it might helpful.

Add TOC/Index Notebook

A table of contents notebook containing links to the other examples will give a better overview of what's available.

We could also link directly to it in nbviewer and as the starting notebook in binder.

Possible example of how to import code from other notebook

Hello,
Thank you very much for your work, enthusiasm and effort! Could you please add an example, how it is possible to import an object from another Jupyter Notebook? If it is possible at all. I tried:
from OtherNotebook import MyObject._
But from is not a valid keyword, and I can't find any other possible keyword, that can do this trick.
Thanks a lot in advance!
Lori

Provide docker images with examples

To make it easier to run the examples locally, we should provide docker images with them.

I guess we could extend the update-docker-images.sh from the main repo. We should provide kernels for 2.11 and 2.12 in one image though, which might be useful anyway.

Possible examples

Opening this issue to list possible example sources, that it might be interesting to adapt here.