Installation

Docker (Preferred)

The simplest way to install Jupiter is via Docker.

You first need to make sure you have a recent Docker installed. After that it's straightforward:

$ docker pull horia141/jupiter:latest

This will get you the latest version of the code. After this you can:

$ mkdir my-jupiter-work-dir # A dir where you manage local Jupiter data.
$ cd my-jupiter-work-dir
$ docker run \
    -it --rm --name jupiter-app -v $(pwd):/data \
    horia141/jupiter:latest --help

GitHub

Another way to install it is from "sources" on GitHub.

You need to make sure you have a recent Python3 installed. Jupiter has been tested on Python 3.8. Docker is also useful to have on board.

From GitHub you can just clone the repository like so:

$ git clone git@github.com:horia141/jupiter.git jupiter

This will get you the master version of the code.

After this, you can build a Docker image with Jupiter like so:

$ cd jupiter
$ make docker-build

This will chug for a while and produce a local image called jupiter. You can use this to run commands like so:

$ mkdir my-jupiter-work-dir # A dir where you manage local Jupiter data.
$ cd my-jupiter-work-dir
$ docker run \
    -it --rm --name jupiter-app -v $(pwd):/data \
    horia141/jupiter:latest --help

Alternatively, you can use the scripts locally, like so:

$ cd jupiter
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements.txt

Now, instead of running the Docker image, you can directly run the scripts, like so:

$ cd ~/my-jupier-work-dir
$ python ~/jupiter/src/jupiter.py --help