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

Add optimization_type property for structures #455

Open
wants to merge 35 commits into
base: develop
Choose a base branch
from
Open
Changes from 4 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
3665014
Add structure_origin to structures endpoint
rartino Feb 17, 2023
a7b7316
Improved formulations for structure_origin
rartino Feb 20, 2023
a8d77cf
Adjust terminology to use property rather than field
rartino Feb 20, 2023
8aedb8b
Apply suggestions from code review
rartino Feb 20, 2023
14c2825
Suggestions from review
rartino Feb 21, 2023
529a65c
Apply suggestions from review
rartino Feb 22, 2023
da4c43a
Edited categories and formulations for structure_orgin based on revie…
rartino Feb 22, 2023
27cde5f
Remove redundant line about null values in structure_origin
rartino Feb 22, 2023
7d93bc8
Merge branch 'develop' into structure_origin
rartino Mar 2, 2023
391629d
Update according to feedback in web meeting; remove constraint on con…
rartino Mar 17, 2023
4d6d65d
Update optimade.rst
rartino Mar 17, 2023
d7c9918
Replacing processed with derived in structure_origin
rartino Mar 17, 2023
e1c2b43
Apply suggestions from review
rartino Mar 20, 2023
55e20d1
Attempt at clarifying non-required status of "predicted"
rartino Mar 20, 2023
dc198a4
Slightly adjust wording
rartino Mar 20, 2023
43d9799
Slightly adjust wording
rartino Mar 20, 2023
a885700
Remove "extreme conditions" also in the overview and clarifiy that so…
rartino Mar 20, 2023
69a54f8
Remove another reference to extreme conditions
rartino Mar 20, 2023
6fbb752
Fix formatting error
rartino Mar 20, 2023
2ca16b4
Apply suggestions from review
rartino Mar 20, 2023
cfaceab
Remove trailing whitespace
rartino Mar 22, 2023
94e07a6
Add "indeterminate" classification
rartino Mar 22, 2023
5b96c6e
Minor grammar fix
rartino Mar 22, 2023
ef40f6e
Minor grammar fix
rartino Mar 22, 2023
7fadfc2
Minor grammar fix
rartino Mar 22, 2023
6994d2e
Fix formatting
rartino Mar 22, 2023
3e0bb62
Remove incorrect sentence about null-valued structure_origin
rartino Mar 22, 2023
bcc44fa
Complete rewrite based on review feedback
rartino Jan 10, 2024
74b459c
Minor language and grammar corrections
rartino Jan 10, 2024
0747f46
Remove trailing whitespace
rartino Jan 10, 2024
e4549fc
Merge branch 'develop' into structure_origin
rartino Jan 10, 2024
69fdc58
Remove whitespace
rartino Jan 10, 2024
4a0dcd5
Slight adjustment of a formulation
rartino Jan 10, 2024
0e324d3
Fix punctuation
rartino Jan 10, 2024
3d76751
Fix punctuation
rartino Jan 10, 2024
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
43 changes: 43 additions & 0 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2846,6 +2846,49 @@ structure\_features

- A structure having implicit atoms and using assemblies: :val:`["assemblies", "implicit_atoms"]`

structure\_origin
~~~~~~~~~~~~~~~~~

- **Description**: A string that describes aspects of the origin of the structural data to indicate if is based directly or indirectly on experimental evidence or inferred from other sources, giving some information on whether the structure is believed to exist in nature or can be synthesized as a compound stable at non-extreme conditions.
rartino marked this conversation as resolved.
Show resolved Hide resolved

- **Type**: string
- **Requirements/Conventions**:

- **Support**: OPTIONAL support in implementations, i.e., MAY be :val:`null`.
rartino marked this conversation as resolved.
Show resolved Hide resolved
- **Query**: Support for queries on this property is OPTIONAL.
If supported, filters MAY support only a subset of comparison operators.
rartino marked this conversation as resolved.
Show resolved Hide resolved
- SHOULD take one of the following values:

* :val:`experimental`: the structural information is based directly on the outcome of an experimental technique for structure determination which is represented without further processing.
rartino marked this conversation as resolved.
Show resolved Hide resolved

* :val:`processed`: the structural information originates from experimental data, but has undergone additional processing in such a way that the result is still recognizable as the experimental structure it was based on.
rartino marked this conversation as resolved.
Show resolved Hide resolved
For example, experimental structures relaxed using ab-initio calculations are meant to qualify for this category.
rartino marked this conversation as resolved.
Show resolved Hide resolved
Substituting one or more elements in a structure (while, e.g., keeping the experimental coordinates the same) are not meant to qualify for this category.
rartino marked this conversation as resolved.
Show resolved Hide resolved
The category definition involves a degree of subjectivity that has to be decided by the database provider.

* :val:`predicted`: the structural information is not directly related to the outcome of an experimental technique on an existing material, but has undergone theoretical processing to suggest it as a candidate for a synthesizable structure.
rartino marked this conversation as resolved.
Show resolved Hide resolved
This category includes theoretically invented structures that have been relaxed using ab-initio calculations and found to be close to the convex hull of stability, or structures generated from AI models with a demonstrated reasonable predictive power.
rartino marked this conversation as resolved.
Show resolved Hide resolved
rartino marked this conversation as resolved.
Show resolved Hide resolved
This category definition also involves a degree of subjectivity that has to be determined by the database provider.

* :val:`hypothetical`: the structural information is known to have been created in a way that provides no guarantees of producing synthesizable structures or structures found in nature.
This category is suitable for randomly placed atoms (e.g., meant to provide a starting point for further processing) or outcomes of AI models with predictive power deemed insufficient for the :val:`predicted` category.
rartino marked this conversation as resolved.
Show resolved Hide resolved

* :val:`other`: the origin of the structural information is not correctly described by any of the other categories.
rartino marked this conversation as resolved.
Show resolved Hide resolved

* :val:`unknown`: no information is available regarding these aspects of the origin of the structural information.

The experiments and predictions referred to in the above definitions of the categories refer to existence at non-extreme conditions (i.e., existence around NTP or at lower temperatures) and in a regular atmosphere.
Providers who want to communicate structural information about compounds that exist only at unusual or extreme conditions should categorize them as :val:`other` and, if desired, use another facility (e.g., a provider-specific property) to communicate more specific information.

rartino marked this conversation as resolved.
Show resolved Hide resolved
- If the property is omitted, set to an empty string, or `null` it means the same thing as :val:`unknown`.

- Database-specific strings using a database provider prefix (e.g., `_exmpl_experimental_at_extreme_pressure`) MAY be used but are strongly discouraged.
Clients encountering unrecognized strings SHOULD treat them to mean the same as :val:`unknown`.
rartino marked this conversation as resolved.
Show resolved Hide resolved

- **Examples**:

- For a structure entry directly encoding structural information obtained from a neutron diffraction experiment: :val:`"experimental"`.
rartino marked this conversation as resolved.
Show resolved Hide resolved

Calculations Entries
--------------------

Expand Down