Remove data

[znichollscr]

Removes data associated with #16 to avoid confusion

@wolfiex also over to you

[wolfiex]

@ltroussellier Can you produce an explicit mapping to show us what is currently in ESGVOC before these are deleted.

[wolfiex]

Similarly I cannot remove Organisations until a relevant process of registration and a request-able (fetch) interface has been provided.

Requirements:

• full individual data based on a path. https://simpleurl.ext/organisations/<name> no special characters, query parameters or hashes
• complete list of all expanded organisation entries.
• forms for users to register a new one
• new registrations need to appear relatively quickly in the API, what is the turnaround time?
• pull request with an update to emd documentation and guidance pages for all relevant sections outlining this.

@CMIP-IPO @ltroussellier

[ltroussellier]

full individual data based on a path. https://simpleurl.ext/organisations/ no special characters, query parameters or hashes

either :

• esgvoc.ipsl.fr/api/v1/projects/{project_id}/collections/{collection_id}/terms/{term_id}
  or
• esgvoc.ipsl.fr/ressource/cmip7/institution/{term_id}

complete list of all expanded organisation entries.

• esgvoc.ipsl.fr/api/v1/projects/{project_id}/collections/{collection_id}/terms

forms for users to register a new one

https://github.com/WCRP-CMIP/CMIP7-CVs/issues/new?template=register-institution.yml

new registrations need to appear relatively quickly in the API, what is the turnaround time?

24h top

pull request with an update to emd documentation and guidance pages for all relevant sections outlining this.

WCRP-CMIP/cmip7-guidance#195

[wolfiex]

Have you tested this?

No ROR processing, was there a decision to remove the linking to the research organisation repository.
Do you have a method for handling when an institution changes name?
How does this affect citations?

Any structure on how to describe an institution. Advice on DRS name (also maybe tell people what DRS is). There was a document somewhere I believe.

Changes also need to be made in the EMD documentation.

[ltroussellier]

Ah found it : its not ressource, it is resource

https://esgvoc.ipsl.fr/resource/cmip7/institution/ipsl

[znichollscr]

@wolfiex I see that you already saw this in WCRP-CMIP/Essential-Model-Documentation#596, but just in case, the below seems to do sensible things for me

$ curl -f https://esgvoc.ipsl.fr/api/v1/projects/cmip7/collections/institution/terms
[{"id":"dmi","type":"organisation","description":"DMI","drs_name":"DMI","members":[{"id":"dmi","type":"institution","description":"Danish Meteorological Institute","drs_name":"DMI","acronyms":["DMI"],"labels":["Danish Meteorological Institute","Danmarks Meteorologiske Institut","National Danish Meteorological Institute","The National Danish Meteorological Institute"],"location":[{"city":"Copenhagen","country":"Denmark",...

# You can obviously then process however you want, e.g.
$ curl -s 'https://esgvoc.ipsl.fr/api/v1/projects/cmip7/collections/institution/terms' | jq '[.[].drs_name]'
[
  "DMI",
  "DWD",
  "CAS",
  "NOAA-GFDL",
  "CCCma",
  "IPSL",
  "BNU",
  "KNMI",
  "UNSW",
  "MOHC",
  "FMI",
  "EC-Earth-Consortium",
  "MPI-M",
  "NCAS",
  "METNo",
  "SMHI",
  "NERC",
  "SYSU",
  "CNRM-CERFACS",
  "BAS",
  "CNRM"
]

$ curl -s 'https://esgvoc.ipsl.fr/api/v1/projects/cmip7/collections/institution/terms' | jq '[.[] | {drs_name, id, members: [.members[] | {names: .labels, description, ror}]}]'
[
  {
    "drs_name": "DMI",
    "id": "dmi",
    "members": [
      {
        "names": [
          "Danish Meteorological Institute",
          "Danmarks Meteorologiske Institut",
          "National Danish Meteorological Institute",
          "The National Danish Meteorological Institute"
        ],
        "description": "Danish Meteorological Institute",
        "ror": "020m6x732"
      }
    ]
  },
  {
    "drs_name": "DWD",
    "id": "dwd",
    "members": [
      {
        "names": [
          "Deutscher Wetterdienst",
          "German Meteorological Service"
        ],
        "description": "German Meteorological Service (Deutscher Wetterdienst)",
        "ror": "02nrqs528"
      }
    ]
  },
  {
    "drs_name": "CAS",
    "id": "cas",
    "members": [
      {
        "names": [
          "Chinese Academy of Sciences",
          "中国科学院"
        ],
        "description": "Chinese Academy of Sciences",
        "ror": "034t30j35"
      }
    ]
  },
  {
    "drs_name": "NOAA-GFDL",
    "id": "noaa-gfdl",
    "members": [
      {
        "names": [
          "Department of Commerce Geophysical Fluid Dynamics Laboratory",
          "Geophysical Fluid Dynamics Laboratory",
          "NOAA Geophysical Fluid Dynamics Laboratory",
          "National Oceanic and Atmospheric Administration Geophysical Fluid Dynamics Laboratory",
          "Princeton University Geophysical Fluid Dynamics Laboratory",
          "U.S. Department of Commerce Geophysical Fluid Dynamics Laboratory",
          "U.S. Geophysical Fluid Dynamics Laboratory",
          "U.S. National Oceanic and Atmospheric Administration Geophysical Fluid Dynamics Laboratory",
          "United States Department of Commerce Geophysical Fluid Dynamics Laboratory",
          "United States Geophysical Fluid Dynamics Laboratory",
          "United States National Oceanic and Atmospheric Administration Geophysical Fluid Dynamics Laboratory"
        ],
        "description": "US National Oceanic and Atmospheric Administration's Geophysical Fluid Dynamics Laboratory.",
        "ror": "03vmn1898"
      }
    ]
  },
  {
    "drs_name": "CCCma",
    "id": "cccma",
    "members": [
      {
        "names": [
          "Environment and Climate Change Canada"
        ],
        "description": "Environment and Climate Change Canada",
        "ror": "026ny0e17"
      }
    ]
  },
  {
    "drs_name": "IPSL",
    "id": "ipsl",
    "members": [
      {
        "names": [
          "Institut Pierre-Simon Laplace"
        ],
        "description": "Institut Pierre-Simon Laplace",
        "ror": "02haar591"
      }
    ]
  },
...

[znichollscr]

@ltroussellier what is the equivalent API endpoint is for the universe entries (which is what you'll need if people want to link up to things like PIK which are registered 'institution members' but not 'institutions' (this will be even more confusing because institution members are under 'institutions' in the universe because organisations is the 'top-level' key in the universe))

[ltroussellier]

curl -X 'GET' \
  'https://esgvoc.ipsl.fr/api/v1/universe/data_descriptors/institution/terms' \
  -H 'accept: application/json'

with the template
https://esgvoc.ipsl.fr/api/v1/universe/data_descriptors/<data descriptor>/terms'

But basically, I'd say that if someone wants to "link an institution" somewhere (for example, in a paper), the meaning of that reference would probably be: "in the context of CMIP7, this entity..."

Therefore, my suggestion would be to include it in the CMIP7 institution collection.

I'll try to write something up about these different scenarios, as it's not entirely clear what users actually want to reference and at what level of detail. I'm mainly thinking about cases where changes occur over time—for example, changes to an institution's name, ROR, or other identifying information.

[znichollscr]

The alternative (maybe a good idea, maybe a terrible one) is @wolfiex you tell us how you want this to work, then we tell you how far away what we have is from that, and we decide what to prioritise and what to let wait.