disdrodb 0.0.21__py3-none-any.whl → 0.1.0__py3-none-any.whl

disdrodb/utils/writer.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""DISDRODB product writers."""
+
+import os
+
+import xarray as xr
+
+from disdrodb.utils.attrs import set_disdrodb_attrs
+from disdrodb.utils.directories import create_directory, remove_if_exists
+
+
+def write_product(ds: xr.Dataset, filepath: str, product: str, force: bool = False) -> None:
+    """Save the xarray dataset into a NetCDF file.
+
+    Parameters
+    ----------
+    ds  : xarray.Dataset
+        Input xarray dataset.
+    filepath : str
+        Output file path.
+    product: str
+        DISDRODB product name.
+    force : bool, optional
+        Whether to overwrite existing data.
+        If ``True``, overwrite existing data into destination directories.
+        If ``False``, raise an error if there are already data into destination directories. This is the default.
+    """
+    # Create station directory if does not exist
+    create_directory(os.path.dirname(filepath))
+
+    # Check if the file already exists
+    # - If force=True --> Remove it
+    # - If force=False --> Raise error
+    remove_if_exists(filepath, force=force)
+
+    # Update attributes
+    ds = set_disdrodb_attrs(ds, product=product)
+
+    # Write netcdf
+    ds.to_netcdf(filepath, engine="netcdf4")

disdrodb/utils/xarray.py

@@ -16,69 +16,160 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
-"""Xarray utility."""
-
-import pandas as pd
+"""Xarray utilities."""
+import numpy as np
 import xarray as xr
 from xarray.core import dtypes
 
 
-def get_dataset_start_end_time(ds: xr.Dataset):
-    """Retrieves dataset starting and ending time.
+def xr_get_last_valid_idx(da_condition, dim, fill_value=None):
+    """
+    Get the index of the last True value along a specified dimension in an xarray DataArray.
+
+    This function finds the last index along the given dimension where the condition is True.
+    If all values are False or NaN along that dimension, the function returns ``fill_value``.
 
     Parameters
     ----------
-    ds : xr.Dataset
-        Input dataset
+    da_condition : xarray.DataArray
+        A boolean DataArray where True indicates valid or desired values.
+        Should have the dimension specified in `dim`.
+    dim : str
+        The name of the dimension along which to find the last True index.
+    fill_value : int or float
+        The fill value when all values are False or NaN along the specified dimension.
+        The default value is ``dim_size - 1``.
 
     Returns
     -------
-    tuple
-        (starting_time, ending_time)
+    last_idx : xarray.DataArray
+        An array containing the index of the last True value along the specified dimension.
+        If all values are False or NaN, the corresponding entry in `last_idx` will be NaN.
+
+    Notes
+    -----
+    The function works by reversing the DataArray along the specified dimension and using
+    `argmax` to find the first True value in the reversed array. It then calculates the
+    corresponding index in the original array. To handle cases where all values are False
+    or NaN (and `argmax` would return 0), the function checks if there is any True value
+    along the dimension and assigns NaN to `last_idx` where appropriate.
+
+    Examples
+    --------
+    >>> import xarray as xr
+    >>> da = xr.DataArray([[False, False, True], [False, False, False]], dims=["time", "my_dimension"])
+    >>> last_idx = xr_get_last_valid_idx(da, "my_dimension")
+    >>> print(last_idx)
+    <xarray.DataArray (time: 2)>
+    array([2., nan])
+    Dimensions without coordinates: time
+
+    In this example, for the first time step, the last True index is 2.
+    For the second time step, all values are False, so the function returns NaN.
 
     """
-    starting_time = ds["time"].values[0]
-    ending_time = ds["time"].values[-1]
-    return (starting_time, ending_time)
+    # Check input is a boolean array
+    if not np.issubdtype(da_condition.dtype, np.bool_):
+        raise ValueError("`da_condition` must be a boolean DataArray.")
+
+    # Get the size of the 'dim' dimension
+    dim_size = da_condition.sizes[dim]
+
+    # Define default fillvalue
+    if fill_value is None:
+        fill_value = dim_size - 1
+
+    # Reverse the mask along 'dim'
+    da_condition_reversed = da_condition.isel({dim: slice(None, None, -1)})
 
+    # Check if there is any True value along the dimension for each slice
+    has_true = da_condition.any(dim=dim)
 
