Improve documentation

ltelab · Oct 31, 2023 · 768431a · 768431a
1 parent 9ed083d
commit 768431a
Show file tree

Hide file tree

Showing 9 changed files with 940 additions and 862 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
diff --git a/README.md b/README.md
@@ -1,13 +1,113 @@
 # DISDRODB - A package to standardize, process and analyze global disdrometer data.
 
-[![DOI](https://zenodo.org/badge/429018433.svg)](https://zenodo.org/badge/latestdoi/429018433)
-[![PyPI version](https://badge.fury.io/py/disdrodb.svg)](https://badge.fury.io/py/disdrodb)
-[![Conda Version](https://img.shields.io/conda/vn/conda-forge/disdrodb.svg)](https://anaconda.org/conda-forge/disdrodb)
-[![Tests](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml/badge.svg)](https://github.com/ltelab/disdrodb/actions/workflows/tests.yml)
-[![Coverage Status](https://coveralls.io/repos/github/ltelab/disdrodb/badge.svg?branch=main)](https://coveralls.io/github/ltelab/disdrodb?branch=main)
-[![Documentation Status](https://readthedocs.org/projects/disdrodb/badge/?version=latest)](https://disdrodb.readthedocs.io/en/latest/)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-[![License](https://img.shields.io/github/license/ltelab/disdrodb)](https://github.com/ltelab/disdrodb/blob/master/LICENSE)
+
+.. |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
+
+# TODO PYTHON VERSIONS
+[![image](https://img.shields.io/pypi/pyversions/ruff.svg)](https://pypi.python.org/pypi/ruff)
+.. |python| image:: https://img.shields.io/badge/python-3.8+-blue.svg
+   :target: https://www.python.org/downloads/
+
+.. |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.aaakk.us.kg-ltelab-disdrodb-main
+
+.. |licence| image:: https://img.shields.io/github/license/ltelab/disdrodb
+   :target: https://github.com/ltelab/disdrodb/blob/main/LICENSE
+
+# TODO slack link and badge
+.. |slack| image:: https://img.shields.io/badge/Slack-disdrodb-green.svg?logo=slack
+   :target: http://slack.disdrodb.org
+
+.. |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
+
+# TODO badge
+.. |codespell| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
+  :target: https://github.com/codespell-project/codespell
+  :alt: codespell
+
+.. |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|                       |
++----------------------+---------------------------------------------+
+| Code Coverage        | |coverall| |codecov|                        |
++----------------------+---------------------------------------------+
+| Code Quality         |codefactor| |codebeat|                       |
+|                      +---------------------------------------------+
+|                      | |codacy| |codescene|                        |
++----------------------+---------------------------------------------+
+| Linting              | |black|  |ruff|  |codespell|                |
++----------------------+---------------------------------------------+
+| License              | |licence|                                   |
++----------------------+------------------------+--------------------+
+| Community            | |slack|                | |discussion|       |
++----------------------+------------------------+--------------------+
+| Citation             | |joss|                 | |DOI|              |
++----------------------+------------------------+--------------------+
+
+ [**Slack**](http://slack.disdrodb.org) | [**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.

diff --git a/docs/source/data.rst b/docs/source/data.rst
@@ -28,10 +28,12 @@ Data transfer upload and download schema:
 
 .. image:: /static/transfer.png
 
+
 Download the DISDRODB metadata archive
 -----------------------------------------
 
-You can clone the disdrodb-data repository with:
+First travel to the directory where you want to store the data.
+Then clone the disdrodb-data repository with:
 
 .. code:: bash
 
@@ -79,11 +81,8 @@ follow these steps:
 Download the DISDRODB raw data archive
 ---------------------------------------
 
-Prerequisite: First clone the disdrodb-data repository as described
-above to get the folder structure, metadatas and issues.
-
-Objective: You would like to download the raw data referenced in some metadata
-``<station_name>.yml`` file.
+Prerequisite: First clone the disdrodb-data repository as described above to get the DISDRODB directory structure.
+Objective: You would like to download the raw data referenced in some metadata ``<station_name>.yml`` file.
 
 In order to download the data, you should be in a virtual environment with the disdrodb package installed!
 
@@ -113,8 +112,7 @@ the data sources or campaigns you require. For example, ``"EPFL NASA"``.
 Add new stations raw data to the DISDRODB archive (using Zenodo)
 -----------------------------------------------------------------
 
-We provide users with a code to upload their station’s raw data to
-Zenodo.
+We provide users with a code to upload their station’s raw data to `Zenodo <https://zenodo.org/>`_.
 
 .. code:: bash