Skip to content

Installation#

Setting up a user environment#

As a runn user, it is easiest to install using the mamba package manager, as follows:

  1. Install mamba with the Mambaforge executable for your operating system.

  2. Open the command line (or the "miniforge prompt" in Windows).

  3. Create the runn mamba environment: mamba create -n runn -c conda-forge -c JoseAngelMartinB runn

  4. Activate the runn mamba environment: mamba activate runn

All together:

mamba create -n runn -c conda-forge -c JoseAngelMartinB runn

Running the example notebooks#

If you have followed the non-developer installation instructions above, you will need to install jupyter into your runn environment to run the example notebooks:

mamba install -n runn jupyter

With Jupyter installed, it's easiest to then add the environment as a jupyter kernel:

mamba activate runn
ipython kernel install --user --name=runn
jupyter notebook

Choosing a different environment name#

If you would like to use a different name to runn for your mamba environment, the installation becomes (where [my-env-name] is your preferred name for the environment):

mamba create -n [my-env-name] -c conda-forge --file requirements/base.txt
mamba activate [my-env-name]
ipython kernel install --user --name=[my-env-name]

Setting up a development environment#

The install instructions are slightly different to create a development environment compared to a user environment:

git clone git@github.com:JoseAngelMartinB/runn.git
cd runn
mamba create -n runn -c conda-forge --file requirements/base.txt --file requirements/dev.txt
mamba activate runn
pip install --no-deps -e .
python -m ipykernel install --user --name runn

For more detailed installation instructions specific to developing the runn codebase, see our development documentation.