SMOS (Soil Moisture and Ocean Salinity) data readers and time series converter.
Works great in combination with pytesmo.
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. Be aware that this badge links to the latest package version. Additional information on DOI versioning can be found here: http://help.zenodo.org/#versioning
Before installing this package via pip, please install the necessary conda dependencies:
$ conda install -c conda-forge netcdf4 pyresample
Then
$ pip install smos
should work.
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.
Currently the following products are supported, additional products can be added.
- SMOS IC: SMOS INRA-CESBIO (SMOS-IC) 25km
- SMOS L4 RZSM: SMOS CATDS-CESBIO (SMOS L4 RZSM) 25km
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.
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