Materials-Consortia / OPTIMADE

Specification of a common REST API for access to materials databases
https://optimade.org/specification
Creative Commons Attribution 4.0 International
83 stars 37 forks source link

Calculation entry standardization #24

Open rartino opened 6 years ago

rartino commented 6 years ago

We need to standardize mandatory and optional the fields in the calculation entry type.

rartino commented 6 years ago

Here is an attempt at a concrete suggestion:

{
  ... <other response items> ...
  "data": [
    {
      "type": "calculation",
      "id": "example.db:calcs:0001",
      "attributes": {
        "local_id": "example.db:calcs:0001",
        "url": "http://example.db/calcs/0001",
        "immutable_id": "http://example.db/calcs/0001@123",
        "last_modified": "2007-04-05T14:30Z",
        "calculation_description": "relaxation",
        "related_structures_descriptions": ["initial", "final"],
        "related_structure_ids": ["example.db:struct:0042", "example.db:struct:4711"], 
        "workflow_id": "exmpl:relax:42"
      }
    }
  ]
}

Note the inclusion of the "workflow_id", in relation to the discussion in issue #30.

rartino commented 6 years ago

It was said during the discussion that this probably cannot be decided without another meeting.

kxyyang commented 6 years ago

Should we think about how we make a query ? For example, if I want to get the data of BAND GAP, should we enter the keyword "band_gap" , or " BandGap" , or "BGap", ... etc. Is it discussed somewhere else ? Or we have already had the specification formulated ?

rartino commented 6 years ago

Looking at other parts of the specification, e.g., #23, makes it seem likely to become band_gap over the other alternatives you suggest. But, we presently have no agreement of a common definition of band_bap. I suspect we will go down the road of, e.g., band_gap_kohn_sham, band_gap_optical, band_gap_fermi_liquid_quasiparticle, etc. But I expect that we'll need a discussion in a meeting to sort this out.