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

Introduce roles for files related to calculations #523

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3533,6 +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 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.
merkys marked this conversation as resolved.
Show resolved Hide resolved
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.
merkys marked this conversation as resolved.
Show resolved Hide resolved
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.
merkys marked this conversation as resolved.
Show resolved Hide resolved

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