Update README.md table

ltelab · Nov 1, 2023 · 57d9329 · 57d9329
1 parent 14dd491
commit 57d9329
Showing 1 changed file with 25 additions and 120 deletions.
diff --git a/README.md b/README.md
@@ -1,115 +1,19 @@
 # 📦 DISDRODB - A package to standardize, process and analyze global disdrometer data.
-
-
-.. |pypi| image:: https://badge.fury.io/py/disdrodb.svg
-   :target: https://pypi.org/project/disdrodb/
-
-.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/disdrodb.svg?logo=conda-forge&logoColor=white
-   :target: https://anaconda.org/conda-forge/disdrodb
-
-.. |pypi_downloads| image:: https://img.shields.io/pypi/dm/disdrodb.svg?label=PyPI%20downloads
-   :target: https://pypi.org/project/disdrodb/
-
-.. |conda_downloads| image:: https://img.shields.io/conda/dn/conda-forge/disdrodb.svg?label=Conda%20downloads
-   :target: https://anaconda.org/conda-forge/disdrodb
-
-.. |versions| image:: https://img.shields.io/badge/Python-3.8%20|%203.9%20|%203.10%20|%203.11|%203.12-blue
-   :target: https://www.python.org/downloads/
-   :alt: Supported Python Versions
-
-.. |status| image:: https://www.repostatus.org/badges/latest/active.svg
-   :target: https://www.repostatus.org/#active
-
-.. |tests| image:: https://github.com/ltelab/disdrodb/actions/workflows/tests.yml/badge.svg
-   :target: https://github.com/ltelab/disdrodb/actions/workflows/tests.yml
-
-.. |lint| image:: https://github.com/ltelab/disdrodb/actions/workflows/lint.yml/badge.svg
-   :target: https://github.com/ltelab/disdrodb/actions/workflows/lint.yml
-
-.. |docs| image:: https://readthedocs.org/projects/disdrodb/badge/?version=latest
-   :target: https://disdrodb.readthedocs.io/en/latest/
-
-.. |coverall| image:: https://coveralls.io/repos/github/ltelab/disdrodb/badge.svg?branch=main
-   :target: https://coveralls.io/github/ltelab/disdrodb?branch=main
-
-.. |codecov| image:: https://codecov.io/gh/ltelab/disdrodb/branch/main/graph/badge.svg
-   :target: https://codecov.io/gh/ltelab/disdrodb
-
-.. |codacy| image:: https://app.codacy.com/project/badge/Grade/d823c50a7ad14268bd347b5aba384623
-   :target: https://app.codacy.com/gh/ltelab/disdrodb/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
-
-.. |codescene| image:: https://codescene.io/projects/36773/status-badges/code-health
-   :target: https://codescene.io/projects/36773
-
-.. |codefactor| image:: https://www.codefactor.io/repository/github/ltelab/disdrodb/badge
-   :target: https://www.codefactor.io/repository/github/ltelab/disdrodb
-
-.. |codebeat| image:: https://codebeat.co/badges/14ff831b-f064-4bdd-a2e2-72ffdf28a35a
-   :target: https://codebeat.co/projects/github-com-ltelab-disdrodb-main
-
-.. |licence| image:: https://img.shields.io/github/license/ltelab/disdrodb
-   :target: https://github.com/ltelab/disdrodb/blob/main/LICENSE
-
-.. |slack| image:: https://img.shields.io/badge/Slack-disdrodb-green.svg?logo=slack
-   :target: https://disdrodbworkspace.slack.com/
-
-.. |discussion| image:: https://img.shields.io/badge/GitHub-Discussions-green?logo=github
-   :target: https://github.com/ltelab/disdrodb/discussions
-
-.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
-   :target: https://github.com/astral-sh/ruff
-   :alt: ruff
-
-.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
-   :target: https://github.com/psf/black
-   :alt: black
-
-.. |codespell| image:: https://img.shields.io/badge/Codespell-enabled-brightgreen
-  :target: https://github.com/codespell-project/codespell
-  :alt: codespell
-
-.. |openssf| image:: https://www.bestpractices.dev/projects/XXXX/badge
-  :target: https://www.bestpractices.dev/projects/XXXX
-  :alt: OpenSSF Best Practices
-
-.. |pyopensci| image:: https://tinyurl.com/XXXX
-   :target: https://github.com/pyOpenSci/software-review/issues/XXX
-   :alt: pyOpenSci
-
-.. |joss| image:: http://joss.theoj.org/papers/<DOI>/joss.<DOI>/status.svg
-   :target: https://doi.org/
-
-.. |DOI| image:: https://zenodo.org/badge/429018433.svg
-   :target: https://zenodo.org/badge/latestdoi/429018433
-
-
-+----------------------+------------------------+--------------------+
-| Deployment           | |pypi|                 | |conda|            |
-+----------------------+------------------------+--------------------+
-| Activity             | |pypi_downloads|       | |conda_downloads|  |
-+----------------------+------------------------+--------------------+
-| Python versions      | |python|                                    |
-+----------------------+---------------------------------------------+
-| Project status       | |status|                                    |
-+----------------------+---------------------------------------------+
-| Build Status         | |tests| |lint| |docs|                       |
-+----------------------+---------------------------------------------+
-| Linting              | |black|  |ruff|  |codespell|                |
-+----------------------+---------------------------------------------+
-| Code Coverage        | |coverall| |codecov|                        |
-+----------------------+---------------------------------------------+
-| Code Quality         | |codefactor| |codebeat|                     |
-|                      +---------------------------------------------+
-|                      | |codacy| |codescene|                        |
-+----------------------+---------------------------------------------+
-| Code Review          | |pyopensci| |openssf|                       |
-+----------------------+---------------------------------------------+
-| License              | |licence|                                   |
-+----------------------+------------------------+--------------------+
-| Community            | |slack|                | |discussion|       |
-+----------------------+------------------------+--------------------+
-| Citation             | |joss|                 | |DOI|              |
-+----------------------+------------------------+--------------------+
+|                      |                                                |
+| -------------------- | ---------------------------------------------- |
+| Deployment           | ![PyPI](https://badge.fury.io/py/disdrodb.svg) ![Conda](https://img.shields.io/conda/vn/conda-forge/disdrodb.svg?logo=conda-forge&logoColor=white) |
+| Activity             | ![PyPI Downloads](https://img.shields.io/pypi/dm/disdrodb.svg?label=PyPI%20downloads) ![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/disdrodb.svg?label=Conda%20downloads) |
+| Python Versions      | ![Python Versions](https://img.shields.io/badge/Python-3.8%20%203.9%20%203.10%20%203.11%203.12-blue) | 
+| Supported Systems    | ![Linux](https://img.shields.io/github/actions/workflow/status/ltelab/disdrodb/.github/workflows/tests.yml?label=Linux) ![macOS](https://img.shields.io/github/actions/workflow/status/ltelab/disdrodb/.github/workflows/tests.yml?label=macOS) ![Windows](https://img.shields.io/github/actions/workflow/status/ltelab/disdrodb/.github/workflows/tests.yml?label=Windows) | 
+| Project Status       | ![Project Status](https://www.repostatus.org/badges/latest/active.svg) | 
+| Build Status         | ![Tests](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml/badge.svg) ![Lint](https://github.com/ltelab/disdrodb/actions/workflows/lint.yml/badge.svg) ![Docs](https://readthedocs.org/projects/disdrodb/badge/?version=latest) | 
+| Linting              | ![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat) ![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json) ![Codespell](https://img.shields.io/badge/Codespell-enabled-brightgreen) | 
+| Code Coverage        | ![Coveralls](https://coveralls.io/repos/github/ltelab/disdrodb/badge.svg?branch=main) ![Codecov](https://codecov.io/gh/ltelab/disdrodb/branch/main/graph/badge.svg) | 
+| Code Quality         | ![Codefactor](https://www.codefactor.io/repository/github/ltelab/disdrodb/badge) ![Codebeat](https://codebeat.co/badges/14ff831b-f064-4bdd-a2e2-72ffdf28a35a) | ![Codacy](https://app.codacy.com/project/badge/Grade/d823c50a7ad14268bd347b5aba384623) ![Codescene](https://codescene.io/projects/36773/status-badges/code-health) |
+| Code Review          | ![pyOpenSci](https://tinyurl.com/XXXX) ![OpenSSF Best Practices](https://www.bestpractices.dev/projects/XXXX/badge) |
+| License              | ![License](https://img.shields.io/github/license/ltelab/disdrodb) | 
+| Community            | ![Slack](https://img.shields.io/badge/Slack-disdrodb-green.svg?logo=slack) ![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-green?logo=github) | 
+| Citation             | ![JOSS](http://joss.theoj.org/papers/<DOI>/joss.<DOI>/status.svg) ![DOI](https://zenodo.org/badge/429018433.svg) | 
 
  [**Slack**](http://slack.disdrodb.org) | [**Docs**](https://disdrodb.readthedocs.io/en/latest/)
 
@@ -125,55 +29,56 @@ The software currently enable to:
 - 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. :
+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**](http://slack.disdrodb.org) to meet the DISDRODB Community !
 
 
 ## 🚀 Quick Start
 
-You're about to create your very own DISDRODB Data Archive. All it takes is a simple command-line journey to your chosen directory.
+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 with :code:`cd <your_desired_root_folder>`.
+Let's start by travel to the directory where you want to store the DISDRODB Data Archive with `cd <your_desired_root_folder>`.
 
 Then clone the DISDRODB Metadata Archive repository with:
 
-.. code:: bash
+```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 for ever the default DISDRODB Local Archive directory by running in python:
+You can specify once forever the default DISDRODB Local Archive directory by running in python:
 
 ```python
    import disdrodb
    disdrodb_dir = "<the_root_folder>/disdrodb-data/DISDRODB>"
    disdrodb.define_configs(disdrodb_dir=disdrodb_dir)
 ```
 
-or set up a (temporary) environment variable `DISDRODB_DIR` in your terminal with:
+or set up the (temporary) environment variable `DISDRODB_DIR` in your terminal with:
 
 ```bash
    export DISDRODB_DIR="<the_root_folder>/disdrodb-data/DISDRODB>"
 ```
 
-#### 📥 Download the raw data of the DISDRODB stations
+#### 📥 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
    download_disdrodb_archive
 ```
 
-#### 💫 Transform the raw data to standardized netCDF files (DISDRODB L0 product).
+#### 💫 Transform the raw data to standardized netCDF files.
 
-Then, if you want to convert all stations raw data into standardized netCDF4 files, run the following command in the terminal:
+If you want to convert all stations raw data into standardized netCDF4 files, run the following command in the terminal:
 
 ```bash