Skip to content

Commit

Permalink
Merge branch 'emulators' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
jesusff authored Apr 15, 2024
2 parents 83aea80 + 14ab20c commit 424c7e7
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 34 deletions.
6 changes: 6 additions & 0 deletions CORDEX-CMIP6_product.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"product": {
"emulator-output": "Result of a statistical emulator of a numerical model",
"model-output": "Result of a numerical model simulation"
}
}
7 changes: 7 additions & 0 deletions CORDEX-CMIP6_required_global_attributes.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
"driving_institution_id",
"driving_source_id",
"driving_variant_label",
"emulator",
"emulator_id",
"frequency",
"grid",
"institution",
Expand All @@ -22,7 +24,12 @@
"source",
"source_id",
"source_type",
"target_institution_id",
"target_source_id",
"target_version_realization",
"tracking_id",
"training",
"training_id",
"variable_id",
"version_realization"
]
Expand Down
1 change: 1 addition & 0 deletions CORDEX-CMIP6_source_type.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"source_type": {
"RCM-emulator": "Statistical emulator of a regional climate model",
"ARCM": "atmospheric regional climate model, including a land model",
"AORCM": "atmosphere-ocean regional climate model",
"AGCM": "atmosphere global climate model including variable resolution",
Expand Down
37 changes: 3 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,5 @@
# CORDEX-CMIP6 CV
# I4C Controlled Vocabulary (CV) for use in archiving RCM-emulator results

**Controlled Vocabulary (CV) for use in CORDEX.**
This is a fork of the [CORDEX-CMIP6 CV](https://github.com/WCRP-CORDEX/cordex-cmip6-cv) to develop a new CV for RCM-emulator output data to be used in Impetus4Change.

This repository contains tables of controlled vocabulary for the *cmorization* of CORDEX datasets in the CMIP6 era. The actual [`CORDEX-CMIP6_CV.json`](https://github.com/WCRP-CORDEX/cordex-cmip6-cmor-tables/blob/main/Tables/CORDEX-CMIP6_CV.json) in the [cordex cmor table repository](https://github.com/WCRP-CORDEX/cordex-cmip6-cmor-tables) is created from a combination of all tables in this repository. There are two events that would trigger an update of the `CORDEX_CV.json` cmor table:

* a manual trigger of the [update-cv github action](https://github.com/WCRP-CORDEX/cordex-cv/actions/workflows/update-cv.yaml)
* a push event in this repo that updates one of the CV tables

The aim is to have the `CORDEX-CMIP6_CV.json` table updated when, e.g., a new RCM model is registered in the `source_id.json` table or a new `institution_id` is required.

## Registering Institutions, Models, or requesting changes to CVs:

To register your institution or model, please submit an issue using these forms:

* [New institution_id](https://github.com/WCRP-CORDEX/cordex-cmip6-cv/issues/new?assignees=&labels=Register+institution-id&projects=&template=institution_id.yaml&title=institution_id+registration+of+...)
* [New source_id (i.e. model)](https://github.com/WCRP-CORDEX/cordex-cmip6-cv/issues/new?assignees=&labels=Register+source-id&projects=&template=source_id.yaml&title=source_id+registration+of+...)

These forms will automatically create a pull request, where further details can be discussed.
Models must not be distinguished by the `institution_id`.
Do not register a new `source_id` if the same model or method configuration is already registered by other institution.
Just request to add your `institution_id` to the list of the corresponding `source_id`.

To request changes in any other CV use a [blank issue](https://github.com/WCRP-CORDEX/cordex-cmip6-cv/issues/new) with a meaningful title.
E.g. `source_type: add YOURNEWTYPE` or `source_id: update MODEL123A further_info_url`

To view current repository contents in HTML format, point your browser to:

| target | URL |
| :-- | :-- |
| `institution_id` | [CORDEX-CMIP6_institution_id.html](https://wcrp-cordex.github.io/cordex-cmip6-cv/CORDEX-CMIP6_institution_id.html) |
| `source_id` | [CORDEX-CMIP6_source_id.html](https://wcrp-cordex.github.io/cordex-cmip6-cv/CORDEX-CMIP6_source_id.html) |

The CVs build on logic that is described in the [CORDEX-CMIP6 Archiving Specifications for Dynamical Downscaling](https://doi.org/10.5281/zenodo.10961068) document.

The controlled vocabularies for CORDEX-CMIP6 will be augmented (e.g., as new `institution_id`s and `source_id`s are registered), but there should be no changes in the existing vocabulary that would impair searches of and access to already published data or that would in any way invalidate published data.
You can check differences with the base CORDEX-CMIP6 CV for dynamical downscaling [here](https://github.com/impetus4change/cordex-cmip6-cv/compare/main..emulators).

0 comments on commit 424c7e7

Please sign in to comment.