Skip to content

Commit

Permalink
augmenting download docs
Browse files Browse the repository at this point in the history
  • Loading branch information
durack1 committed Dec 19, 2024
1 parent 7d3ccd1 commit 505335b
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 6 deletions.
18 changes: 15 additions & 3 deletions docs/usage-data-user/downloading.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Here we provide some examples of how to download data.
They are not meant to be exhaustive, but they may help.

## esgpull
## esgpull - commandline ESGF download software

It is possible to download datasets using [esgpull](https://esgf.github.io/esgf-download/).
The installation instructions are [here](https://esgf.github.io/esgf-download/installation/).
Expand Down Expand Up @@ -47,7 +47,7 @@ esgpull download --tag ${SEARCH_TAG}
```

If you want to only download data of a specific type,
you can do that oo.
you can do that too.
For example, to only download global-, annual-mean greenhouse gas concentrations,
you can add the below.

Expand All @@ -73,4 +73,16 @@ For example, which grids and frequencies are available and what to use for the p

## Directly from ESGF

<!-- I have no idea what guidance is, I only use the GUI, Paul? -->
The ESGF MetaGrid search interface (see [https://aims2.llnl.gov/search/input4MIPs]())
provides direct access to the ESGF-hosted datasets. This allows searching via
search facets, e.g., `MIP Era`, `Target MIP List` (e.g. "CMIP" is the CMIP DECK activity, "ScenarioMIP", etc),
`Institution ID`, `Source ID`, and numerous other facets.

You can direct download, if you browse down to file level, or select a `wget` script
which will download via the commandline - and will select all available files that
comprise a dataset (a collection of files for a single variable, source_id pair).

By default, only the latest (non-deprecated, non-errata) data are listed in a search. In addition,
you can also limit your search to a local ESGF node, so `aims3.llnl.gov` or `esgf-data2.llnl.gov`
in West Coast USA, or `esgf1.dkrz.de` in Hamburg, Germany. We are expecting more ESGF
nodes to begin replicating these data as the project matures.
31 changes: 28 additions & 3 deletions docs/usage-data-user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ An overview of these is given in the
[database views homepage](../database-views/index.md).
Here we provide some more targeted guidance for users of the data.

[^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.
[^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, and early in 2025 toward the final datasets for CMIP7 usage.
[^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.

If you want to know about the latest status of each dataset,
Expand All @@ -38,7 +38,7 @@ This page provides, for each forcing dataset:
this is provided as a hyperlink on the forcing dataset's name
(see the `Forcing dataset` column),
i.e. if you can click on the forcing dataset's name,
it will take you to that forcing dataset's home page.
it will take you to that forcing dataset's home page, where ever that is.

### How can I get more information about each dataset?

Expand All @@ -64,7 +64,32 @@ to get information at the level of individual datasets (generally, variable-leve
and [the file level view](../database-views/input4MIPs_files_CMIP6Plus.html)
to get information at the level of individual files (unlikely to be of use in the majority of cases).

## CVs
### How can I provide feedback on an existing dataset?

We welcome comments and feedback on existing datasets, such analysis and review will uncover issues
that we are yet to identify, and once we know about an issue, it is far more likely it will get
attention and a resolution (and a shiny new dataset) will likely be generated to solve the issue.

To open a new issue, browse to the [input4MIPs_CVs issue page](https://github.com/PCMDI/input4MIPs_CVs/issues)
and open a new issue, preferably with a descriptive title that identifies the problem dataset by `source_id`
(e.g., PCMDI-AMIP-1-1-9). Alternatively, you can open a discussion [input4MIPs discussion page](https://github.com/PCMDI/input4MIPs_CVs/discussions)
to connect with the data providers, and other users about usage questions or other topics that don't warrant
an `issue` to be raised, yet - we can always convert a discussion to an issue if required.

To-date, we have already identified issues, and resolved problems with earlier versions of data,
and these previously existing issues are briefly described on the [input4MIPs source_id view](https://input4mips-controlled-vocabularies-cvs.readthedocs.io/en/latest/database-views/input4MIPs_source-id_CMIP6Plus.html)
search for `retracted` (top right hand search box), or some other criteria that caught issues
before data was made available on ESGF.

### How can I get informed when new data is published or errors with the data are identified?

You can "subscribe" to get notified of changes to content presented in this input4MIPs_CVs repository.
On the [homepage](https://github.com/PCMDI/input4MIPs_CVs/), there is a button titled "Watch", this
enables you to control the granularity of your notifications regarding changes to the repository
content. If you want more information, take a peek at the [Configuring Notifications](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications)
page on GitHub.

## input4MIPs Controlled Vocabularies (CVs)

It is unlikely that you will need to use the CVs directly,
although they may be helpful for understanding what the different terms mean
Expand Down

0 comments on commit 505335b

Please sign in to comment.