s-scherrer / nc-image-reader

Easily create reader classes for netcdf images.

gswp

Readers and converters for data from the Global Soil Wetness Program.

Works great in combination with pytesmo.

Currently still work in progress.

Citation

TODO

Installation

Setup of a complete environment with conda can be performed using the following commands:

conda create -n gswp python=3.6 # or any other supported python version
source activate gswp

# use the provided environment file to install all dependencies
conda env update -f environment.yml -n gswp

Contribute

We are happy if you want to contribute. Please raise an issue explaining what is missing or if you find a bug. We will also gladly accept pull requests against our master branch for new features or bug fixes.

Development setup

For Development we also recommend a conda environment. You can create one including test dependencies and debugger by running conda env create -f environment.yml. This will create a new gswp environment which you can activate by using source activate gswp.

Guidelines

If you want to contribute please follow these steps:

• Fork the gswp repository to your account
• Clone the repository, make sure you use git clone --recursive to also get the test data repository.
• make a new feature branch from the gswp master branch
• Add your feature
• Please include tests for your contributions in one of the test directories. We use py.test so a simple function called test_my_feature is enough
• submit a pull request to our master branch

Note

This project has been set up using PyScaffold 3.2.3. For details and usage information on PyScaffold see https://pyscaffold.org/.