Did you know that you can try OGGM in your browser before installing it on your computer? Visit Try OGGM online for more information.
OGGM itself is a pure Python package, but it has several dependencies which are not trivial to install. The instructions below provide all the required detail and should work on any platform. See Installation troubleshooting if something goes wrong.
OGGM is fully tested with Python version 3.6 and 3.7 on Linux. OGGM doesn’t work with Python 2. We do not test OGGM on Mac OS, but it should probably run fine.
OGGM usually does not work on Windows. If you are using Windows 10, we strongly recommend to install the free Windows subsytem for Linux and install and run OGGM from there.
Complete beginners should get familiar with Python and its packaging ecosystem before trying to install and run OGGM.
For most users we recommend following the steps here to install Python and the package dependencies with the conda package manager. Linux or Debian users and people with experience with pip can follow the specific instructions here to install with virtualenv.
Here is a list of all dependencies of the OGGM model. If you want to use the numerical models and nothing else, refer to Install a minimal OGGM environment below.
- Standard SciPy stack:
- Configuration file parsing tool:
- GIS tools:
- pytest-mpl (OGGM fork required)
- Other libraries:
- progressbar2 (displays the download progress)
- bottleneck (speeds up xarray operations)
- python-colorspace (applies HCL-based color palettes to some graphics)
Install with conda (all platforms)¶
This is the recommended way to install OGGM.
You should have a recent version of the conda package manager. You can get conda by installing miniconda (the package manager alone - recommended) or anaconda (the full suite - with many packages you won’t need).
We recommend to create a specific environment for OGGM. In a terminal window, type:
conda create --name oggm_env python=3.X
3.X is the Python version shipped with conda (currently 3.6).
You can of course use any other name for your environment.
Don’t forget to activate it before going on:
source activate oggm_env
Install all OGGM dependencies from the
oggm conda channels:
conda install -c oggm -c conda-forge oggm-deps
oggm-deps package is a “meta package”. It does not contain any code but
will install all the packages OGGM needs automatically.
The conda-forge channel ensures that the complex package dependencies are handled correctly. Subsequent installations or upgrades from the default conda channel might brake the chain. We strongly recommend to always use the the conda-forge channel for your installation.
You might consider setting conda-forge (and
oggm) as your
conda config --add channels conda-forge conda config --add channels oggm
conda install -c conda-forge ipython jupyter
Install OGGM itself¶
First, choose which version of OGGM you would like to install:
- stable: this is the latest version officially released and has a fixed version number (e.g. v1.1).
- dev: this is the development version. It might contain new features and bug fixes, but is also likely to continue to change until a new release is made. This is the recommended way if you want to use the latest changes to the code.
- dev+code: this is the recommended way if you plan to explore the OGGM codebase, contribute to the model, and/or if you want to use the most recent model updates.
‣ install the stable version:
If you are using conda, you can install stable OGGM as a normal conda package:
conda install -c oggm oggm
If you are using pip, you can install OGGM from PyPI:
pip install oggm
‣ install the dev version:
For this to work you’ll need to have the git software installed on your system. In your conda environmnent, simply do:
pip install --upgrade git+https://github.com/OGGM/oggm.git
With this command you can also update an already installed OGGM version to the latest version.
‣ install the dev version + get access to the OGGM code:
For this to work you’ll need to have the git software installed on your system. Then, clone the latest repository version:
git clone https://github.com/OGGM/oggm.git
Then go to the project root directory:
And install OGGM in development mode (this is valid for both pip and conda environments):
pip install -e .
Installing OGGM in development mode means that subsequent changes to this
code repository will be taken into account the next time you will
import oggm. You can also update OGGM with a simple git pull from
the root of the cloned repository.
You can test your OGGM installation by running the following command from anywhere (don’t forget to activate your environment first):
pytest --pyargs oggm
The tests can run for a couple of minutes. If everything worked fine, you should see something like:
=============================== test session starts =============================== platform linux -- Python 3.5.2, pytest-3.3.1, py-1.5.2, pluggy-0.6.0 Matplotlib: 2.1.1 Freetype: 2.6.1 rootdir: plugins: mpl-0.9 collected 164 items oggm/tests/test_benchmarks.py ... [ 1%] oggm/tests/test_graphics.py ................... [ 13%] oggm/tests/test_models.py ................sss.ss.....sssssss [ 34%] oggm/tests/test_numerics.py .ssssssssssssssss [ 44%] oggm/tests/test_prepro.py .......s........................s..s....... [ 70%] oggm/tests/test_utils.py .....................sss.s.sss.sssss..ss. [ 95%] oggm/tests/test_workflow.py sssssss [100%] ==================== 112 passed, 52 skipped in 187.35 seconds =====================
You can safely ignore deprecation warnings and other messages (if any), as long as the tests end without errors.
This runs a minimal suite of tests. If you want to run the entire test suite (including graphics and slow running tests), type:
pytest --pyargs oggm --run-slow --mpl
Congrats, you are now set-up for the Getting started section!
We try to do our best to avoid issues, but experience shows that the installation of the necessary packages can be difficult. Typical errors are often related to the pyproj, fiona and GDAL packages, which are heavy and (for pyproj) have changed a lot in the recent past and are prone to platform specific errors.
If the tests don’t pass, a diagnostic of which package creates the errors
might be necessary. Errors like
segmentation fault or
are frequent and point to errors in upstream packages, rarely in OGGM itself.
If you are having troubles, installing the packages manually from a fresh environment might help. At the time of writing (13.06.2020), creating an environment from this environment.yml file used to work (see the conda docs for more information about how to create an environment from a yml file):
name: oggm_env channels: - conda-forge dependencies: - python=3.7 - jupyter - jupyterlab - numpy=1.16.5 - scipy=1.4.1 - pandas - shapely - matplotlib - Pillow - netcdf4=1.5.3 - scikit-image - scikit-learn - configobj - xarray - pytables - pytest - dask - bottleneck - pyproj=2.2.2 - cartopy=0.17.0 - geopandas=0.7.0 - rasterio=1.1.2 - descartes - seaborn - pip - pip: - joblib - progressbar2 - motionless - git+https://github.com/fmaussion/salem.git - git+https://github.com/OGGM/oggm.git - git+https://github.com/OGGM/pytest-mpl
Install with virtualenv (Linux/Debian)¶
We used to recommend our users to use conda instead of pip, because of the ease of installation with conda. As of August 2019, a pip installation is also possible without major issue on Debian.
The instructions below have been tested on Debian / Ubuntu / Mint systems only!
Run the following commands to install required packages. We are not sure this is strictly necessary, but you never know.
For the build:
$ sudo apt-get install build-essential python3-pip
For NetCDF and HDF:
$ sudo apt-get install netcdf-bin ncview hdf5-tools libhdf5-dev
Be sure to be on the working environment:
$ workon oggm_env
Update pip (important!):
$ pip install --upgrade pip
Install some packages one by one:
$ pip install numpy scipy pandas shapely matplotlib pyproj \ rasterio Pillow geopandas netcdf4==1.3.1 scikit-image configobj joblib \ xarray progressbar2 pytest motionless dask bottleneck toolz descartes \ tables
The pinning of the NetCDF4 package was necessary for us, but your system might differ (related issue).
Finally, install the pytest-mpl OGGM fork, salem and python-colorspace libraries:
$ pip install git+https://github.com/OGGM/pytest-mpl.git $ pip install git+https://github.com/fmaussion/salem.git $ pip install git+https://github.com/retostauffer/python-colorspace.git
Install a minimal OGGM environment¶
If you plan to use only the numerical core of OGGM (that is, for idealized simulations or teaching), you can skip many dependencies and only install this shorter list:
Installing them with pip or conda should be much easier.
Running the tests in this minimal environment works the same. Simply run from a terminal:
pytest --pyargs oggm
The number of tests will be much smaller!