Running on the cloud

Docker

Docker is a program for running containers, and is one of the easiest ways to run Brightway2 on server computers. The Brightway2 Docker file is based on the Jupyter minimal-notebook Docker file, and let’s you run a notebook server or ipython shell.

To run the Brightway2 Docker file:

  1. Install Docker
  2. Run the Docker file:
docker run -d -p 8888:8888 jupyter/minimal-notebook

This will start a detached container (-d) with port 8888 on your machine forwarded to port 8888 in the container, where the notebook server is listening.

You can start an ipython shell with:

docker run -i -t --entrypoint ipython cmutel/brightway2

This creates an container with STDIN open (-i) and a TTY shell (-t). Instead of running the start-notebook.sh shell, this uses a different entrypoint. Similarly, you can start a bash shell:

docker run -i -t --entrypoint bash cmutel/brightway2

Using data volumes

Brightway2 can’t do much without data. The default data directory in the Docker container is /home/jovyan/data/. You can use an existing data directory by mounting a data volume, e.g.:

docker run -i -t -v "/Users/cmutel/Library/Application Support/Brightway3":/home/jovyan/data --entrypoint ipython cmutel/brightway2

You may also want to mount the following:

  • /home/jovyan/notebooks - The directory the notebook server starts in.
  • /home/jovyan/output - The output directory for most Brightway2 IO functions.

Securing the notebook server

See the jupyter minimal-notebook docs for information on notebook commands, including using HTTPS.

Cloud Nine

Contributed by Manuel Klarmann - see complete list of authors and guide to contributing.

You can try out Brightway2 without installing anything on your computer using the cloud service cloud 9. Sign up and verify your account, and then do the following:

  1. Create a new workspace:
_images/c9-1.png
  1. Fill out the name and description, and then create your workspace:
_images/c9-2.png
  1. In the blue terminal at the bottom of the screen (see screenshot), paste the following command:
wget https://bitbucket.org/cmutel/brightway2/raw/default/cloud-nine-install.sh && bash cloud-nine-install.sh
_images/c9-3.png
  1. Click on Preview > Preview Running Application to see the introductory Brightway2 notebook. You can also copy/paste the URL into a new tab.
_images/c9-4.png