disdrodb

📦 DISDRODB - A package to standardize, process and analyze global disdrometer data.

Deployment
Activity
Python Versions
Supported Systems
Project Status
Build Status
Linting
Code Coverage
Code Quality
Code Review
License
Community
Citation

Slack | Docs

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 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:

   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:

   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:

   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:

   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:

   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/.

If you want to improve to the DISDRODB Metadata Archive repository, you can explore the repository at https://github.com/ltelab/disdrodb-data

🛠️ Installation

DISDRODB can be installed from PyPI with pip:

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

Feel free to also open a GitHub Issue or a GitHub Discussion specific to your questions or ideas.

✍️ Contributors

• Gionata Ghiggi
• Kim Candolfi
• Régis Longchamp
• Charlotte Gisèle Weil
• Jacopo Grazioli
• Alexis Berne

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

License

The content of this repository is released under the terms of the GPL 3.0 license.