smos 0.4

Documentation & Software Citation

To see the latest full documentation click on the docs badge at the top. To cite this package follow the Zenodo badge at the top and export the citation there.

Installation

Before installing this package via pip, please install the necessary conda dependencies:

$ conda create -n smos python=3.12
$ conda env update -f environment.yml -n smos

Then

$ pip install smos

should work.

wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
bash miniconda.sh -b -p $HOME/miniconda
export PATH="$HOME/miniconda/bin:$PATH"
git clone git@github.com:TUW-GEO/smos.git smos
cd smos
conda env create -f environment.yml
source activate smos

pytest

Supported Products

Currently the following products are supported, additional products can be added.

• SMOS IC: SMOS INRA-CESBIO (SMOS-IC) 25 km

• SMOS L4 RZSM: SMOS CATDS-CESBIO (SMOS L4 RZSM) 25 km

• SMOS L2 Science Product: SMOS L2 Science Products (MIR_SMUDP2) 25 km

• SMOS L3

Build Docker image

• Check out the repo at the branch/tag/commit you want bake into the image

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

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

This will execute the commands from the Dockerfile. I.e. install a new environment from the environment.yml file and install the checked out version of the smos 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.