Installation

Installing a user environment

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

1. Install conda with the miniforge executable for your operating system. Arup users on Windows can install miniforge from the Arup software shop by downloading "VS Code for Python".
2. Open the command line (or the VSCode "integrated terminal" in Windows).
3. Create the osmox conda environment: conda create -n osmox -c conda-forge -c city-modelling-lab osmox
4. Activate the osmox conda environment: conda activate osmox

All together:

git clone git@github.com:arup-group/osmox.git
cd osmox
mamba create -n osmox -c conda-forge -c city-modelling-lab --file requirements/base.txt
mamba activate osmox
pip install --no-deps .

Tip

If you are an Arup user and are having difficulties with creating the conda environment, it may be due to SSL certificates. You'll know that this is the case because there will be mention of "SSL" in the error trace. Search SSL Certificates on the Arup internal Sharepoint to find instructions on adding the certificates for conda. Windows users who have installed "VS Code for Python" from the software shop should have all the relevant certificates in place, but you will need to follow the instructions given on the SharePoint troubleshooting page if you want to run the command from in a Windows Subsystem for Linux (WSL) session.

Installing a development environment

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

git clone git@github.com:arup-group/osmox.git
cd osmox
mamba create -n osmox -c conda-forge -c city-modelling-lab --file requirements/base.txt --file requirements/dev.txt
mamba activate osmox
pip install --no-deps -e .

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