Skip to content

Commit

Permalink
Fix lint and spelling errors
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiggi committed Jan 18, 2024
1 parent b78a471 commit f029af2
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -87,15 +87,15 @@ 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

disdrodb_download_archive --data-sources EPFL

```

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.

Expand All @@ -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
Expand Down
18 changes: 9 additions & 9 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand All @@ -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.

Expand All @@ -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 <https://github.com/ltelab/disdrodb-data>`__.

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.
Expand All @@ -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 <https://join.slack.com/t/disdrodbworkspace/shared_invite/zt-25l4mvgo7-cfBdXalzlWGd4Pt7H~FqoA>`__
and say hi !
and say hi !


Documentation
Expand Down
12 changes: 6 additions & 6 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.python.org/3/library/venv.html>`__
Here below we provide two options to set up a virtual environment,
using `venv <https://docs.python.org/3/library/venv.html>`__
or `conda <https://docs.conda.io/en/latest/>`__ (recommended).

**With conda:**

* Install `miniconda <https://docs.conda.io/en/latest/miniconda.html>`__
* Install `miniconda <https://docs.conda.io/en/latest/miniconda.html>`__
or `anaconda <https://docs.anaconda.com/anaconda/install/>`__
if you don't have it already installed.

Expand Down Expand Up @@ -66,7 +66,7 @@ or `conda <https://docs.conda.io/en/latest/>`__ (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) <https://pypi.org/project/disdrodb/>`__
and on the `conda-forge channel <https://anaconda.org/conda-forge/disdrodb>`__.

Expand Down Expand Up @@ -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 <https://disdrodb.readthedocs.io/en/latest/contributors_guidelines.html>`__,
According to the `contributors guidelines <https://disdrodb.readthedocs.io/en/latest/contributors_guidelines.html>`__,
you should first
`create a fork into your personal GitHub account <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo>__`.

Expand Down

0 comments on commit f029af2

Please sign in to comment.