Installation

Setting up a user environment

As a osmox 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 osmox mamba environment: mamba create -n osmox -c conda-forge -c city-modelling-lab osmox
4. Activate the osmox mamba environment: mamba 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 .

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: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.