Skip to content

Commit 697f62f

Browse files
committed
Start on download docs
1 parent 1158b77 commit 697f62f

File tree

4 files changed

+25
-8
lines changed

4 files changed

+25
-8
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
For:
66

77
- different, pre-prepared views of the database, see [database views](database-views/index.md)
8-
- usage as a data user, see [usage - data user](usage-data-user.md)
8+
- usage as a data user, see [usage - data user](usage-data-user/index.md)
99
- usage as a data producer, see [usage - data producer](usage-data-producer.md)
1010
- an overview of the repository, see [repository overview](repository-overview.md)
1111
- guidance on how to contribute to the repository, see [contributing](contributing.md)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Downloading data
2+
3+
Here we provide some examples of how to download data.
4+
They are not meant to be exhaustive, but they may help.
5+
6+
## esgpull
7+
8+
<!-- TODO: Zeb to write -->
9+
10+
- use the example of [https://github.com/climate-resource/CMIP6-vs-CMIP7-GHG-Concentrations]()
11+
which uses esgpull
12+
13+
## Directly from ESGF
14+
15+
<!-- I have no idea what guidance is, I only use the GUI, Paul? -->
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@ so please don't hesitate to ask.
1010
## The datasets
1111

1212
An overview of each dataset, with links to further information,
13-
can be found in [dataset overviews](dataset-overviews/index.md).
13+
can be found in [dataset overviews](../dataset-overviews/index.md).
1414

1515
## Navigating the database
1616

1717
The database tracks all of the files[^1] being managed in the input4MIPs project[^2].
1818
In general, as a user, you won't be interested in information at the level of individual files,
1919
hence we provide different views.
2020
An overview of these is given in the
21-
[database views homepage](database-views/index.md).
21+
[database views homepage](../database-views/index.md).
2222
Here we provide some more targeted guidance for users of the data.
2323

2424
[^1]: At the moment, just data from the 'CMIP6Plus' era, but we hope to expand this out to data from the CMIP6 era in future.
2525
[^2]: Yes, this does somewhat duplicate the point of the ESGF index, but the ESGF index isn't publically accessible/queriable and doesn't have all the information we want right now, so here we are.
2626

2727
If you want to know about the latest status of each dataset,
28-
have a look at [the delivery summary](database-views/input4MIPs_delivery-summary_CMIP6Plus.html).
28+
have a look at [the delivery summary](../database-views/input4MIPs_delivery-summary_CMIP6Plus.html).
2929
This page provides, for each forcing dataset:
3030

3131
- its current status (see the `Status` column)
@@ -44,7 +44,7 @@ This page provides, for each forcing dataset:
4444

4545
Beyond the overviews above, you can also use the different views of our database.
4646
If you are interested in the status of different versions of a particular dataset,
47-
then it is worth looking at [the source ID level view](database-views/input4MIPs_source-id_CMIP6Plus.html).
47+
then it is worth looking at [the source ID level view](../database-views/input4MIPs_source-id_CMIP6Plus.html).
4848
Within this view, the search bar can be used to filter just for the dataset you're interested in.
4949
Once this filtering is done, a few columns are particularly relevant:
5050

@@ -59,9 +59,9 @@ Once this filtering is done, a few columns are particularly relevant:
5959
(either because it was never been published or because it has been retracted post-publication).
6060

6161
If you wish to dive even further, you can use
62-
[the dataset level view](database-views/input4MIPs_datasets_CMIP6Plus.html)
62+
[the dataset level view](../database-views/input4MIPs_datasets_CMIP6Plus.html)
6363
to get information at the level of individual datasets (generally, variable-level)
64-
and [the file level view](database-views/input4MIPs_files_CMIP6Plus.html)
64+
and [the file level view](../database-views/input4MIPs_files_CMIP6Plus.html)
6565
to get information at the level of individual files (unlikely to be of use in the majority of cases).
6666

6767
## CVs

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ repo_url: https://github.com/PCMDI/input4MIPs_CVs
99
nav:
1010
- input4MIPs CVs: index.md
1111
- Usage:
12-
- As a data user: usage-data-user.md
12+
- As a data user:
13+
- Overview: usage-data-user/index.md
14+
- Downloading data: usage-data-user/downloading.md
1315
- As a data producer: usage-data-producer.md
1416
- Dataset overviews:
1517
- Summary: dataset-overviews/index.md

0 commit comments

Comments
 (0)