| Name | smodex JSON |
| Version |
1.0.1b0
JSON |
| download |
| home_page | |
| Summary | A Python package for understanding the evolution of soil moisture and soil moisture anomalies |
| upload_time | 2023-10-30 08:31:08 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | [MIT No Attribution License](https://opensource.org/license/mit-0/) Copyright (c) 2023 Eurac Research Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
anomalies
soil moisture
climatology
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
SMODEX Package: A Python package for understanding the evolution of soil moisture anomalies.
===============================================================================================
<!-- []() -->
[](https://opensource.org/license/mit-0/)
[](link_to_test_coverage_report)
[](https://www.python.org/downloads/)
<!-- [](https://peps.python.org/pep-0008/) -->
[](https://github.com/psf/black)
[](readthedocs.io)
[](https://makeapullrequest.com)
SMODEX is a **package developed to enhance performant computation and understanding of the evolution of soil moisture and soil moisture anomalies using climate datasets.**
It embraces the principles of FAIR and Open Science in the development of the computational workflow and the data sharing.
Package Usage
=============
Soil moisture and soil moisture anomalies are critical markers of dryness and agricultural drought. The SMODEX package was designed to aid the performant of this metrics targeting the following categories of users:
1. **Researchers** working on the topics of soil moisture, drought and soil hydrology,
2. **Students** exploring tools for understanding the dynamics of soil moisture and soil hydrology,
3. **Open-source and Open-science scientists** looking for a wrapper to compute these specific anomalies
Installation
==================
The SMODEX package is compatible with Python 3.6+ and is distributed through the [_Python Package Index (PyPI)_](https://pypi.org/project/smodex/) and can installed via:
```bash
pip install smodex
```
Usage examples
===============
Currently, the main subpackages in SMODEX include:
- **downloader**: contains a request to the ERA5 Climate Datastore for downloading and saving soil water contents based on the specified timeline necessary for computing an anomaly,
- **climates**: contains functionalities for computing soil moisture climatology with a given reference, and rolling mean at a weekly rolling window, dekadal, monthly or annual scale,
- **anomaly**: contains functionalities for computing, saving soil moisture anomalies,
- **share**: contains functionalities for sharing computed datasets with other scientists using the STAC specification (coming soon),
- **plots**: contains different functionalities for visualizing the soil moisture and soil moisture anomalies across spatial and temporal dimensions (coming soon),
Downloader
----------
To use the downloader module, see our quick start example [here]("examples/download_example.ipynb")
Within a python script, this can serve as a quick guide:
```python
from smodex.downloader import cds_downloader
start_date = '2020-12-15'
end_date = '2021-01-03'
conf_path = 'download.json'
download_path = 'moisture_data/'
cds_downloader(start_date,
end_date,
conf_path,
download_path)
```
However, this requires the installation of the `ERA5 CDS API` as well as a specification of your API keys in a `.env` file following this examples:
Run:
```bash
pip install cdsapi
```
And set the following values to those of your CDS API keys
```yaml
# .env
CDSAPI_URL=https://cds.climate.copernicus.eu/api/v2
CDSAPI_KEY=XXXXXX:XXXXXX-XXXXXX-XXXX-XXXXX
```
Remember to change the CDSAPI_KEY to that of your personal or organization's account keys.
You can find more specific details on how to access your personal CDS API key [here](https://cds.climate.copernicus.eu/api-how-to)
Contributing
================
Currently, the SMODEX package is under development and we solicit the contribution of other developers to make a Merge/Pull Request using the development version on GitLab. You can clone the repository and install the pakcage using:
```bash
python setup.py install
```
To make a merge/pull request for a major code change, open an issue to discuss what you'd like to change first. And tests your code changes locally with the pre-commit hooks specified before requesting a merge-request, which automatically triggers the execution of all the tests cases in the repo.
Contributors
------------
- [Rufai Omowunmi Balogun](https://rufaibalogun.com/)
- [Peter James Zellner](https://www.eurac.edu/en/people/peter-james-zellner)
- [Felix Greifeneder](https://www.linkedin.com/in/felix-greifeneder-1328216a/?originalSubdomain=it)
License
-------
[MIT](https://choosealicense.com/licenses/mit/)
External links
---------------
- [Documentation](smodex.readthedocs.org)
- [Soil Moisture Anomalies ADO Project](https://ado.eurac.edu/sma)
- [Soil Moisture Anomalies South Tyrol Use Case]()
Raw data
{
"_id": null,
"home_page": "",
"name": "smodex",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "anomalies,soil moisture,climatology",
"author": "",
"author_email": "Rufai Omowunmi Balogun <rbalogun@eurac.edu>",
"download_url": "https://files.pythonhosted.org/packages/8a/84/b8bcf5744a17cbe700b162db2c1ed46718fe688e328bec25e23504dd2ec7/smodex-1.0.1b0.tar.gz",
"platform": null,
"description": "SMODEX Package: A Python package for understanding the evolution of soil moisture anomalies.\n===============================================================================================\n\n\n<!-- []() -->\n[](https://opensource.org/license/mit-0/)\n[](link_to_test_coverage_report)\n[](https://www.python.org/downloads/)\n<!-- [](https://peps.python.org/pep-0008/) -->\n[](https://github.com/psf/black)\n[](readthedocs.io)\n[](https://makeapullrequest.com)\n\n\nSMODEX is a **package developed to enhance performant computation and understanding of the evolution of soil moisture and soil moisture anomalies using climate datasets.** \nIt embraces the principles of FAIR and Open Science in the development of the computational workflow and the data sharing.\n\n\nPackage Usage\n=============\nSoil moisture and soil moisture anomalies are critical markers of dryness and agricultural drought. The SMODEX package was designed to aid the performant of this metrics targeting the following categories of users:\n\n1. **Researchers** working on the topics of soil moisture, drought and soil hydrology,\n2. **Students** exploring tools for understanding the dynamics of soil moisture and soil hydrology,\n3. **Open-source and Open-science scientists** looking for a wrapper to compute these specific anomalies\n\n\n\nInstallation\n==================\nThe SMODEX package is compatible with Python 3.6+ and is distributed through the [_Python Package Index (PyPI)_](https://pypi.org/project/smodex/) and can installed via:\n\n\n```bash\npip install smodex\n```\n\n\n\nUsage examples\n===============\nCurrently, the main subpackages in SMODEX include:\n- **downloader**: contains a request to the ERA5 Climate Datastore for downloading and saving soil water contents based on the specified timeline necessary for computing an anomaly, \n- **climates**: contains functionalities for computing soil moisture climatology with a given reference, and rolling mean at a weekly rolling window, dekadal, monthly or annual scale, \n- **anomaly**: contains functionalities for computing, saving soil moisture anomalies,\n- **share**: contains functionalities for sharing computed datasets with other scientists using the STAC specification (coming soon),\n- **plots**: contains different functionalities for visualizing the soil moisture and soil moisture anomalies across spatial and temporal dimensions (coming soon),\n\n\nDownloader\n----------\nTo use the downloader module, see our quick start example [here](\"examples/download_example.ipynb\")\n\nWithin a python script, this can serve as a quick guide: \n```python\nfrom smodex.downloader import cds_downloader\n\nstart_date = '2020-12-15'\nend_date = '2021-01-03'\nconf_path = 'download.json'\ndownload_path = 'moisture_data/'\n\ncds_downloader(start_date,\n end_date,\n conf_path,\n download_path)\n```\n\nHowever, this requires the installation of the `ERA5 CDS API` as well as a specification of your API keys in a `.env` file following this examples:\nRun:\n\n\n```bash \npip install cdsapi\n```\n\nAnd set the following values to those of your CDS API keys\n\n```yaml\n# .env \nCDSAPI_URL=https://cds.climate.copernicus.eu/api/v2\nCDSAPI_KEY=XXXXXX:XXXXXX-XXXXXX-XXXX-XXXXX\n```\nRemember to change the CDSAPI_KEY to that of your personal or organization's account keys.\nYou can find more specific details on how to access your personal CDS API key [here](https://cds.climate.copernicus.eu/api-how-to)\n\n\n\nContributing\n================\n\nCurrently, the SMODEX package is under development and we solicit the contribution of other developers to make a Merge/Pull Request using the development version on GitLab. You can clone the repository and install the pakcage using:\n\n```bash \npython setup.py install\n```\n\nTo make a merge/pull request for a major code change, open an issue to discuss what you'd like to change first. And tests your code changes locally with the pre-commit hooks specified before requesting a merge-request, which automatically triggers the execution of all the tests cases in the repo.\n\n\nContributors\n------------\n\n- [Rufai Omowunmi Balogun](https://rufaibalogun.com/)\n- [Peter James Zellner](https://www.eurac.edu/en/people/peter-james-zellner)\n- [Felix Greifeneder](https://www.linkedin.com/in/felix-greifeneder-1328216a/?originalSubdomain=it)\n\n\n\nLicense\n-------\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\nExternal links\n---------------\n- [Documentation](smodex.readthedocs.org)\n- [Soil Moisture Anomalies ADO Project](https://ado.eurac.edu/sma)\n- [Soil Moisture Anomalies South Tyrol Use Case]()\n",
"bugtrack_url": null,
"license": "[MIT No Attribution License](https://opensource.org/license/mit-0/) Copyright (c) 2023 Eurac Research Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A Python package for understanding the evolution of soil moisture and soil moisture anomalies",
"version": "1.0.1b0",
"project_urls": {
"Homepage": "https://gitlab.inf.unibz.it/REMSEN/smodex"
},
"split_keywords": [
"anomalies",
"soil moisture",
"climatology"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "299ee12f3f9448be475a2fc9cd5417be6557bae4f23e358d888208c2693d4993",
"md5": "0fa9426721e4e62743d59a8a8426f3a8",
"sha256": "daa447d85d9f2565e05177d4aeb02ea43af1960a74b3153a70911b4d3b0b92ee"
},
"downloads": -1,
"filename": "smodex-1.0.1b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fa9426721e4e62743d59a8a8426f3a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11801,
"upload_time": "2023-10-30T08:31:07",
"upload_time_iso_8601": "2023-10-30T08:31:07.446876Z",
"url": "https://files.pythonhosted.org/packages/29/9e/e12f3f9448be475a2fc9cd5417be6557bae4f23e358d888208c2693d4993/smodex-1.0.1b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a84b8bcf5744a17cbe700b162db2c1ed46718fe688e328bec25e23504dd2ec7",
"md5": "bd39515beff6069f26eb9ec00cb0fb88",
"sha256": "6bc5c2806b35eb660f1a9fd52cfada4d325afaaac38c14648347b743914dcab9"
},
"downloads": -1,
"filename": "smodex-1.0.1b0.tar.gz",
"has_sig": false,
"md5_digest": "bd39515beff6069f26eb9ec00cb0fb88",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 28332,
"upload_time": "2023-10-30T08:31:08",
"upload_time_iso_8601": "2023-10-30T08:31:08.859868Z",
"url": "https://files.pythonhosted.org/packages/8a/84/b8bcf5744a17cbe700b162db2c1ed46718fe688e328bec25e23504dd2ec7/smodex-1.0.1b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 08:31:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "smodex"
}
