Debian Codegraph @

externals/OPTIMADE/schemas/src/defs/v1.2/properties/optimade/structures/structure_features.yaml

raw
1 $$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition"
2 $id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/structure_features"
3 title: "structure features"
4 $$inherit: "/v1.2/properties/core/features"
5 x-optimade-definition:
6 label: "structure_features_optimade_structures"
7 kind: "property"
8 version: "1.2.0"
9 format: "1.2"
10 name: "structure_features"
11 description: |-
12 A list of strings that flag which special features are used by the structure.
13
14 **Requirements/Conventions:**
15
16 - MUST be an empty list if no special features are used.
17 - MUST be sorted alphabetically.
18 - If a special feature listed below is used, the list MUST contain the corresponding string.
19 - If a special feature listed below is not used, the list MUST NOT contain the corresponding string.
20 - **List of strings used to indicate special structure features:**
21
22 - `disorder`: this flag MUST be present if any one entry in the species list has a `chemical_symbols` list that is longer than 1 element.
23 - `implicit_atoms`: this flag MUST be present if the structure contains atoms that are not assigned to sites via the property `species_at_sites` (e.g., because their positions are unknown). When this flag is present, the properties related to the chemical formula will likely not match the type and count of atoms represented by the `species_at_sites`, `species`, and `assemblies` properties.
24 - `site_attachments`: this flag MUST be present if any one entry in the species list includes `attached` and `nattached`.
25 - `assemblies`: this flag MUST be present if the property assemblies is present.
26
27 **Explained examples**:
28
29 - A structure having implicit atoms and using assemblies: `["assemblies", "implicit_atoms"]`
30 examples:
31 - ["assemblies", "implicit_atoms"]