An example repository for external OGGM packages

This repository shows how you can develop an external package for OGGM and keep control over it without having to put your code on the main OGGM repository.

Why would I want to do that?

Ideally, we would have your package added to the main codebase: this ensures consistency of the code and continuous testing. However, there are several reasons why making your own repository could be useful:

  • complying to OGGM’s strict testing rules can be annoying, especially in the early stages of development of a model
  • with you own repository you have full control on it’s development while still being able to use the OGGM workflow and multiprocessing capabilities
  • with an external package the users who will use your model will have to download it from your repository and you can make sure that correct attribution is made to your work, i.e. by specifying that using this package requires a reference to a specific scientific publication
  • if your funding agency requires you to have your own public website
  • etc.

Before writing your own package we recommend to contact us to discuss the best path to follow in your specific case.

How does this package work?

This package is a template. It implements two very simple use cases:

Installation, usage

You can install this custom package with:

pip install git+https://github.com/OGGM/oggmcontrib.git

However, what you’d probably like to do is to fork this repository and use it as a template for your own project.

Once available locally, you can install it in development mode with:

pip install -e .

Get in touch