install.md

Installation

MacOS Dmg

For MacOS, a simple way of installing Jupiter is via a dmg archive published together with a release. You can check them in the release page.

You can then download and install it into your Applications folder just like any app:

Invoking this is a bit tricky now:

$ mkdir my-jupiter-work-dir # A dir where you manage local Jupiter data.
$ cd my-jupiter-work-dir
$ /Applications/Jupiter.app/Contents/MacOS/jupiter init --help

You can of course add an alias to your shell about it.

Docker

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 init --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 init --help

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

$ cd jupiter
$ poetry shell
$ ./scripts/setup-for-dev.sh # Hopefully this is simple!

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