-def regularize_dataset(ds: xr.Dataset, freq: str, time_dim="time", method=None, fill_value=dtypes.NA):
+    # Find the first non-zero index in the reversed array
+    last_idx_from_end = da_condition_reversed.argmax(dim=dim)
+
+    # Calculate the last True index in the original array
+    last_idx = xr.where(
+        has_true,
+        dim_size - last_idx_from_end - 1,
+        fill_value,
+    )
+    return last_idx
+
+
+def define_dataarray_fill_value(da):
+    """Define the fill value for a numerical xarray.DataArray."""
+    if np.issubdtype(da.dtype, np.floating):
+        return dtypes.NA
+    if np.issubdtype(da.dtype, np.integer):
+        if "_FillValue" in da.attrs:
+            return da.attrs["_FillValue"]
+        if "_FillValue" in da.encoding:
+            return da.encoding["_FillValue"]
+        return np.iinfo(da.dtype).max
+    return None
+
+
+def define_dataarray_fill_value_dictionary(da):
+    """Define fill values for numerical variables and coordinates of a xarray.DataArray.
+
+    Return a dict of fill values:
+      - floating → NaN
+      - integer → ds[var].attrs["_FillValue"] if present, else np.iinfo(dtype).max
     """
-    Regularize a dataset across time dimension with uniform resolution.
+    fill_value_dict = {}
+    # Add fill value of DataArray
+    fill_value_array = define_dataarray_fill_value(da)
+    if fill_value_array is not None:
+        fill_value_dict[da.name] = fill_value_array
+    # Add fill value of coordinates
+    fill_value_dict.update(define_dataset_fill_value_dictionary(da.coords))
+    # Return fill value dictionary
+    return fill_value_dict
 
-    Parameters
-    ----------
-    ds : xr.Dataset
-        DESCRIPTION.
-    time_dim : TYPE, optional
-        DESCRIPTION. The default is "time".
-    freq : str
-        The `freq` string to pass to pd.date_range to define the new time coordinates.
-        Examples: freq="2min"
-    time_dim : TYPE, optional
-        The time dimension in the xr.Dataset. The default is "time".
-    method : TYPE, optional
-        Method to use for filling missing timesteps.
-        If None, fill with fill_value. The default is None.
-        For other possible methods, see https://docs.xarray.dev/en/stable/generated/xarray.Dataset.reindex.html
-    fill_value : float, optional
-        Fill value to fill missing timesteps. The default is dtypes.NA.
 
-    Returns
-    -------
-    ds_reindexed : xr.Dataset
-        Regularized dataset.
+def define_dataset_fill_value_dictionary(ds):
+    """Define fill values for numerical variables and coordinates of a xarray.Dataset.
 
+    Return a dict of per-variable fill values:
+      - floating --> NaN
+      - integer --> ds[var].attrs["_FillValue"] if present, else the maximum allowed number.
     """
-    start = ds[time_dim].values[0]
-    end = ds[time_dim].values[-1]
-    new_time_index = pd.date_range(start=pd.to_datetime(start), end=pd.to_datetime(end), freq=freq)
-
-    # Regularize dataset and fill with NA values
-    ds_reindexed = ds.reindex(
-        {"time": new_time_index},
-        method=method,  # do not fill gaps
-        # tolerance=tolerance,  # mismatch in seconds
-        fill_value=fill_value,
-    )
-    return ds_reindexed
+    fill_value_dict = {}
+    # Retrieve fill values for numerical variables and coordinates
+    for var in list(ds.variables):
+        array_fill_value = define_dataarray_fill_value(ds[var])
+        if array_fill_value is not None:
+            fill_value_dict[var] = array_fill_value
+    # Return fill value dictionary
+    return fill_value_dict
+
+
+def define_fill_value_dictionary(xr_obj):
+    """Define fill values for numerical variables and coordinates of a xarray object.
+
+    Return a dict of per-variable fill values:
+      - floating --> NaN
+      - integer --> ds[var].attrs["_FillValue"] if present, else the maximum allowed number.
+    """
+    if isinstance(xr_obj, xr.Dataset):
+        return define_dataset_fill_value_dictionary(xr_obj)
+    return define_dataarray_fill_value_dictionary(xr_obj)
+
+
+####-----------------------------------------------------------------------------------
+#### Diameter and Velocity Coordinates
+
+
+def remove_diameter_coordinates(xr_obj):
+    """Drop diameter coordinates from xarray object."""
+    from disdrodb import DIAMETER_COORDS
+
+    return xr_obj.drop_vars(DIAMETER_COORDS, errors="ignore")
+
+
+def remove_velocity_coordinates(xr_obj):
+    """Drop velocity coordinates from xarray object."""
+    from disdrodb import VELOCITY_COORDS
+
+    return xr_obj.drop_vars(VELOCITY_COORDS, errors="ignore")

disdrodb/utils/yaml.py

