disdrodb 0.1.0__tar.gz → 0.1.2__tar.gz

{disdrodb-0.1.0 → disdrodb-0.1.2}/.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
       - id: check-ast
       - id: check-added-large-files
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.8
+    rev: v0.11.9
     hooks:
       - id: ruff
         args: [--fix]

{disdrodb-0.1.0 → disdrodb-0.1.2}/CONTRIBUTING.rst

@@ -1,43 +1,43 @@
 Contributors Guidelines
 ===========================
 
-Hi! Thanks for taking the time to contribute to DISDRODB.
+Hi! Thank you for taking the time to contribute to DISDRODB.
 
 You can contribute in many ways:
 
 - Join the `GitHub discussions <https://github.com/ltelab/disdrodb/discussions>`__
 - Report software `issues <#issue-reporting-guidelines>`__
-- Help us developing new readers
+- Help us develop new readers
 - Add new data to the DISDRODB Decentralized Data Archive
 - Implement new products
 - ...
-- Any code improvements are welcome !
+- Any code improvements are welcome!
 
-**We Develop with GitHub !**
+**We develop with GitHub!**
 
 We use GitHub to host code, to track issues and feature requests, as well as accept Pull Requests.
 We use `GitHub flow <https://docs.github.com/en/get-started/quickstart/github-flow>`__.
 So all code changes happen through Pull Requests (PRs).
 
 
-**First Time Contributors ?**
+**First-Time Contributors?**
 
-Before adding your contribution, please take a moment to read through the following sections:
+Before contributing, please take a moment to read through the following sections:
 
 - The `Installation for contributors <https://disdrodb.readthedocs.io/en/latest/installation.html#installation-for-contributors>`__ help you to set up the developing environment and the pre-commit hooks.
 - The section `Contributing process <#contributing-process>`__ provides you with a brief overview of the steps that each DISDRODB developer must follow to contribute to the repository.
 - The `Code review checklist <#code-review-checklist>`__ enable to speed up the code review process.
 - The `Code of conduct <https://github.com/ltelab/disdrodb/blob/main/CODE_OF_CONDUCT.md>`__ details the expected behavior of all contributors.
 
-Initiating a discussion about your ideas or proposed implementations is a vital step before starting your contribution !
+Initiating a discussion about your ideas or proposed implementations is a vital step before starting your contribution!
 Engaging with the community early on can provide valuable insights, ensure alignment with the project's goals, and prevent potential overlap with existing work.
 Here are some guidelines to facilitate this process:
 
 1. Start with a conversation
 
-   Before start coding, open a `GitHub Discussion <https://github.com/ltelab/disdrodb/discussions>`__, a `GitHub Feature Request Issue <https://github.com/ltelab/disdrodb/issues/new/choose>`__ or
+   Before you start coding, open a `GitHub Discussion <https://github.com/ltelab/disdrodb/discussions>`__, a `GitHub Feature Request Issue <https://github.com/ltelab/disdrodb/issues/new/choose>`__ or
    just start a discussion in the `DISDRODB Slack Workspace <https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA>`__.
-   These channels of communication provides an opportunity to gather feedback, understand the project's current state, and improve your contributions.
+   These channels of communication provide an opportunity to gather feedback, understand the project's current state, and improve your contributions.
 
 2. Seek guidance and suggestions
 
@@ -91,8 +91,7 @@ If you do not have yet Git installed on your computer, please install it followi
 Then, please follow the guidelines in the `Installation for contributors <https://disdrodb.readthedocs.io/en/latest/installation.html#installation-for-contributors>`__ section
 to create the local copy of the disdrodb repository, set up the developing environment and the pre-commit hooks.
 
-Once you have have a local copy of the disdrodb repository on your machine, you are ready to
-contribute to the project!
+Once you have a local copy of the disdrodb repository on your machine, you're ready to contribute!
 
 
 2. Create a new branch
@@ -244,7 +243,7 @@ Refer to the table below for a comprehensive summary of all CI tools employed to
 5. Code testing with pytest
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-DISDRODB tests are written using the third-party `pytest <https://docs.pytest.org>`_ package. Every code change must be tested !
+DISDRODB tests are written using the third-party `pytest <https://docs.pytest.org>`_ package. Every code change must be tested!
 
 The tests are organized within the ``/disdrodb/tests`` directory and are structured to comprehensively assess various aspects of the code.
 

