# 📦 DISDRODB - A package to standardize, process and analyze global disdrometer data.
| | |
| -------------------- | ---------------------------------------------- |
| Deployment | [](https://pypi.org/project/disdrodb/) [](https://anaconda.org/conda-forge/disdrodb) |
| Activity | [](https://pypi.org/project/disdrodb/) [](https://anaconda.org/conda-forge/disdrodb) |
| Python Versions | [](https://www.python.org/downloads/) |
| Supported Systems | [](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [](https://github.com/ltelab/disdrodb/actions/workflows/tests_windows.yml) |
| Project Status | [](https://www.repostatus.org/#active) |
| Build Status | [](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [](https://github.com/ltelab/disdrodb/actions/workflows/lint.yml) [](https://disdrodb.readthedocs.io/en/latest/) |
| Linting | [](https://github.com/psf/black) [](https://github.com/astral-sh/ruff) [](https://github.com/codespell-project/codespell) |
| Code Coverage | [](https://coveralls.io/github/ltelab/disdrodb?branch=main) [](https://codecov.io/gh/ltelab/disdrodb) |
| Code Quality | [](https://www.codefactor.io/repository/github/ltelab/disdrodb) [](https://codebeat.co/projects/github-com-ltelab-disdrodb-main) [](https://app.codacy.com/gh/ltelab/disdrodb/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://codescene.io/projects/36773) |
| Code Review | [](#) [](#) |
| License | [](https://github.com/ltelab/disdrodb/blob/main/LICENSE) |
| Community | [](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA) [](https://github.com/ltelab/disdrodb/discussions) |
| Citation | [](#) [](https://zenodo.org/doi/10.5281/zenodo.7680581) |
[**Slack**](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA) | [**Docs**](https://disdrodb.readthedocs.io/en/latest/)
DISDRODB is part of an initial effort to index, collect and homogenize drop size distribution (DSD) data sets across the globe,
as well as to establish a global standard for disdrometers observations data sharing.
DISDRODB standards are being established following FAIR data best practices and Climate & Forecast (CF) conventions, and will facilitate
the preprocessing, analysis and visualization of disdrometer data.
## ℹ️ Software Overview
The software currently enable to:
- download the raw disdrometer data from all stations included in the DISDRODB Decentralized Data Archive
- upload raw disdrometer data from the user to the DISDRODB Decentralized Data Archive
- process more than 400 disdrometer stations into a standard NetCDF format (DISDRODB L0 product)
Currently, the DISDRODB Working Group is discussing the development of various scientific products.
If you have ideas, algorithms, data or expertise to share, or you want to contribute to the future DISDRODB products, do not hesitate to get in touch !!!
Join the [**DISDRODB Slack Workspace**](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA) to meet the DISDRODB Community !
## 🚀 Quick Start
You're about to create your very own DISDRODB Local Data Archive. All it takes is a simple command-line journey.
#### 📚 Set up the DISDRODB Metadata And Local Data Archive
Let's start by travel to the directory where you want to store the DISDRODB Data Archive.
Then clone the DISDRODB Metadata Archive repository with:
```bash
git clone https://github.com/ltelab/disdrodb-data.git
```
This will create a directory called ``disdrodb-data``, which is ready to be filled with data from the DISDRODB Decentralized Data Archive.
But before starting to download some data, we need to specify the location of the DISDRODB Local Archive.
You can specify once forever the default DISDRODB Local Archive directory by running in python:
```python
import disdrodb
base_dir = "<the_path_to>/disdrodb-data/DISDRODB>"
disdrodb.define_configs(base_dir=base_dir)
```
or set up the (temporary) environment variable `DISDRODB_BASE_DIR` in your terminal with:
```bash
export DISDRODB_BASE_DIR="<the_path_to>/disdrodb-data/DISDRODB>"
```
#### 📥 Download the DISDRODB raw data
To download all data stored into the DISDRODB Decentralized Data Archive, you just have to run the following command:
```bash
disdrodb_download_archive
```
#### 💫 Transform the raw data to standardized netCDF files.
If you want to convert all stations raw data into standardized netCDF4 files, run the following command in the terminal:
```bash
disdrodb_run_l0
```
#### 📖 Explore the DISDRODB documentation
To discover all download and processing options, or how to contribute your own data to DISDRODB,
please read the software documentation available at [https://disdrodb.readthedocs.io/en/latest/](https://disdrodb.readthedocs.io/en/latest/).
If you want to improve to the DISDRODB Metadata Archive repository, you can explore the repository
at [https://github.com/ltelab/disdrodb-data](https://github.com/ltelab/disdrodb-data)
## 🛠️ Installation
DISDRODB can be installed from PyPI with pip:
```bash
pip install disdrodb
```
## 💭 Feedback and Contributing Guidelines
If you aim to contribute your data or discuss the future development of DISDRODB,
we highly suggest to join the [**DISDRODB Slack Workspace**](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA)
Feel free to also open a [GitHub Issue](https://github.com/ltelab/disdrodb/issues) or a
[GitHub Discussion](https://github.com/ltelab/disdrodb/discussions) specific to your questions or ideas.
## ✍️ Contributors
* [Gionata Ghiggi](https://people.epfl.ch/gionata.ghiggi)
* [Kim Candolfi](https://github.com/KimCandolfi)
* [Régis Longchamp](https://people.epfl.ch/regis.longchamp)
* [Charlotte Gisèle Weil](https://people.epfl.ch/charlotte.weil)
* [Jacopo Grazioli](https://people.epfl.ch/jacopo.grazioli)
* [Alexis Berne](https://people.epfl.ch/alexis.berne?lang=en)
## Citation
You can cite the DISDRODB software by:
> Gionata Ghiggi, Kim Candolfi, Régis Longchamp, Charlotte Weil, Alexis Berne (2023). ltelab/disdrodb Zenodo. https://doi.org/10.5281/zenodo.7680581
If you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7680581)
## License
The content of this repository is released under the terms of the [GPL 3.0 license](LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "disdrodb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "python,disdrometer,parsivel,drop size distribution",
"author": "Gionata Ghiggi",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/29/69/0e409f521abd355c0699be46148d43a5a7f9a92e66c3a49a5ca85a41384f/disdrodb-0.0.21.tar.gz",
"platform": null,
"description": "# \ud83d\udce6 DISDRODB - A package to standardize, process and analyze global disdrometer data.\n\n| | |\n| -------------------- | ---------------------------------------------- |\n| Deployment | [](https://pypi.org/project/disdrodb/) [](https://anaconda.org/conda-forge/disdrodb) |\n| Activity | [](https://pypi.org/project/disdrodb/) [](https://anaconda.org/conda-forge/disdrodb) |\n| Python Versions | [](https://www.python.org/downloads/) |\n| Supported Systems | [](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [](https://github.com/ltelab/disdrodb/actions/workflows/tests_windows.yml) |\n| Project Status | [](https://www.repostatus.org/#active) |\n| Build Status | [](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [](https://github.com/ltelab/disdrodb/actions/workflows/lint.yml) [](https://disdrodb.readthedocs.io/en/latest/) |\n| Linting | [](https://github.com/psf/black) [](https://github.com/astral-sh/ruff) [](https://github.com/codespell-project/codespell) |\n| Code Coverage | [](https://coveralls.io/github/ltelab/disdrodb?branch=main) [](https://codecov.io/gh/ltelab/disdrodb) |\n| Code Quality | [](https://www.codefactor.io/repository/github/ltelab/disdrodb) [](https://codebeat.co/projects/github-com-ltelab-disdrodb-main) [](https://app.codacy.com/gh/ltelab/disdrodb/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://codescene.io/projects/36773) |\n| Code Review | [](#) [](#) |\n| License | [](https://github.com/ltelab/disdrodb/blob/main/LICENSE) |\n| Community | [](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA) [](https://github.com/ltelab/disdrodb/discussions) |\n| Citation | [](#) [](https://zenodo.org/doi/10.5281/zenodo.7680581) |\n\n [**Slack**](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA) | [**Docs**](https://disdrodb.readthedocs.io/en/latest/)\n\nDISDRODB is part of an initial effort to index, collect and homogenize drop size distribution (DSD) data sets across the globe,\nas well as to establish a global standard for disdrometers observations data sharing.\nDISDRODB standards are being established following FAIR data best practices and Climate & Forecast (CF) conventions, and will facilitate\nthe preprocessing, analysis and visualization of disdrometer data.\n\n## \u2139\ufe0f Software Overview\n\nThe software currently enable to:\n- download the raw disdrometer data from all stations included in the DISDRODB Decentralized Data Archive\n- upload raw disdrometer data from the user to the DISDRODB Decentralized Data Archive\n- process more than 400 disdrometer stations into a standard NetCDF format (DISDRODB L0 product)\n\nCurrently, the DISDRODB Working Group is discussing the development of various scientific products.\nIf you have ideas, algorithms, data or expertise to share, or you want to contribute to the future DISDRODB products, do not hesitate to get in touch !!!\n\nJoin the [**DISDRODB Slack Workspace**](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA) to meet the DISDRODB Community !\n\n\n## \ud83d\ude80 Quick Start\n\nYou're about to create your very own DISDRODB Local Data Archive. All it takes is a simple command-line journey.\n\n#### \ud83d\udcda Set up the DISDRODB Metadata And Local Data Archive\n\nLet's start by travel to the directory where you want to store the DISDRODB Data Archive.\n\nThen clone the DISDRODB Metadata Archive repository with:\n\n```bash\n\n git clone https://github.com/ltelab/disdrodb-data.git\n```\n\nThis will create a directory called ``disdrodb-data``, which is ready to be filled with data from the DISDRODB Decentralized Data Archive.\n\nBut before starting to download some data, we need to specify the location of the DISDRODB Local Archive.\n\nYou can specify once forever the default DISDRODB Local Archive directory by running in python:\n\n```python\n import disdrodb\n base_dir = \"<the_path_to>/disdrodb-data/DISDRODB>\"\n disdrodb.define_configs(base_dir=base_dir)\n```\n\nor set up the (temporary) environment variable `DISDRODB_BASE_DIR` in your terminal with:\n\n```bash\n export DISDRODB_BASE_DIR=\"<the_path_to>/disdrodb-data/DISDRODB>\"\n```\n\n#### \ud83d\udce5 Download the DISDRODB raw data\n\nTo download all data stored into the DISDRODB Decentralized Data Archive, you just have to run the following command:\n\n```bash\n disdrodb_download_archive\n```\n\n#### \ud83d\udcab Transform the raw data to standardized netCDF files.\n\nIf you want to convert all stations raw data into standardized netCDF4 files, run the following command in the terminal:\n\n```bash\n\n disdrodb_run_l0\n\n```\n\n#### \ud83d\udcd6 Explore the DISDRODB documentation\n\nTo discover all download and processing options, or how to contribute your own data to DISDRODB,\nplease read the software documentation available at [https://disdrodb.readthedocs.io/en/latest/](https://disdrodb.readthedocs.io/en/latest/).\n\nIf you want to improve to the DISDRODB Metadata Archive repository, you can explore the repository\nat [https://github.com/ltelab/disdrodb-data](https://github.com/ltelab/disdrodb-data)\n\n\n## \ud83d\udee0\ufe0f Installation\n\n\nDISDRODB can be installed from PyPI with pip:\n\n ```bash\n\n pip install disdrodb\n\n ```\n\n## \ud83d\udcad Feedback and Contributing Guidelines\n\nIf you aim to contribute your data or discuss the future development of DISDRODB,\nwe highly suggest to join the [**DISDRODB Slack Workspace**](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA)\n\nFeel free to also open a [GitHub Issue](https://github.com/ltelab/disdrodb/issues) or a\n[GitHub Discussion](https://github.com/ltelab/disdrodb/discussions) specific to your questions or ideas.\n\n\n## \u270d\ufe0f Contributors\n\n* [Gionata Ghiggi](https://people.epfl.ch/gionata.ghiggi)\n* [Kim Candolfi](https://github.com/KimCandolfi)\n* [R\u00e9gis Longchamp](https://people.epfl.ch/regis.longchamp)\n* [Charlotte Gis\u00e8le Weil](https://people.epfl.ch/charlotte.weil)\n* [Jacopo Grazioli](https://people.epfl.ch/jacopo.grazioli)\n* [Alexis Berne](https://people.epfl.ch/alexis.berne?lang=en)\n\n## Citation\n\nYou can cite the DISDRODB software by:\n\n> Gionata Ghiggi, Kim Candolfi, R\u00e9gis Longchamp, Charlotte Weil, Alexis Berne (2023). ltelab/disdrodb Zenodo. https://doi.org/10.5281/zenodo.7680581\n\nIf you want to cite a specific version, have a look at the [Zenodo site](https://doi.org/10.5281/zenodo.7680581)\n\n## License\n\nThe content of this repository is released under the terms of the [GPL 3.0 license](LICENSE).\n",
"bugtrack_url": null,
"license": "",
"summary": "disdrodb provides tools to download, standardize, share and analyze global disdrometer data.",
"version": "0.0.21",
"project_urls": {
"changelog": "https://github.com/ltelab/disdrodb/CHANGELOG.md",
"documentation": "https://disdrodb.readthedocs.io",
"homepage": "https://github.com/ltelab/disdrodb",
"repository": "https://github.com/ltelab/disdrodb",
"source": "https://github.com/ltelab/disdrodb",
"tracker": "https://github.com/ltelab/disdrodb/issues"
},
"split_keywords": [
"python",
"disdrometer",
"parsivel",
"drop size distribution"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b19157a47fd5dadd3ba867289a5c037dbdcf84ac5df9eadc16675b04a575684a",
"md5": "5d39a190159b2262272683adaa8f9245",
"sha256": "b00b34939628c12aed90abe2cf492d04bc748a338792bb8953bcce9abf37b8ad"
},
"downloads": -1,
"filename": "disdrodb-0.0.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d39a190159b2262272683adaa8f9245",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9676798,
"upload_time": "2023-12-04T16:37:41",
"upload_time_iso_8601": "2023-12-04T16:37:41.340493Z",
"url": "https://files.pythonhosted.org/packages/b1/91/57a47fd5dadd3ba867289a5c037dbdcf84ac5df9eadc16675b04a575684a/disdrodb-0.0.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29690e409f521abd355c0699be46148d43a5a7f9a92e66c3a49a5ca85a41384f",
"md5": "b10c0a4bb53af63de2ca23ce4ba708ec",
"sha256": "107251c3430409eda12f922c878a686257572f85772ee481ea7c7a23b615e4c9"
},
"downloads": -1,
"filename": "disdrodb-0.0.21.tar.gz",
"has_sig": false,
"md5_digest": "b10c0a4bb53af63de2ca23ce4ba708ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9514244,
"upload_time": "2023-12-04T16:37:44",
"upload_time_iso_8601": "2023-12-04T16:37:44.251458Z",
"url": "https://files.pythonhosted.org/packages/29/69/0e409f521abd355c0699be46148d43a5a7f9a92e66c3a49a5ca85a41384f/disdrodb-0.0.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-04 16:37:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ltelab",
"github_project": "disdrodb",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "disdrodb"
}
JSON
