c3s_sm

ci cov pip doc

Processing tools and tutorials for users of the C3S satellite soil moisture service ( https://doi.org/10.24381/cds.d7782f18 ). Written in Python.

Installation

The c3s_sm package and all required dependencies can be installed via

pip install c3s_sm

On macOS if you get ImportError: Pykdtree failed to import its C extension, then it might be necessary to install the pykdtree package from conda-forge

conda install -c conda-forge pykdtree

Tutorials

We provide tutorials on using the C3S Soil Moisture data:

These tutorials are designed to run on mybinder.org You can find the code for all examples in this repository.

Supported Products

At the moment this package supports C3S soil moisture data in netCDF format (reading and time series creation) with a spatial sampling of 0.25 degrees.

Build Docker image

  • Check out the repo at the branch/tag/commit you want build

  • Make sure you have docker installed and run the command (replace the tag latest with something more meaningful, e.g. a matching version number)

docker build -t c3s_sm:latest . 2>&1 | tee docker_build.log

This will execute the commands from the Dockerfile. I.e. install a new environment with the checked out version of the c3s_sm package.

To build and publish the image online, we have a GitHub Actions workflow in .github/workflows/docker.yml

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.

Guidelines

If you want to contribute please follow these steps:

  • Fork the c3s_sm 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 c3s_sm master branch

  • Add your feature

  • Please include tests for your contributions in one of the test directories.

  • submit a pull request to our master branch

Indices and tables