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.

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

Add Extended Description attribute to the Activity class #44

Open
charliepascoe opened this issue Nov 9, 2020 · 1 comment
Open

Add Extended Description attribute to the Activity class #44

charliepascoe opened this issue Nov 9, 2020 · 1 comment
Assignees
Labels
cimv2.x Would have implications for existing document instances cmip6 Practical relevance to CMIP6 enhancement

Comments

@charliepascoe
Copy link

The original purpose of the experiment documentation for CMIP6 was to provide modelling groups with a self contained resource to assist them with setting up simulations for CMIP6 and also to gather structured information from modelling groups about how their models were configured to run those simulations.

However, ES-DOC resources are also destined for use outside of the CMIP6 ecosystem e.g. in the Copernicus Climate Change Services (C3S) portal. In the C3S context the short-hand used in the experiment "description" and "rationale" fields are not sufficient to describe the CMIP6 experiments in a way that can be understood by non-expert users.

This proposal will add an optional "Extended Description" attribute to the activity class.
The Extended Description can be considered as something similar to an abstract. It will allow for a more complete description for experiments so that they can be understood by non experts and understood outside of the context of CMIP6 ecosystem. The attribute will be optional (0,1) to recognise that many of the experiments in MIP activities are likely to only be consumed by the modelling groups who contribute to the MIP.

@bnlawrence I'm at-ing you to keep you in the loop with this one.

@charliepascoe charliepascoe added enhancement cmip6 Practical relevance to CMIP6 cimv2.x Would have implications for existing document instances labels Nov 9, 2020
@davidhassell
Copy link
Contributor

This new property would be on activity.activity (https://github.com/ES-DOC/esdoc-cim-v2-schema/blob/master/activity_classes.py#L10)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cimv2.x Would have implications for existing document instances cmip6 Practical relevance to CMIP6 enhancement
Projects
None yet
Development

No branches or pull requests

3 participants