Skip to content

Commit 894c895

Browse files
authored
Reorganize Readme
1 parent dc3b662 commit 894c895

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,21 @@ This repository contains scripts to download, preprocess, standardize, and conso
33
## Environment:
44
The environment is the one used in the c3s-atlas user tools: https://github.com/ecmwf-projects/c3s-atlas/blob/main/environment.yml
55

6-
## Directory Structure
6+
## Contents
7+
8+
| Directory | Contents |
9+
| :-------- | :------- |
10+
| [requests](https://github.com/SantanderMetGroup/c3s-cds/tree/main/requests) | Contains one CSV file per CDS catalogue, listing the requested variables, temporal resolution, interpolation method, the target save directory, and whether the variable is raw or requires post-processing to be standardized.
11+
| [provenance](https://github.com/SantanderMetGroup/c3s-cds/tree/main/provenance) | Contains one JSON file per catalogue describing the provenance and definitions of each variable.
12+
| [scripts/download](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/download) | Python scripts to download data from the CDS.
13+
| [scripts/standardization](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/standardization) | Python recipes to standardize the variables.
14+
| [scripts/derived](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/derived) | Python recipes to calculate derived products from the variables.
15+
| [scripts/interpolation](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/interpolation) | Python recipes to interpolate data.
16+
| [scripts/catalogue](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/catalogue) | Python recipes to produce the catalogues of downloaded data.
17+
| [catalogues](https://github.com/SantanderMetGroup/c3s-cds/tree/main/catalogues) | CSV catalogues of datasets consolidated in Lustre or GPFS. The catalogues are updated through a nightly CI job.
18+
19+
20+
## Downloaded data directory Structure
721

822
The repository uses a structured directory path format to organize downloaded, derived, and interpolated data:
923

@@ -42,17 +56,3 @@ The script reads all CSV files in the `requests/` directory and creates the dire
4256
`{base_path}/{product_type}/{dataset}/{temporal_resolution}/{interpolation}/{variable}/`
4357

4458

45-
## Contents
46-
47-
| Directory | Contents |
48-
| :-------- | :------- |
49-
| [requests](https://github.com/SantanderMetGroup/c3s-cds/tree/main/requests) | Contains one CSV file per CDS catalogue, listing the requested variables, temporal resolution, interpolation method, the target save directory, and whether the variable is raw or requires post-processing to be standardized.
50-
| [provenance](https://github.com/SantanderMetGroup/c3s-cds/tree/main/provenance) | Contains one JSON file per catalogue describing the provenance and definitions of each variable.
51-
| [scripts/download](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/download) | Python scripts to download data from the CDS.
52-
| [scripts/standardization](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/standardization) | Python recipes to standardize the variables.
53-
| [scripts/derived](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/derived) | Python recipes to calculate derived products from the variables.
54-
| [scripts/interpolation](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/interpolation) | Python recipes to interpolate data.
55-
| [scripts/catalogue](https://github.com/SantanderMetGroup/c3s-cds/tree/main/scripts/catalogue) | Python recipes to produce the catalogues of downloaded data.
56-
| [catalogues](https://github.com/SantanderMetGroup/c3s-cds/tree/main/catalogues) | CSV catalogues of datasets consolidated in Lustre or GPFS. The catalogues are updated through a nightly CI job.
57-
58-

0 commit comments

Comments
 (0)