diff --git a/README.md b/README.md index 16a7d4b0..33d8f0b7 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ the preprocessing, analysis and visualization of disdrometer data. The software enable to: - download the raw disdrometer data from stations included in the DISDRODB Decentralized Data Archive - + - upload raw data of new disdrometer stations to the DISDRODB Decentralized Data Archive - read the raw measurements of more than 400 disdrometer stations and convert them into a standard NetCDF format (DISDRODB L0 product) @@ -87,7 +87,7 @@ To download all data stored into the DISDRODB Decentralized Data Archive, you ju ``` -If you aims to download data from a specific data source (i.e. EPFL), type: +If you aims to download data from a specific data source (i.e. EPFL), type: ```bash @@ -95,7 +95,7 @@ If you aims to download data from a specific data source (i.e. EPFL), type: ``` -Type `disdrodb_download_archive --help` to see further options. +Type `disdrodb_download_archive --help` to see further options. ### 💫 Transform the raw data to standardized netCDF files. @@ -107,16 +107,16 @@ If you want to convert all stations raw data into standardized netCDF4 files, ru ``` -Type `disdrodb_run_l0 --help` to see further options. +Type `disdrodb_run_l0 --help` to see further options. ### 📖 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/](https://disdrodb.readthedocs.io/en/latest/). -### 🗄️ Explore the DISDRODB Metadata Archive +### 🗄️ Explore the DISDRODB Metadata Archive -The DISDRODB Metadata Archive collecting and tracking information of the available DISDRODB stations +The DISDRODB Metadata Archive collecting and tracking information of the available DISDRODB stations is hosted on GitHub at [https://github.com/ltelab/disdrodb-data](https://github.com/ltelab/disdrodb-data) ## 🛠️ Installation diff --git a/docs/source/index.rst b/docs/source/index.rst index 9295130b..7611833e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -28,9 +28,9 @@ However, only a small fraction of those data is easily accessible. Data are stored in disparate formats with poor documentation, making them difficult to share, analyse, compare and reuse. Additionally, very limited software exists or is publicly available for DSD processing. -In response to these challenges, the disdrodb Python package provides a +In response to these challenges, the disdrodb Python package provides a set of tools to download, process and archive disdrometer data -following the best open science practices. +following the best open science practices. The goal of the DISDRODB initiative is to: @@ -39,7 +39,7 @@ The goal of the DISDRODB initiative is to: - document the available data and the type of disdrometer sensors - provide a common framework to process disdrometer data - develop a set of scientific products to study the DSD variability at various spatio-temporal scales -- create a commmunity to develop, share and improve algorithms +- create a community to develop, share and improve algorithms Software @@ -52,10 +52,10 @@ The software currently enable to: - read the raw measurements and convert more than 400 disdrometer stations into a standard NetCDF format (DISDRODB L0 product) The disdrodb software is able to process data from various disdrometer sensors and manufacturers, and is designed to be easily extended to new ones. -Currently, disdrodb enables to process data acquired from: +Currently, disdrodb enables to process data acquired from: - the OTT Parsivel (``OTT_Parsivel``), -- the OTT Parsivel2 (``OTT_Parsivel2``), +- the OTT Parsivel2 (``OTT_Parsivel2``), - the Thies Laser Precipitation Monitor (``Thies_LPM``), - the RD-80 (``RD_80``) disdrometer. @@ -68,15 +68,15 @@ The data are stored in remote data repositories, and are easily accessible throu The metadata of each stations are stored in a `centralized repository hosted on GitHub `__. -The available disdrometer stations are depicted in the figure below. +The available disdrometer stations are depicted in the figure below. .. image:: /static/map_stations.png :width: 100% :alt: Location of the disdrometer stations included in the DISDRODB Decentralized Data Archive :align: center - -Community + +Community =========== The DISDRODB Working Group is a open community of scientists and engineers interested in advancing the DISDRODB initiative. @@ -90,7 +90,7 @@ and we would absolutely love for you to be part of this collaborative project. If you are eager to contribute or simply curious about what we do, please do not hesitate to reach out. Feel warmly invited to join the `DISDRODB Slack Workspace `__ -and say hi ! +and say hi ! Documentation diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 9be8885f..62dfa60d 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -17,18 +17,18 @@ We recommend users and contributors to first set up a `Virtual Environment <#vir Virtual Environment Creation =============================== -While not mandatory, utilizing a virtual environment when installing DISDRODB is recommended. +While not mandatory, utilizing a virtual environment when installing DISDRODB is recommended. Using a virtual environment for installing packages provides isolation of dependencies, easier package management, easier maintenance, improved security, and improved development workflow. -Here below we provide two options to set up a virtual environment, -using `venv `__ +Here below we provide two options to set up a virtual environment, +using `venv `__ or `conda `__ (recommended). **With conda:** -* Install `miniconda `__ +* Install `miniconda `__ or `anaconda `__ if you don't have it already installed. @@ -66,7 +66,7 @@ or `conda `__ (recommended). Installation for standard users ================================== -The latest disdrodb stable version is available +The latest disdrodb stable version is available on the `Python Packaging Index (PyPI) `__ and on the `conda-forge channel `__. @@ -100,7 +100,7 @@ Here below we provide the steps to install the package in editable mode. Clone the repository from GitHub ...................................... -According to the `contributors guidelines `__, +According to the `contributors guidelines `__, you should first `create a fork into your personal GitHub account __`.