| Name | smos JSON |
| Version |
0.3.2
JSON |
| download |
| home_page | https://github.com/TUW-GEO/smos |
| Summary | SMOS (Soil Moisture and Ocean Salinity) image data readers and TS converter |
| upload_time | 2025-02-05 17:13:08 |
| maintainer | None |
| docs_url | None |
| author | TU Wien |
| requires_python | None |
| license | mit |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
====
SMOS
====
|ci| |cov| |pip| |doc| |doi|
.. |ci| image:: https://github.com/TUW-GEO/smos/actions/workflows/build.yml/badge.svg?branch=master
:target: https://github.com/TUW-GEO/smos/actions
.. |cov| image:: https://coveralls.io/repos/github/TUW-GEO/smos/badge.svg?branch=master
:target: https://coveralls.io/github/TUW-GEO/smos?branch=master
.. |pip| image:: https://badge.fury.io/py/smos.svg
:target: http://badge.fury.io/py/smos
.. |doc| image:: https://readthedocs.org/projects/smos/badge/?version=latest
:target: http://smos.readthedocs.org/
.. |doi| image:: https://zenodo.org/badge/167011732.svg
:target: https://zenodo.org/badge/latestdoi/167011732
SMOS (Soil Moisture and Ocean Salinity) data readers and time series conversion tools.
Works great in combination with `pytesmo <https://github.com/TUW-GEO/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 <http://conda.pydata.org/miniconda.html>`_ dependencies:
.. code::
$ conda create -n smos python=3.12
$ conda env update -f environment.yml -n smos
Then
.. code::
$ 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``.
.. code::
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:
.. code::
pytest
to run the test suite.
Supported Products
==================
Currently the following products are supported, additional products can be
added.
- `SMOS IC <https://www.catds.fr/Products/Available-products-from-CEC-SM/SMOS-IC>`_: SMOS INRA-CESBIO (SMOS-IC) 25 km
- `SMOS L4 RZSM <https://www.catds.fr/Products/Available-products-from-CEC-SM/L4-Land-research-products>`_: SMOS CATDS-CESBIO (SMOS L4 RZSM) 25 km
- `SMOS L2 Science Product <https://earth.esa.int/eogateway/catalog/smos-science-products>`_: 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)
.. code::
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
Raw data
{
"_id": null,
"home_page": "https://github.com/TUW-GEO/smos",
"name": "smos",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "TU Wien",
"author_email": "remote.sensing@geo.tuwien.ac.at",
"download_url": "https://files.pythonhosted.org/packages/a9/d1/c7f2cc80d11f5a93e678c9357e5ae2a14ff2075b300a0b4fb87e2b89f363/smos-0.3.2.tar.gz",
"platform": "any",
"description": "====\r\nSMOS\r\n====\r\n\r\n|ci| |cov| |pip| |doc| |doi|\r\n\r\n.. |ci| image:: https://github.com/TUW-GEO/smos/actions/workflows/build.yml/badge.svg?branch=master\r\n :target: https://github.com/TUW-GEO/smos/actions\r\n\r\n.. |cov| image:: https://coveralls.io/repos/github/TUW-GEO/smos/badge.svg?branch=master\r\n :target: https://coveralls.io/github/TUW-GEO/smos?branch=master\r\n\r\n.. |pip| image:: https://badge.fury.io/py/smos.svg\r\n :target: http://badge.fury.io/py/smos\r\n\r\n.. |doc| image:: https://readthedocs.org/projects/smos/badge/?version=latest\r\n :target: http://smos.readthedocs.org/\r\n\r\n.. |doi| image:: https://zenodo.org/badge/167011732.svg\r\n :target: https://zenodo.org/badge/latestdoi/167011732\r\n\r\n\r\nSMOS (Soil Moisture and Ocean Salinity) data readers and time series conversion tools.\r\n\r\nWorks great in combination with `pytesmo <https://github.com/TUW-GEO/pytesmo>`_.\r\n\r\n\r\nDocumentation & Software Citation\r\n=================================\r\nTo see the latest full documentation click on the docs badge at the top.\r\nTo cite this package follow the Zenodo badge at the top and export the citation there.\r\n\r\nInstallation\r\n============\r\n\r\nBefore installing this package via pip, please install the necessary\r\n`conda <http://conda.pydata.org/miniconda.html>`_ dependencies:\r\n\r\n.. code::\r\n\r\n $ conda create -n smos python=3.12\r\n $ conda env update -f environment.yml -n smos\r\n\r\n\r\nThen\r\n\r\n.. code::\r\n\r\n $ pip install smos\r\n\r\nshould work.\r\n\r\nExample installation script\r\n---------------------------\r\n\r\nThe following script will install miniconda and setup the environment on a UNIX\r\nlike system. Miniconda will be installed into ``$HOME/miniconda``.\r\n\r\n.. code::\r\n\r\n wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh\r\n bash miniconda.sh -b -p $HOME/miniconda\r\n export PATH=\"$HOME/miniconda/bin:$PATH\"\r\n git clone git@github.com:TUW-GEO/smos.git smos\r\n cd smos\r\n conda env create -f environment.yml\r\n source activate smos\r\n\r\nThis script adds ``$HOME/miniconda/bin`` temporarily to the ``PATH`` to do this\r\npermanently add ``export PATH=\"$HOME/miniconda/bin:$PATH\"`` to your ``.bashrc``\r\nor ``.zshrc``\r\n\r\nThe second to last line in the example activates the ``smos`` environment.\r\n\r\nAfter that you should be able to run:\r\n\r\n.. code::\r\n\r\n pytest\r\n\r\nto run the test suite.\r\n\r\n\r\nSupported Products\r\n==================\r\n\r\nCurrently the following products are supported, additional products can be\r\nadded.\r\n\r\n- `SMOS IC <https://www.catds.fr/Products/Available-products-from-CEC-SM/SMOS-IC>`_: SMOS INRA-CESBIO (SMOS-IC) 25 km\r\n- `SMOS L4 RZSM <https://www.catds.fr/Products/Available-products-from-CEC-SM/L4-Land-research-products>`_: SMOS CATDS-CESBIO (SMOS L4 RZSM) 25 km\r\n- `SMOS L2 Science Product <https://earth.esa.int/eogateway/catalog/smos-science-products>`_: SMOS L2 Science Products (MIR_SMUDP2) 25 km\r\n- SMOS L3\r\n\r\nBuild Docker image\r\n==================\r\n- Check out the repo at the branch/tag/commit you want bake into the image\r\n- Make sure you have docker installed and run the command (replace the tag `latest`\r\n with something more meaningful, e.g. a version number)\r\n\r\n.. code::\r\n\r\n docker build -t smos:latest . 2>&1 | tee docker_build.log\r\n\r\nThis will execute the commands from the Dockerfile. I.e. install a new environment\r\nfrom the environment.yml file and install the checked out version of the smos\r\npackage.\r\n\r\nTo build and publish the image online, we have a GitHub Actions workflow in\r\n``.github/workflows/docker.yml``\r\n\r\nContribute\r\n==========\r\n\r\nWe are happy if you want to contribute. Please raise an issue explaining what\r\nis missing or if you find a bug. We will also gladly accept pull requests\r\nagainst our master branch for new features or bug fixes.\r\n\r\n\r\nGuidelines\r\n----------\r\n\r\nIf you want to contribute please follow these steps:\r\n\r\n- Fork the smos repository to your account\r\n- make a new feature branch from the smos master branch\r\n- Add your feature\r\n- please include tests for your contributions in one of the test directories\r\n We use py.test so a simple function called test_my_feature is enough\r\n- submit a pull request to our master branch\r\n",
"bugtrack_url": null,
"license": "mit",
"summary": "SMOS (Soil Moisture and Ocean Salinity) image data readers and TS converter",
"version": "0.3.2",
"project_urls": {
"Documentation": "https://smos.readthedocs.io/en/latest/",
"Homepage": "https://github.com/TUW-GEO/smos"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5fcd7599430e602459bbe0eaefbd456a838844c7dd6927f7fb35cbf4f0f0ed94",
"md5": "d3768ebd6833e26d881f3d1e68f1783d",
"sha256": "0bd30ae932f0f8efab55c87a3849d34061b88a72efef93e97e937d1d8e454a83"
},
"downloads": -1,
"filename": "smos-0.3.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3768ebd6833e26d881f3d1e68f1783d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 34089,
"upload_time": "2025-02-05T17:13:06",
"upload_time_iso_8601": "2025-02-05T17:13:06.860175Z",
"url": "https://files.pythonhosted.org/packages/5f/cd/7599430e602459bbe0eaefbd456a838844c7dd6927f7fb35cbf4f0f0ed94/smos-0.3.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a9d1c7f2cc80d11f5a93e678c9357e5ae2a14ff2075b300a0b4fb87e2b89f363",
"md5": "d3142afea57481e34177331e282b26b1",
"sha256": "ba7cc315b50bb4bcf7a3ef3a1cbd42cb9f99188df4832464c77cce4036c008d3"
},
"downloads": -1,
"filename": "smos-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "d3142afea57481e34177331e282b26b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 803705,
"upload_time": "2025-02-05T17:13:08",
"upload_time_iso_8601": "2025-02-05T17:13:08.813556Z",
"url": "https://files.pythonhosted.org/packages/a9/d1/c7f2cc80d11f5a93e678c9357e5ae2a14ff2075b300a0b4fb87e2b89f363/smos-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-05 17:13:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TUW-GEO",
"github_project": "smos",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "smos"
}