{disdrodb-0.1.0/disdrodb.egg-info → disdrodb-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: disdrodb
-Version: 0.1.0
+Version: 0.1.2
 Summary: disdrodb provides tools to download, standardize, share and analyze global disdrometer data.
 Author: Gionata Ghiggi
 Project-URL: homepage, https://github.com/ltelab/disdrodb
@@ -47,7 +47,7 @@ Requires-Dist: twine; extra == "dev"
 Requires-Dist: loghub; extra == "dev"
 Dynamic: license-file
 
-# 📦 DISDRODB - A package to standardize, process and analyze global disdrometer data.
+# 📦 DISDRODB - A package to standardize, process and analyze global disdrometer data
 
 |                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -60,17 +60,16 @@ Dynamic: license-file
 | 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) |
+| 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.
-
+Built on FAIR data principles and Climate & Forecast (CF) conventions, DISDRODB standards facilitate the processing, analysis and visualization of disdrometer data.
 
 ## ℹ️ Software Overview
 
@@ -87,13 +86,13 @@ The software enables you to:
 - 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 !!!
+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 !
+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.
+Create your own DISDRODB Local Data Archive.
 
 ### 📚 Download the DISDRODB Metadata Archive
 
@@ -102,76 +101,62 @@ The DISDRODB Metadata Archive is a collection of metadata files that describe th
 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:
+Or download a static snapshot without using git:
 
 ```bash
-disdrodb_download_metadata_archive /custom/path/where/to/download/DISDRODB-METADATA
+disdrodb_download_metadata_archive /path/to/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 disdrodb software requires to know two directories:
 
-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.
+- `metadata_archive_dir`: the base of your local DISDRODB Metadata Archive
+- `data_archive_dir`: the base of your local DISDRODB Data Archive
 
-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`.
+On Windows, paths must end with `\DISDRODB`; 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"
+data_archive_dir = "/<path_to>/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.
+This creates a `.config_disdrodb.yml` file in your home directory (e.g., `~/.config_disdrodb.yml`).
 
-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:
+To verify the configuration, open a new Python session and run:
 
 ```python
 import disdrodb
 
-print("DISDRODB Metadata Archive Directory: ", disdrodb.get_metadata_archive_dir())
-print("DISDRODB Data Archive Directory: ", disdrodb.get_data_archive_dir())
+print("Metadata Archive Directory:", disdrodb.get_metadata_archive_dir())
+print("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:
+Or in the shell:
 
 ```bash
-
-   disdrodb_data_archive_directory
-   disdrodb_metadata_archive_directory
-
+disdrodb_metadata_archive_directory
+disdrodb_data_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:
+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:
+To download from a specific source (e.g., EPFL):
 
 ```bash
 disdrodb_download_archive --data-sources EPFL
@@ -185,7 +170,7 @@ To open the local DISDRODB Data Archive directory, type:
 disdrodb_open_data_archive
 ```
 
-### 💫 Transform the raw data to standardized netCDF files
+### 💫 Transform Raw Data to Standardized netCDFs
 
 If you want to convert all stations raw data into standardized netCDF4 files, run the following command in the terminal:
 
@@ -195,40 +180,28 @@ disdrodb_run_l0
 
 Type `disdrodb_run_l0 --help` to see further options.
 
-### 💫 Generate the DISDRODB L1 and L2 products
+### 💫 Generate DISDRODB L1 and p2 products
 
-To generate the DISDRODB L1 and L2 products, run the following commands in the terminal:
+To generate 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
+### 💫 Analyze Analysis‐Ready 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).
+The software’s `open_dataset` function **lazily** opens all station files of a given 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,
+    data_source="EPFL",
+    campaign_name="HYMEX_LTE_SOP3",
+    station_name="10",
 )
 ds
 ```

{disdrodb-0.1.0 → disdrodb-0.1.2}/README.md

@@ -1,4 +1,4 @@
-# 📦 DISDRODB - A package to standardize, process and analyze global disdrometer data.
+# 📦 DISDRODB - A package to standardize, process and analyze global disdrometer data
 
 |                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -11,17 +11,16 @@
 | 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) |
+| 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.
-
+Built on FAIR data principles and Climate & Forecast (CF) conventions, DISDRODB standards facilitate the processing, analysis and visualization of disdrometer data.
 
 ## ℹ️ Software Overview
 
@@ -38,13 +37,13 @@ The software enables you to:
 - 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 !!!
+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 !
+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.
+Create your own DISDRODB Local Data Archive.
 
 ### 📚 Download the DISDRODB Metadata Archive
 
@@ -53,76 +52,62 @@ The DISDRODB Metadata Archive is a collection of metadata files that describe th
 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:
+Or download a static snapshot without using git:
 
 ```bash
