Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #12

Merged
merged 1 commit into from
Nov 5, 2023
Merged

Update README.md #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 15 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# DISDRODB Metadata Repository
# Welcome to the DISDRODB Metadata Archive

**Main project repository** : [GitHub - ltelab/disdrodb](https://github.com/ltelab/disdrodb)

This repository contains the disdrodb **folder structure**, **metadata** and **links** to download the raw disdrometer measurements.
This repository contains the DISDRODB Metadata Archive: **metadata** and **urls** to download raw disdrometer measurements from the DISDRODB Decentralized Data Archive.

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.

DISDRODB standards are being established following FAIR data best practices and Climate & Forecast (CF) conventions, and will facilitate the preprocessing, analysis and visualization of disdrometer data.


## Folders structure
## Directory structure

The folder structure is composed of many `<DATA_SOURCE>` (i.e. "EPFL") that contain one or many `<CAMPAIGN_NAME>`(`i.e. "HYMEX_LTE_SOP3").
The directory structure is composed of many `<DATA_SOURCE>` (i.e. `EPFL`) that contain one or many `<CAMPAIGN_NAME>`(i.e. `HYMEX_LTE_SOP3`).
Every campaign has one or many stations.

```
Expand All @@ -20,25 +19,22 @@ Every campaign has one or many stations.
      ├── 📁 <DATA_SOURCE>
          ├── 📁 <CAMPAIGN_NAME>
              ├── 📁 issue
                  ├── 📜 station_name_1.yml
                  ├── 📜 station_name_2.yml
                  ├── 📜 <station_name_1>.yml
                  ├── 📜 <station_name_2>.yml
              ├── 📁 metadata
                  ├── 📜 station_name_1.yml
                  ├── 📜 station_name_2.yml  
├── 📁 data
                  ├── 📁 station_name_1
                  ├── 📁 station_name_2 
                  ├── 📜 <station_name_1>.yml
                  ├── 📜 <station_name_2>.yml  
```

For each folder in the `/data` directory (for each station) there must be an equally named `<station_name>.yml` file in the `/metadata` directory.

The **metadata YAML** file contains relevant information of the station (e.g. type of device, position, …) which are required for the correct processing and integration into the DISDRODB archive.
Each **metadata YAML** file contains relevant information of the station (e.g. type of device, position, disdrodb reader, disdrodb data url, …) which is required for the correct integration and processing into DISDRODB.

Each **issue YAML** file reports timesteps or time periods with instrument malfunctioning and measurements errors that must be discarded when processing the data.

## How to download or contribute to the project with your own data ?
## Frequently Asked Questions (FAQs)

* [How to Update DISDRODB Metadata?](https://disdrodb.readthedocs.io/en/latest/metadata_archive.html)
* [How to Contribute New Data to DISDRODB?](https://disdrodb.readthedocs.io/en/latest/contribute_data.html)
* [How to Download DISDRODB data?](https://disdrodb.readthedocs.io/en/latest/data_download.html)
* [What are the DISDRODB Contributing Guidelines](https://disdrodb.readthedocs.io/en/latest/contributors_guidelines.html)

Please refer to official documentation :
* [DISDRODB - Contributing guide](https://disdrodb.readthedocs.io/en/latest/contributors_guidelines.html)
* [DISDRODB - Data](https://disdrodb.readthedocs.io/en/latest/data.html)