Skip to content

Commit

Permalink
Slight rewrite of the proposal for calculation relationships with files.
Browse files Browse the repository at this point in the history
  • Loading branch information
merkys committed Jun 12, 2024
1 parent 9b034fc commit c58a77d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3533,12 +3533,12 @@ Calculations Entries
--------------------

The :entry:`calculations` entries have the properties described above in section `Properties Used by Multiple Entry Types`_.
Related :entry:`files` entries specified as relationships as described in section `Relationships`_ list files used or produced by a calculation.
They MAY be defined as either input or output files in the :field:`role` field inside the :field:`meta` dictionary of the JSON:API resource identifier object.
Related :entry:`files` entries specified as relationships (as described in section `Relationships`_) list files used or produced by a calculation.
They MAY be defined as either input or output files by the :field:`role` field inside the :field:`meta` dictionary of the JSON:API resource identifier object.
The allowed values are :val:`input` for input files and :val:`output` for output files.
Absence of :field:`role` or :val:`null` means that the role is undefined and SHOULD NOT be assumed.
It is RECOMMENDED to order the output files in the list of calculation's relationships in a way to prioritize the files most likely to contain details describing the performed calculation.
This way a piece of output parsing software would need to read in a small number of calculation output files to possibly identify the code and the type of calculation performed.
It is RECOMMENDED to order the output files in the list of calculation's relationships in a way to prioritize the files most likely to contain details which could be used to automatically analyze the performed calculation.
This way output parsing software would need to read in a small number of calculation output files to possibly identify the code, type and possibly parameters of calculation performed.

References Entries
------------------
Expand Down

0 comments on commit c58a77d

Please sign in to comment.