-disdrodb_download_metadata_archive /custom/path/where/to/download/DISDRODB-METADATA
+disdrodb_download_metadata_archive /path/to/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 disdrodb software requires to know two directories:
 
-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.
+- `metadata_archive_dir`: the base of your local DISDRODB Metadata Archive
+- `data_archive_dir`: the base of your local DISDRODB Data Archive
 
-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`.
+On Windows, paths must end with `\DISDRODB`; 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"
+data_archive_dir = "/<path_to>/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.
+This creates a `.config_disdrodb.yml` file in your home directory (e.g., `~/.config_disdrodb.yml`).
 
-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:
+To verify the configuration, open a new Python session and run:
 
 ```python
 import disdrodb
 
-print("DISDRODB Metadata Archive Directory: ", disdrodb.get_metadata_archive_dir())
-print("DISDRODB Data Archive Directory: ", disdrodb.get_data_archive_dir())
+print("Metadata Archive Directory:", disdrodb.get_metadata_archive_dir())
+print("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:
+Or in the shell:
 
 ```bash
-
-   disdrodb_data_archive_directory
-   disdrodb_metadata_archive_directory
-
+disdrodb_metadata_archive_directory
+disdrodb_data_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:
+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:
+To download from a specific source (e.g., EPFL):
 
 ```bash
 disdrodb_download_archive --data-sources EPFL
@@ -136,7 +121,7 @@ To open the local DISDRODB Data Archive directory, type:
 disdrodb_open_data_archive
 ```
 
-### 💫 Transform the raw data to standardized netCDF files
+### 💫 Transform Raw Data to Standardized netCDFs
 
 If you want to convert all stations raw data into standardized netCDF4 files, run the following command in the terminal:
 
@@ -146,40 +131,28 @@ disdrodb_run_l0
 
 Type `disdrodb_run_l0 --help` to see further options.
 
-### 💫 Generate the DISDRODB L1 and L2 products
+### 💫 Generate DISDRODB L1 and p2 products
 
-To generate the DISDRODB L1 and L2 products, run the following commands in the terminal:
+To generate 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
+### 💫 Analyze Analysis‐Ready 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).
+The software’s `open_dataset` function **lazily** opens all station files of a given 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,
+    data_source="EPFL",
+    campaign_name="HYMEX_LTE_SOP3",
+    station_name="10",
 )
 ds
 ```

{disdrodb-0.1.0 → disdrodb-0.1.2}/disdrodb/__init__.py

@@ -73,7 +73,7 @@ DIAMETER_COORDS = ["diameter_bin_center", "diameter_bin_width", "diameter_bin_lo
 VELOCITY_COORDS = ["velocity_bin_center", "velocity_bin_width", "velocity_bin_lower", "velocity_bin_upper"]
 VELOCITY_DIMENSION = "velocity_bin_center"
 DIAMETER_DIMENSION = "diameter_bin_center"
-OPTICAL_SENSORS = ["PARSIVEL", "PARSIVEL2", "LPM"]
+OPTICAL_SENSORS = ["PARSIVEL", "PARSIVEL2", "LPM", "PWS100"]
 IMPACT_SENSORS = ["RD80"]
 
 

{disdrodb-0.1.0 → disdrodb-0.1.2}/disdrodb/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
+__version__ = version = '0.1.2'
+__version_tuple__ = version_tuple = (0, 1, 2)

{disdrodb-0.1.0 → disdrodb-0.1.2}/disdrodb/api/io.py

@@ -141,6 +141,7 @@ def open_dataset(
     product_kwargs=None,
     debugging_mode: bool = False,
     data_archive_dir: Optional[str] = None,
+    parallel=False,
     **open_kwargs,
 ):
     """Retrieve DISDRODB product files for a give station.
@@ -205,8 +206,17 @@ def open_dataset(
     # Open DISDRODB netCDF files using xarray
     # - TODO: parallel option and add closers !
     # - decode_timedelta -- > sample_interval not decoded to timedelta !
-    list_ds = [xr.open_dataset(fpath, decode_timedelta=False, **open_kwargs) for fpath in filepaths]
-    ds = xr.concat(list_ds, dim="time")
+    # list_ds = [xr.open_dataset(fpath, decode_timedelta=False, **open_kwargs) for fpath in filepaths]
+    # ds = xr.concat(list_ds, dim="time")
+    ds = xr.open_mfdataset(
+        filepaths,
+        engine="netcdf4",
+        combine="nested",  # 'by_coords',
+        concat_dim="time",
+        decode_timedelta=False,
+        parallel=parallel,
+        **open_kwargs,
+    )
     return ds