@@ -49,4 +49,3 @@ def write_yaml(dictionary, filepath, sort_keys=False):
     """
     with open(filepath, "w") as f:
         yaml.dump(dictionary, f, sort_keys=sort_keys)
-    return None

disdrodb/viz/__init__.py

@@ -0,0 +1,17 @@
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""DISDRODB Visualization Module."""

disdrodb/viz/plots.py

@@ -0,0 +1,17 @@
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""DISDRODB Plotting Tools."""

disdrodb-0.1.0.dist-info/METADATA

@@ -0,0 +1,321 @@
+Metadata-Version: 2.4
+Name: disdrodb
+Version: 0.1.0
+Summary: disdrodb provides tools to download, standardize, share and analyze global disdrometer data.
+Author: Gionata Ghiggi
+Project-URL: homepage, https://github.com/ltelab/disdrodb
+Project-URL: repository, https://github.com/ltelab/disdrodb
+Project-URL: source, https://github.com/ltelab/disdrodb
+Project-URL: tracker, https://github.com/ltelab/disdrodb/issues
+Project-URL: documentation, https://disdrodb.readthedocs.io
+Project-URL: changelog, https://github.com/ltelab/disdrodb/blob/main/CHANGELOG.md
+Keywords: python,disdrometer,parsivel,drop size distribution
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: tqdm
+Requires-Dist: pooch
+Requires-Dist: donfig
+Requires-Dist: requests
+Requires-Dist: PyYAML
+Requires-Dist: trollsift
+Requires-Dist: netCDF4
+Requires-Dist: pyarrow
+Requires-Dist: pandas
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: dask[distributed]
+Requires-Dist: xarray
+Provides-Extra: dev
+Requires-Dist: jupyter; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pydantic>=2.0.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: requests-mock; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: loghub; extra == "dev"
+Dynamic: license-file
+
+# 📦 DISDRODB - A package to standardize, process and analyze global disdrometer data.
+
+|                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Deployment        | [![PyPI](https://badge.fury.io/py/disdrodb.svg?style=flat)](https://pypi.org/project/disdrodb/) [![Conda](https://img.shields.io/conda/vn/conda-forge/disdrodb.svg?logo=conda-forge&logoColor=white&style=flat)](https://anaconda.org/conda-forge/disdrodb)                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| Activity          | [![PyPI Downloads](https://img.shields.io/pypi/dm/disdrodb.svg?label=PyPI%20downloads&style=flat)](https://pypi.org/project/disdrodb/) [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/disdrodb.svg?label=Conda%20downloads&style=flat)](https://anaconda.org/conda-forge/disdrodb)                                                                                                                                                                                                                                                                                                                                                                               |
+| Python Versions   | [![Python Versions](https://img.shields.io/badge/Python-3.10%20%203.11%20%203.12-blue?style=flat)](https://www.python.org/downloads/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| Supported Systems | [![Linux](https://img.shields.io/github/actions/workflow/status/ltelab/disdrodb/.github/workflows/tests.yml?label=Linux&style=flat)](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [![macOS](https://img.shields.io/github/actions/workflow/status/ltelab/disdrodb/.github/workflows/tests.yml?label=macOS&style=flat)](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [![Windows](https://img.shields.io/github/actions/workflow/status/ltelab/disdrodb/.github/workflows/tests_windows.yml?label=Windows&style=flat)](https://github.com/ltelab/disdrodb/actions/workflows/tests_windows.yml)                                                |
+| Project Status    | [![Project Status](https://www.repostatus.org/badges/latest/active.svg?style=flat)](https://www.repostatus.org/#active)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| Build Status      | [![Tests](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml/badge.svg?style=flat)](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml) [![Lint](https://github.com/ltelab/disdrodb/actions/workflows/lint.yml/badge.svg?style=flat)](https://github.com/ltelab/disdrodb/actions/workflows/lint.yml) [![Docs](https://readthedocs.org/projects/disdrodb/badge/?version=latest&style=flat)](https://disdrodb.readthedocs.io/en/latest/)                                                                                                                                                                                                                    |
+| Linting           | [![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat)](https://github.com/astral-sh/ruff) [![Codespell](https://img.shields.io/badge/Codespell-enabled-brightgreen?style=flat)](https://github.com/codespell-project/codespell)                                                                                                                                                                                                                                                     |
+| Code Coverage     | [![Coveralls](https://coveralls.io/repos/github/ltelab/disdrodb/badge.svg?branch=main&style=flat)](https://coveralls.io/github/ltelab/disdrodb?branch=main) [![Codecov](https://codecov.io/gh/ltelab/disdrodb/branch/main/graph/badge.svg?style=flat)](https://codecov.io/gh/ltelab/disdrodb)                                                                                                                                                                                                                                                                                                                                                                                     |
+| Code Quality      | [![Codefactor](https://www.codefactor.io/repository/github/ltelab/disdrodb/badge?style=flat)](https://www.codefactor.io/repository/github/ltelab/disdrodb) [![Codebeat](https://codebeat.co/badges/14ff831b-f064-4bdd-a2e2-72ffdf28a35a?style=flat)](https://codebeat.co/projects/github-com-ltelab-disdrodb-main) [![Codacy](https://app.codacy.com/project/badge/Grade/d823c50a7ad14268bd347b5aba384623?style=flat)](https://app.codacy.com/gh/ltelab/disdrodb/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Codescene](https://codescene.io/projects/36773/status-badges/code-health?style=flat)](https://codescene.io/projects/36773) |
+| License           | [![License](https://img.shields.io/github/license/ltelab/disdrodb?style=flat)](https://github.com/ltelab/disdrodb/blob/main/LICENSE) |
+| Community         | [![Slack](https://img.shields.io/badge/Slack-disdrodb-green.svg?logo=slack&style=flat)](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA) [![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-green?logo=github&style=flat)](https://github.com/ltelab/disdrodb/discussions)  |
+| Citation          | [![DOI](https://zenodo.org/badge/429018433.svg?style=flat)](https://zenodo.org/doi/10.5281/zenodo.7680581) |
+
+[**Slack**](https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA) | [**Documentation**](https://disdrodb.readthedocs.io/en/latest/)
+
+DISDRODB is part of an international joint effort to index, collect and homogenize drop size distribution (DSD) data from around the world.
+
+The DISDRODB project also aims to establish a global standard for sharing disdrometer observations.
+Built on FAIR data principles and Climate & Forecast (CF) conventions, DISDRODB standards facilitates the processing, analysis, and visualization of disdrometer data.
+
+
+## ℹ️ Software Overview
+
+The software enables you to:
+
+- Upload raw data of new disdrometer stations to the DISDRODB Decentralized Data Archive
+
+- Download the raw disdrometer data from stations included in the DISDRODB Decentralized Data Archive
+
+- Convert raw disdrometer data into a standard NetCDF format (DISDRODB L0 product)
+
+- Generate standardized, homogenized, and quality-checked disdrometer measurements (DISDRODB L1 product)
+
+- Compute empirical and model-based drop size distribution parameters and derive geophysical and polarimetric radar variables of interest (DISDRODB L2 product)
+
+Currently, the DISDRODB Working Group is finalizing the development of the L1 and L2 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.
+
+### 📚 Download the DISDRODB Metadata Archive
+
+The DISDRODB Metadata Archive is a collection of metadata files that describe the disdrometer stations included in DISDRODB.
+
+To download the DISDRODB Metadata Archive, navigate to the desired directory and run:
+
+```bash
+
+git clone https://github.com/ltelab/DISDRODB-METADATA.git
+
+```
+
+This command will download a directory called `DISDRODB-METADATA`.
+
+Alternatively, you can download a static version of the DISDRODB Metadata Archive using:
+
+```bash
+disdrodb_download_metadata_archive /custom/path/where/to/download/DISDRODB-METADATA
+```
+
+### 📚 Define the DISDRODB Configuration File
+
+The disdrodb software needs to know where the local DISDRODB Metadata Archive
+is stored on your local machine, as well as where you want to download the raw stations data
+as well as where to save the DISDRODB products you will generate.
+
+Within the `disdrodb` package, the argument `metadata_archive_dir` refers to the base directory of your local DISDRODB Metadata Archive, while `data_archive_dir` refers to the base directory of your local DISDRODB Data Archive.
+
+The `metadata_archive_dir` path corresponds to the `DISDRODB` directory within the `DISDRODB-METADATA` archive.
+The `data_archive_dir` path corresponds to `DISDRODB` directory of choice where
+all DISDRODB products will be saved.
+
+To facilitate the creation of the DISDRODB Configuration File, you can adapt and run in python the following code snippet.
+Please note that on Windows these paths must end with `\DISDRODB`, while on macOS/Linux they must end with `/DISDRODB`.
+
+```python
+import disdrodb
+
+metadata_archive_dir = "/<path_to>/DISDRODB-METADATA/DISDRODB"
+data_archive_dir = "/<path_of_choice_to_the_local_data_archive>/DISDRODB"
+disdrodb.define_configs(
+    metadata_archive_dir=metadata_archive_dir, data_archive_dir=data_archive_dir
+)
+```
+
+By running this command, the disdrodb software will write a `.config_disdrodb.yml` file into your home directory (i.e. `~/.config_disdrodb.yml`)
+that will be used as default configuration file when running the disdrodb software.
+
+If you **now close your python session and reopen a new one**, if you will run the following code snippet, you
+should get the `metadata_archive_dir` and `data_archive_dir` paths you just defined in the DISDRODB Configuration File:
+
+```python
+import disdrodb
+
+print("DISDRODB Metadata Archive Directory: ", disdrodb.get_metadata_archive_dir())
+print("DISDRODB Data Archive Directory: ", disdrodb.get_data_archive_dir())
+```
+
+You can also verify and print the default DISDRODB Metadata Archive and Data Archive directories
+by typing the following command in the terminal:
+
+```bash
+
+   disdrodb_data_archive_directory
+   disdrodb_metadata_archive_directory
+
+```
+
+### 📥 Download the DISDRODB Raw Data Archive
+
+To download all data stored into the DISDRODB Decentralized Data Archive, you just have to run the following command:
+
+```bash
+disdrodb_download_archive
+```
+
+If you aim to download data from a specific source (e.g., EPFL), run:
+
+```bash
+disdrodb_download_archive --data-sources EPFL
+```
+
+Type `disdrodb_download_archive --help` to see further options.
+
+To open the local DISDRODB Data Archive directory, type:
+
+```bash
+disdrodb_open_data_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
+```
+
+Type `disdrodb_run_l0 --help` to see further options.
+
+### 💫 Generate the DISDRODB L1 and L2 products
+
+To generate the DISDRODB L1 and L2 products, run the following commands in the terminal:
+
+```bash
+disdrodb_run_l1
+```
+```bash
+disdrodb_run_l2e
+```
+```bash
+disdrodb_run_l2m
+```
+
+### 💫 Open analysis-ready DISDRODB products
+
+The disdrodb software `open_dataset` function enable to lazy open all station files of
+a DISDRODB product into a `xarray.Dataset` (or `pandas.DataFrame` for the DISDRODB L0A product).
+
+```python
+import disdrodb
+
+# Define station arguments
+data_source = "EPFL"
+campaign_name = "HYMEX_LTE_SOP3"
+station_name = "10"
+
+# Open all station files of a specific product
+ds = disdrodb.open_dataset(
+    product="L0C",
+    # Station arguments
+    data_source=data_source,
+    campaign_name=campaign_name,
+    station_name=station_name,
+)
+ds
+```
+
+This allows you to jump directly into analyzing disdrometer data without worrying about processing steps.
+
+### 💫 Explore the DISDRODB Metadata Archive
+
+To explore the DISDRODB Metadata Archive, you can type into the terminal:
+
+```bash
+disdrodb_open_metadata_archive
+```
+
+If you wish to analyze the DISDRODB Metadata Archive information of all stations,
+the `read_metadata_archive` python function returns all stations metadata information into an easy to analyze `pandas.DataFrame`:
+
+```python
+import disdrodb
+
+df = disdrodb.read_metadata_archive()
+print(df)
+```
+
+## 📖 Explore the DISDRODB documentation
+
+With this introduction, we just scratched the surface of the disdrodb software capabilities.
+To discover more about the DISDRODB products, the 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/).
+
+## 🛠️ Installation
+
+### conda
+
+DISDRODB can be installed via [conda][conda_link] on Linux, Mac, and Windows.
+Install the package by typing the following command in the terminal:
+
+```bash
+conda install disdrodb
+```
+
+In case conda-forge is not set up for your system yet, see the easy to follow instructions on [conda-forge][conda_forge_link].
+
+### pip
+
+DISDRODB can be installed also via [pip][pip_link] on Linux, Mac, and Windows.
+On Windows you can install [WinPython][winpy_link] to get Python and pip running.
+
+Then, install the DISDRODB package by typing the following command in the terminal:
+
+```bash
+pip install disdrodb
+```
+
+To install the latest development version via pip, see the [documentation][dev_install_link].
+
+## 💭 Feedback and Contributing Guidelines
+
+If you aim to contribute your data or discuss the future development of DISDRODB,
+we highly recommend 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).
+
+[conda_forge_link]: https://github.com/conda-forge/disdrodb-feedstock#installing-disdrodb
+[conda_link]: https://docs.conda.io/en/latest/miniconda.html
+[dev_install_link]: https://disdrodb.readthedocs.io/en/latest/installation.html#installation-for-contributors
+[pip_link]: https://pypi.org/project/disdrodb
+[winpy_link]: https://winpython.github.io/