Skip to content

Latest commit

 

History

History
130 lines (85 loc) · 3.93 KB

README.rst

File metadata and controls

130 lines (85 loc) · 3.93 KB
Raw

SMOS

ci cov pip doc doi

SMOS (Soil Moisture and Ocean Salinity) data readers and time series conversion tools.

Works great in combination with pytesmo.

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.

Example installation script

The following script will install miniconda and setup the environment on a UNIX like system. Miniconda will be installed into $HOME/miniconda.

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

This script adds $HOME/miniconda/bin temporarily to the PATH to do this permanently add export PATH="$HOME/miniconda/bin:$PATH" to your .bashrc or .zshrc

The second to last line in the example activates the smos environment.

After that you should be able to run:

pytest

to run the test suite.

Supported Products

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

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.

Guidelines

If you want to contribute please follow these steps:

  • Fork the smos repository to your account
  • make a new feature branch from the smos 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