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

Enhancement: add option to output tracking_ids when output== file #37

Open
paolap opened this issue Sep 24, 2018 · 4 comments
Open

Enhancement: add option to output tracking_ids when output== file #37

paolap opened this issue Sep 24, 2018 · 4 comments

Comments

@paolap
Copy link
Member

paolap commented Sep 24, 2018

I've been asked to add this option so a user can create a list of all the tracking_ids has used to build a citation record. I'm not 100% sure that is required as for CMIP5, I would have thought using the citation provided in the file should be enough.
In any case I was thinking go adding a flag --citation which would print out the citation id and if the output is "file" also the tracking ids.
Another option, probably better( ?) is to have a --verbose flag which will output all the extra information in a csv file. The further_info_url which has es-doc url attribute can be reconstructed from the dataset_id.
Currently the find_local function returns only the path, if it could return the dataset_id we could add this easily.
If we want the all information the following global attributes need to be retrieved too. These are not available in the db tables.

variant_info (important)
source (important)
parent_experiment_id
further_info_url
contact (important)
title (potentially redundant)
description (potentially redundant)
license (could be retrieved from es-doc info)

@ScottWales
Copy link
Contributor

Also add tracking_id

@paolap
Copy link
Member Author

paolap commented Jun 20, 2019

further_info_url is currently a bit disappointing it just sends you to this page which rarely offer more than links that could be derived more easily by knowing the simulation attributes

As an example to ge the citation for CMIP6 you can simply use the DRS-id in this way:
https://cera-www.dkrz.de/WDCC/ui/cerasearch/cerarest/cmip6Citations?drsId=CMIP6.CMIP.CNRM-CERFACS.CNRM-CM6-1

This give you both a url_json fields which points to useful metadata:
http://cera-www.dkrz.de/WDCC/meta/CMIP6/CMIP6.CMIP.CNRM-CERFACS.CNRM-CM6-1.json
and to a "references" filed which has the citation field
Same information should be reachable using a python based api
https://swiftbrowser.dkrz.de/public/dkrz_11279a46963f4201bae564a253d528cc/Citation_API_Client/

tracking_id should work for both CMIP5 and CMIP6, it's an handle in CMIP6 so in theory from that we should be able to retrieve more information, it's not yet clear to me what a user can do with that currently

ES-DOC (documentation for a "model", "simulation", "experiment' etc) should be easy to get by building a url for : https://search.es-doc.org

@paolap
Copy link
Member Author

paolap commented Sep 23, 2019

I'm reviewing all this again, I started a new python file esdoc.py in clef/clef to build the documentation urls and retrieve the information based on user input.

Docs will be most likely inconsistent, for example:
About half of the documents (experiments, simulations, ensembles,...) automated (following ESGF publishing)
The remaining (model, conformance to protocol, forcings, responsible party,...) produced by
groups when ready – joined together via the “further_info_URL” attribute

So we have to keep this in mind!

@paolap
Copy link
Member Author

paolap commented Mar 23, 2021

We have now a citation option at least for CMIP6, and some more functionalities in esdoc.py.
Once the cordex release is ready I will try to get a list of these from the new view
info_attributes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants