Debian Codegraph @

externals/OPTIMADE/schemas/src/defs/v1.2/properties/optimade/structures/cartesian_site_positions.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/cartesian_site_positions"
3 title: "Cartesian site positions"
4 x-optimade-type: "list"
5 x-optimade-definition:
6 label: "cartesian_site_positions_optimade_structures"
7 kind: "property"
8 version: "1.2.1"
9 format: "1.2"
10 name: "cartesian_site_positions"
11 x-optimade-unit-definitions:
12 - $$inherit: "/v1.2/units/si/general/angstrom"
13 x-optimade-dimensions:
14 names: ["dim_sites", "dim_spatial"]
15 sizes: [null, 3]
16 type:
17 - "array"
18 - "null"
19 description: |-
20 Cartesian positions of each site in the structure.
21
22 A site is usually used to describe positions of atoms; what atoms can be encountered at a given site is conveyed by the `species_at_sites` property, and the species themselves are described in the `species` property.
23
24 **Requirements/Conventions**:
25
26 - It MUST be a list of length equal to the number of sites in the structure, where every element is a list of the three Cartesian coordinates of a site expressed as float values in the unit angstrom (Å).
27 - An entry MAY have multiple sites at the same Cartesian position (for a relevant use of this, see e.g., the property `assemblies`).
28
29 **Explained examples**:
30
31 - `[[0,0,0],[0,0,2]]` indicates a structure with two sites, one sitting at the origin and one along the (positive) *z*-axis, 2 Å away from the origin.
32 examples:
33 - [[0,0,0],[0,0,2]]
34 x-optimade-unit: "inapplicable"
35 items:
36 x-optimade-type: "list"
37 x-optimade-dimensions:
38 names: ["dim_spatial"]
39 sizes: [3]
40 type:
41 - "array"
42 x-optimade-unit: "inapplicable"
43 items:
44 x-optimade-type: "float"
45 type:
46 - "number"
47 x-optimade-unit: "angstrom"