Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 2.16 KB

README.md

File metadata and controls

63 lines (40 loc) · 2.16 KB

colomoto-docker

Quick usage guide

You need Docker. First fetch the image with

$ docker pull colomoto/colomoto-docker:TAG

where TAG is the version of the image, among colomoto/colomoto-docker tags. It can be omited when using latest version.

The image can be ran using

$ docker run -it --rm -p 8888:8888 colomoto/colomoto-docker:TAG

then, open your browser and go to http://localhost:8888 for the Jupyter notebook web interface (note: when using Docker Toolbox, replace localhost with the result of docker-machine ip default command).

Alternatively, you can use the script colomoto-docker.py to ease docker invocation:

$ wget -O colomoto-docker.py https://raw.githubusercontent.com/colomoto/colomoto-docker/colomoto-docker.py
$ python colomoto-docker -V TAG

If TAG is latest, it will automatically fetch the latest available tag. See python colomoto-docker -h for usage.

Embedded softwares

Besides the Jupyter notebook, the docker image provides access to the following softwares:

Tagging policy and re-executability considerations

Docker images are timestamped with tags of the form YYYY-MM-DD after each tool addition or upgrade.

In order to guarantee the re-executability of your notebook, we recommend to use these tagged images instead of the non-persistent latest tag. This can be achieved using the colomoto-docker.py script to launch the docker image:

python colomoto-docker.py -V latest

will fetch and run the most recent timestamped docker image (requires internet connectivity).

If you want to run an image with a given timestamp <TIMESTAMP>, use

python colomoto-docker.py -V <TIMESTAMP>

Contribute

Coming soon: instruction to add/update your software