A modular open source glacier model in Python¶
OGGM is an open source modelling framework able to simulate past and future mass-balance, volume and geometry of (almost) any glacier in the world, in a fully automated and extensible workflow.
The model accounts for glacier geometry (including contributory branches) and includes an explicit ice dynamics module. We rely exclusively on publicly available data for calibration and validation. OGGM is modular and supports novel modelling workflows: it LOVES to be remixed and reused!
This webpage is for the software documentation: for general information about the OGGM project and related news, visit oggm.org.
Warning
This is the model documentation for users and developers as of version 1.5.1. For the documentation of the latest (cutting-edge) repository version, visit docs.oggm.org/en/latest.
IARPC presentation (April 2020)¶
If you are new to OGGM would like a short introduction, here is a recent 15’ presentation about the project:
Slides available here
Principles¶
Physical principles implemented in the model and their underlying assumptions. For more detailed information, we recommend to read the OGGM description paper.
Using OGGM¶
How to use the model, with concrete code examples and links to the tutorials.
- Try OGGM online
- Installing OGGM
- Getting started
- OGGM Shop
- Tutorials
- Performance, cluster environments and reproducibility
- API Reference
- FAQ and Troubleshooting
- Pitfalls and limitations
- Assets and downloads
- OGGM-Hub
- Version history
Contributing¶
Do you want to contribute to the model? You are more than welcome to do so and this is the right place to start.
- Citing OGGM
- Adding an external module to OGGM
- OGGM Enhancement Proposals (OEPs)
- Contributing to OGGM
Get in touch¶
- View the source code on GitHub.
- Report bugs or share your ideas on the issue tracker, and improve the model by submitting a pull request.
- Chat with us on Slack! (just send us an e-mail so we can add you)
- Follow us on Twitter.
- Participate to our regular meeting. (reach out if you want to join in)
- Or you can always send us an e-mail the good old way.
License and citation¶
OGGM is available under the open source 3-Clause BSD License.
OGGM is a free software. This implies that you are free to use the model and copy, modify or redistribute its code at your wish, under certain conditions:
- When using this software, please acknowledge the original authors of this contribution by using our logo, referring to our website or using an appropriate citation. See Citing OGGM for how to do that.
- Redistributions of any substantial portion of the OGGM source code must meet the conditions listed in the OGGM license
- Neither OGGM e.V. nor the names of OGGM contributors may be used to endorse or promote products derived from this software without specific prior written permission. This does not mean that you need our written permission to work with OGGM or publish results based on OGGM: it simply means that the OGGM developers are not accountable for what you do with the tool (more info).
See the OGGM license for more information.
About¶
Version: | |
---|---|
Citation: | |
Tests: | |
License: | |
Authors: | See the version history for a list of all contributors. |