Skip to content

Commit

Permalink
Merge pull request #231 from rartino/format_lattice_vectors
Browse files Browse the repository at this point in the history
Clarify use of null in lattice_vectors
  • Loading branch information
CasperWA authored Dec 24, 2019
2 parents a7d915b + 92a6abc commit ccc26eb
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1755,8 +1755,11 @@ lattice\_vectors
- MUST be a list of three vectors *a*, *b*, and *c*, where each of the vectors MUST BE a list of the vector's coordinates along the x, y, and z Cartesian coordinates.
(Therefore, the first index runs over the three lattice vectors and the second index runs over the x, y, z Cartesian coordinates).
- For databases that do not define an absolute Cartesian system (e.g., only defining the length and angles between vectors), the first lattice vector SHOULD be set along *x* and the second on the *xy*-plane.
- This property MUST be an array of dimensions 3 times 3 regardless of the elements of property `dimension_types`_. The vectors SHOULD by convention be chosen so the determinant of the :property:`lattice_vectors` matrix is different from zero. The vectors in the non-periodic directions have no significance beyond fulfilling these requirements.

- This property MUST be an array of dimensions 3 times 3 regardless of the elements of :property:`dimension\_types`.
The vectors SHOULD by convention be chosen so the determinant of the :property:`lattice_vectors` matrix is different from zero.
The vectors in the non-periodic directions have no significance beyond fulfilling these requirements.
- All three elements of the inner lists of floats MAY be :val:`null` for non-periodic dimensions, i.e., those dimensions for which :property:`dimension\_types` is :val:`0`.

- **Examples**:

- :val:`[[4.0,0.0,0.0],[0.0,4.0,0.0],[0.0,1.0,4.0]]` represents a cell, where the first vector is :val:`(4, 0, 0)`, i.e., a vector aligned along the :val:`x` axis of length 4 Å; the second vector is :val:`(0, 4, 0)`; and the third vector is :val:`(0, 1, 4)`.
Expand Down

0 comments on commit ccc26eb

Please sign in to comment.