@mat3ra/esse 2025.4.17-0 → 2025.4.26-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (143) hide show
  1. package/.pre-commit-config.yaml +3 -6
  2. package/dist/js/example/core/abstract/vector_boolean_3d.json +5 -0
  3. package/dist/js/example/material.json +11 -11
  4. package/dist/js/example/properties_directory/structural/basis/atomic_coordinates.json +18 -21
  5. package/dist/js/example/properties_directory/structural/basis/atomic_elements.json +10 -0
  6. package/dist/js/example/properties_directory/structural/basis/atomic_label.json +4 -0
  7. package/dist/js/example/properties_directory/structural/basis/atomic_labels.json +10 -0
  8. package/dist/js/example/properties_directory/structural/lattice.json +11 -11
  9. package/dist/js/schema/{3pse → apse}/db/nist_jarvis/2024.3.13/atoms.json +1 -1
  10. package/dist/js/schema/{3pse → apse}/db/nist_jarvis/2024.3.13/db_entry.json +1 -1
  11. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/atomic_positions.json +1 -1
  12. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/atomic_species.json +1 -1
  13. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/cell.json +1 -1
  14. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/cell_parameters.json +1 -1
  15. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/control.json +1 -1
  16. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/electrons.json +1 -1
  17. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/hubbard.json +1 -1
  18. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/ions.json +1 -1
  19. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/k_points.json +1 -1
  20. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/system.json +1 -1
  21. package/dist/js/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x.json +1 -1
  22. package/dist/js/schema/core/abstract/coordinate_3d.json +11 -0
  23. package/dist/js/schema/core/abstract/kpoint.json +12 -0
  24. package/dist/js/schema/core/abstract/{3d_tensor.json → matrix_3x3.json} +2 -2
  25. package/dist/js/schema/core/abstract/{point.json → vector_3d.json} +2 -2
  26. package/dist/js/schema/core/abstract/{vector.json → vector_boolean_3d.json} +2 -12
  27. package/dist/js/schema/core/primitive/array_of_ids.json +7 -1
  28. package/dist/js/schema/core/primitive/object_with_id.json +16 -0
  29. package/dist/js/schema/core/primitive/object_with_id_and_value.json +20 -0
  30. package/dist/js/schema/core/reusable/atomic_scalars.json +6 -0
  31. package/dist/js/schema/core/reusable/atomic_string.json +21 -0
  32. package/dist/js/schema/core/reusable/atomic_vector.json +28 -0
  33. package/dist/js/schema/core/reusable/atomic_vectors.json +15 -24
  34. package/dist/js/schema/core/reusable/band_gap.json +4 -2
  35. package/dist/js/schema/material.json +113 -96
  36. package/dist/js/schema/properties_directory/non_scalar/band_gaps.json +6 -3
  37. package/dist/js/schema/properties_directory/non_scalar/stress_tensor.json +1 -1
  38. package/dist/js/schema/properties_directory/structural/atomic_forces.json +15 -24
  39. package/dist/js/schema/properties_directory/structural/basis/atomic_constraint.json +34 -0
  40. package/dist/js/schema/properties_directory/structural/basis/atomic_constraints.json +30 -45
  41. package/dist/js/schema/properties_directory/structural/basis/atomic_constraints_property.json +53 -0
  42. package/dist/js/schema/properties_directory/structural/basis/atomic_coordinate.json +18 -28
  43. package/dist/js/schema/properties_directory/structural/basis/atomic_coordinates.json +26 -59
  44. package/dist/js/schema/properties_directory/structural/basis/atomic_element.json +7 -12
  45. package/dist/js/schema/properties_directory/structural/basis/atomic_elements.json +27 -0
  46. package/dist/js/schema/properties_directory/structural/basis/atomic_label.json +27 -10
  47. package/dist/js/schema/properties_directory/structural/basis/atomic_labels.json +42 -0
  48. package/dist/js/schema/properties_directory/structural/basis/bonds.json +7 -1
  49. package/dist/js/schema/properties_directory/structural/basis/units_enum.json +10 -0
  50. package/dist/js/schema/properties_directory/structural/basis.json +63 -52
  51. package/dist/js/schema/properties_directory/structural/lattice/lattice_vectors.json +15 -40
  52. package/dist/js/schema/properties_directory/structural/lattice/units/angle_enum.json +10 -0
  53. package/dist/js/schema/properties_directory/structural/lattice/units/length_enum.json +10 -0
  54. package/dist/js/schema/properties_directory/structural/lattice/vectors/units_enum.json +10 -0
  55. package/dist/js/schema/{core/abstract/3d_vector_basis.json → properties_directory/structural/lattice/vectors.json} +19 -5
  56. package/dist/js/schema/properties_directory/structural/lattice.json +50 -44
  57. package/dist/js/schema/properties_directory/structural/magnetic_moments.json +15 -24
  58. package/dist/js/schema/properties_directory/structural/molecular_pattern.json +21 -3
  59. package/dist/js/schema/properties_directory/structural/patterns/functional_group.json +7 -1
  60. package/dist/js/schema/properties_directory/structural/patterns/ring.json +7 -1
  61. package/dist/js/schema/properties_directory/structural/patterns/special_bond.json +7 -1
  62. package/dist/js/schemas.json +1 -1
  63. package/dist/js/types.d.ts +445 -322
  64. package/dist/js/types.js +1 -1
  65. package/example/core/abstract/vector_boolean_3d.json +5 -0
  66. package/example/properties_directory/structural/basis/atomic_coordinates.json +18 -21
  67. package/example/properties_directory/structural/basis/atomic_elements.json +10 -0
  68. package/example/properties_directory/structural/basis/atomic_label.json +4 -0
  69. package/example/properties_directory/structural/basis/atomic_labels.json +10 -0
  70. package/example/properties_directory/structural/lattice.json +12 -2
  71. package/package.json +3 -3
  72. package/schema/{3pse → apse}/db/nist_jarvis/2024.3.13/atoms.json +1 -1
  73. package/schema/{3pse → apse}/db/nist_jarvis/2024.3.13/db_entry.json +1 -1
  74. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/atomic_positions.json +1 -1
  75. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/atomic_species.json +1 -1
  76. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/cell.json +1 -1
  77. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/cell_parameters.json +1 -1
  78. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/control.json +1 -1
  79. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/electrons.json +1 -1
  80. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/hubbard.json +1 -1
  81. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/ions.json +1 -1
  82. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/k_points.json +1 -1
  83. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x/system.json +1 -1
  84. package/schema/{3pse → apse}/file/applications/espresso/7.2/pw.x.json +1 -1
  85. package/schema/core/abstract/coordinate_3d.json +10 -0
  86. package/schema/core/abstract/{3d_tensor.json → matrix_3x3.json} +2 -2
  87. package/schema/core/abstract/{point.json → vector_3d.json} +2 -2
  88. package/schema/core/abstract/{vector.json → vector_boolean_3d.json} +2 -5
  89. package/schema/core/primitive/array_of_ids.json +2 -8
  90. package/schema/core/primitive/object_with_id.json +17 -0
  91. package/schema/core/primitive/object_with_id_and_value.json +22 -0
  92. package/schema/core/reusable/atomic_string.json +15 -0
  93. package/schema/core/reusable/atomic_vector.json +15 -0
  94. package/schema/core/reusable/atomic_vectors.json +1 -11
  95. package/schema/core/reusable/band_gap.json +2 -2
  96. package/schema/core/reusable/kpoint.json +11 -0
  97. package/schema/properties_directory/non-scalar/band_gaps.json +1 -1
  98. package/schema/properties_directory/non-scalar/stress_tensor.json +1 -1
  99. package/schema/properties_directory/structural/basis/atomic_constraint.json +17 -0
  100. package/schema/properties_directory/structural/basis/atomic_constraints.json +4 -11
  101. package/schema/properties_directory/structural/basis/atomic_constraints_property.json +17 -0
  102. package/schema/properties_directory/structural/basis/atomic_coordinate.json +8 -6
  103. package/schema/properties_directory/structural/basis/atomic_coordinates.json +6 -18
  104. package/schema/properties_directory/structural/basis/atomic_element.json +5 -20
  105. package/schema/properties_directory/structural/basis/atomic_elements.json +10 -0
  106. package/schema/properties_directory/structural/basis/atomic_label.json +20 -6
  107. package/schema/properties_directory/structural/basis/atomic_labels.json +10 -0
  108. package/schema/properties_directory/structural/basis/units_enum.json +10 -0
  109. package/schema/properties_directory/structural/basis.json +4 -19
  110. package/schema/properties_directory/structural/lattice/units/angle_enum.json +10 -0
  111. package/schema/properties_directory/structural/lattice/units/length_enum.json +10 -0
  112. package/schema/properties_directory/structural/lattice/units.json +18 -0
  113. package/schema/properties_directory/structural/lattice/vectors/units_enum.json +10 -0
  114. package/schema/properties_directory/structural/lattice/vectors.json +33 -0
  115. package/schema/properties_directory/structural/lattice.json +41 -10
  116. package/dist/js/example/core/abstract/3d_vector_basis.json +0 -17
  117. package/dist/js/example/core/primitive/3d_lattice.json +0 -8
  118. package/dist/js/example/properties_directory/structural/lattice/lattice_bravais.json +0 -13
  119. package/dist/js/schema/core/primitive/3d_lattice.json +0 -40
  120. package/dist/js/schema/core/reusable/atomic_strings.json +0 -19
  121. package/dist/js/schema/properties_directory/structural/lattice/lattice_bravais.json +0 -87
  122. package/example/core/abstract/3d_vector_basis.json +0 -17
  123. package/example/core/primitive/3d_lattice.json +0 -8
  124. package/example/properties_directory/structural/lattice/lattice_bravais.json +0 -13
  125. package/schema/core/abstract/3d_vector_basis.json +0 -25
  126. package/schema/core/primitive/3d_lattice.json +0 -40
  127. package/schema/core/reusable/atomic_strings.json +0 -17
  128. package/schema/properties_directory/structural/lattice/lattice_bravais.json +0 -36
  129. package/schema/properties_directory/structural/lattice/lattice_vectors.json +0 -21
  130. /package/dist/js/example/{3pse → apse}/db/nist_jarvis/2024.3.13/db_entry.json +0 -0
  131. /package/dist/js/example/{3pse → apse}/file/applications/espresso/7.2/pw.x.json +0 -0
  132. /package/dist/js/example/core/abstract/{point.json → coordinate_3d.json} +0 -0
  133. /package/dist/js/example/core/abstract/{3d_tensor.json → matrix_3x3.json} +0 -0
  134. /package/dist/js/example/core/abstract/{vector.json → vector_3d.json} +0 -0
  135. /package/dist/js/example/properties_directory/structural/basis/{atomic_constraints.json → atomic_constraints_property.json} +0 -0
  136. /package/dist/js/example/properties_directory/structural/lattice/{lattice_vectors.json → vectors.json} +0 -0
  137. /package/example/{3pse → apse}/db/nist_jarvis/2024.3.13/db_entry.json +0 -0
  138. /package/example/{3pse → apse}/file/applications/espresso/7.2/pw.x.json +0 -0
  139. /package/example/core/abstract/{point.json → coordinate_3d.json} +0 -0
  140. /package/example/core/abstract/{3d_tensor.json → matrix_3x3.json} +0 -0
  141. /package/example/core/abstract/{vector.json → vector_3d.json} +0 -0
  142. /package/example/properties_directory/structural/basis/{atomic_constraints.json → atomic_constraints_property.json} +0 -0
  143. /package/example/properties_directory/structural/lattice/{lattice_vectors.json → vectors.json} +0 -0
@@ -1,4 +1,4 @@
1
- /** Schema dist/js/schema/3pse/db/nist_jarvis/2024.3.13/atoms.json */
1
+ /** Schema dist/js/schema/apse/db/nist_jarvis/2024.3.13/atoms.json */
2
2
  /**
3
3
  * NIST J.A.R.V.I.S. db entry `atoms` key schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571
4
4
  */
@@ -41,7 +41,7 @@ export interface NISTJARVISAtomsSchema {
41
41
  */
42
42
  props?: string[];
43
43
  }
44
- /** Schema dist/js/schema/3pse/db/nist_jarvis/2024.3.13/db_entry.json */
44
+ /** Schema dist/js/schema/apse/db/nist_jarvis/2024.3.13/db_entry.json */
45
45
  /**
46
46
  * NIST J.A.R.V.I.S. db entry `atoms` key schema. Based on https://figshare.com/articles/dataset/Monolayer_data_for_heterostructure/22344571
47
47
  */
@@ -56,23 +56,7 @@ export interface NISTJARVISDbEntrySchema {
56
56
  * @minItems 3
57
57
  * @maxItems 3
58
58
  */
59
- lattice_mat?: [
60
- [
61
- number,
62
- number,
63
- number
64
- ],
65
- [
66
- number,
67
- number,
68
- number
69
- ],
70
- [
71
- number,
72
- number,
73
- number
74
- ]
75
- ];
59
+ lattice_mat?: [[number, number, number], [number, number, number], [number, number, number]];
76
60
  /**
77
61
  * Atomic coordinates for each atom in the unit cell
78
62
  *
@@ -110,7 +94,7 @@ export interface NISTJARVISDbEntrySchema {
110
94
  jid?: string;
111
95
  [k: string]: unknown;
112
96
  }
113
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/atomic_positions.json */
97
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/atomic_positions.json */
114
98
  /**
115
99
  * https://www.quantum-espresso.org/Doc/INPUT_PW.html#idm1493
116
100
  */
@@ -138,7 +122,7 @@ export interface AtomicPositionsSchema {
138
122
  "if_pos(3)"?: number;
139
123
  }[];
140
124
  }
141
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/atomic_species.json */
125
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/atomic_species.json */
142
126
  export interface AtomicSpeciesSchema {
143
127
  values?: {
144
128
  /**
@@ -155,8 +139,20 @@ export interface AtomicSpeciesSchema {
155
139
  PseudoPot_X?: string;
156
140
  }[];
157
141
  }
158
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/cell.json */
159
- export type CellSchema = {
142
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/cell.json */
143
+ export type CellSchema = CellSchema1 & CellSchema2;
144
+ export type CellSchema2 = {
145
+ /**
146
+ * CASE ( calculation == 'vc-relax' )
147
+ */
148
+ cell_dynamics?: "none" | "sd" | "damp-pr" | "damp-w" | "bfgs";
149
+ } | {
150
+ /**
151
+ * CASE ( calculation == 'vc-md' )
152
+ */
153
+ cell_dynamics?: "none" | "pr" | "w";
154
+ };
155
+ export interface CellSchema1 {
160
156
  /**
161
157
  * Target pressure [KBar] in a variable-cell md or relaxation run.
162
158
  */
@@ -177,18 +173,8 @@ export type CellSchema = {
177
173
  * Select which of the cell parameters should be moved
178
174
  */
179
175
  cell_dofree?: "all" | "ibrav" | "a" | "b" | "c" | "fixa" | "fixb" | "fixc" | "x" | "y" | "xy" | "xz" | "xyz" | "shape" | "volume" | "2Dxy" | "2Dshape" | "epitaxial_ab" | "epitaxial_ac" | "epitaxial_bc";
180
- } & ({
181
- /**
182
- * CASE ( calculation == 'vc-relax' )
183
- */
184
- cell_dynamics?: "none" | "sd" | "damp-pr" | "damp-w" | "bfgs";
185
- } | {
186
- /**
187
- * CASE ( calculation == 'vc-md' )
188
- */
189
- cell_dynamics?: "none" | "pr" | "w";
190
- });
191
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/cell_parameters.json */
176
+ }
177
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/cell_parameters.json */
192
178
  export interface CellParametersSchema {
193
179
  /**
194
180
  * label of the atom. Acceptable syntax: chemical symbol X (1 or 2 characters, case-insensitive) or chemical symbol plus a number or a letter, as in "Xn" (e.g. Fe1) or "X_*" or "X-*" (e.g. C1, C_h; max total length cannot exceed 3 characters)
@@ -212,7 +198,7 @@ export interface CellParametersSchema {
212
198
  v3?: [number, number, number];
213
199
  };
214
200
  }
215
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/control.json */
201
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/control.json */
216
202
  export interface ControlSchema {
217
203
  /**
218
204
  * A string describing the task to be performed
@@ -332,7 +318,7 @@ export interface ControlSchema {
332
318
  */
333
319
  trism?: boolean;
334
320
  }
335
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/electrons.json */
321
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/electrons.json */
336
322
  export interface ElectronsSchema {
337
323
  /**
338
324
  * maximum number of iterations in a scf step. If exact exchange is active, this will affect the inner loops.
@@ -426,7 +412,7 @@ export interface ElectronsSchema {
426
412
  */
427
413
  real_space?: boolean;
428
414
  }
429
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/hubbard.json */
415
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/hubbard.json */
430
416
  export interface HubbardSchema {
431
417
  card_option?: "atomic" | "ortho-atomic" | "norm-atomic" | "wf" | "pseudo";
432
418
  values?: ({
@@ -549,8 +535,30 @@ export interface HubbardSchema {
549
535
  "v_val(I,J)"?: number;
550
536
  })[];
551
537
  }
552
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/ions.json */
553
- export type IonsSchema = {
538
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/ions.json */
539
+ export type IonsSchema = IonsSchema1 & IonsSchema2;
540
+ export type IonsSchema2 = {
541
+ /**
542
+ * CASE: calculation == 'relax'
543
+ */
544
+ ion_dynamics?: "bfgs" | "damp" | "fire";
545
+ } | {
546
+ /**
547
+ * CASE: calculation == 'md'
548
+ */
549
+ ion_dynamics?: "verlet" | "langevin" | "langevin-smc";
550
+ } | {
551
+ /**
552
+ * CASE: calculation == 'vc-relax'
553
+ */
554
+ ion_dynamics?: "bfgs" | "damp";
555
+ } | {
556
+ /**
557
+ * CASE: calculation == 'vc-md'
558
+ */
559
+ ion_dynamics?: "beeman";
560
+ };
561
+ export interface IonsSchema1 {
554
562
  ion_positions?: "default" | "from_input";
555
563
  ion_velocities?: "default" | "from_input";
556
564
  /**
@@ -629,28 +637,8 @@ export type IonsSchema = {
629
637
  * Determines the maximum value of dt in the FIRE minimization; dtmax = fire_dtmax*dt
630
638
  */
631
639
  fire_dtmax?: number;
632
- } & ({
633
- /**
634
- * CASE: calculation == 'relax'
635
- */
636
- ion_dynamics?: "bfgs" | "damp" | "fire";
637
- } | {
638
- /**
639
- * CASE: calculation == 'md'
640
- */
641
- ion_dynamics?: "verlet" | "langevin" | "langevin-smc";
642
- } | {
643
- /**
644
- * CASE: calculation == 'vc-relax'
645
- */
646
- ion_dynamics?: "bfgs" | "damp";
647
- } | {
648
- /**
649
- * CASE: calculation == 'vc-md'
650
- */
651
- ion_dynamics?: "beeman";
652
- });
653
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/k_points.json */
640
+ }
641
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/k_points.json */
654
642
  export interface KPointsSchema {
655
643
  card_option?: "tpiba" | "automatic" | "crystal" | "gamma" | "tpiba_b" | "crystal_b" | "tpiba_c" | "crystal_c";
656
644
  values?: {
@@ -689,8 +677,9 @@ export interface KPointsSchema {
689
677
  sk3?: number;
690
678
  } | null;
691
679
  }
692
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/system.json */
693
- export type SystemSchema = ({
680
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/system.json */
681
+ export type SystemSchema = SystemSchema1 & SystemSchema2;
682
+ export type SystemSchema1 = {
694
683
  /**
695
684
  * @minItems 6
696
685
  * @maxItems 6
@@ -703,7 +692,8 @@ export type SystemSchema = ({
703
692
  cosAB?: number;
704
693
  cosAC?: number;
705
694
  cosBC?: number;
706
- }) & {
695
+ };
696
+ export interface SystemSchema2 {
707
697
  ibrav: number;
708
698
  /**
709
699
  * number of atoms in the unit cell (ALL atoms, except if space_group is set, in which case, INEQUIVALENT atoms)
@@ -1067,8 +1057,8 @@ export type SystemSchema = ({
1067
1057
  * Number of activated external ionic force fields.
1068
1058
  */
1069
1059
  nextffield?: number;
1070
- };
1071
- /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x.json */
1060
+ }
1061
+ /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x.json */
1072
1062
  export interface PwxMainSchema {
1073
1063
  "&CONTROL"?: {
1074
1064
  /**
@@ -1610,83 +1600,36 @@ export interface DimensionalGridSchema {
1610
1600
  */
1611
1601
  shifts: [number, number, number];
1612
1602
  }
1613
- /** Schema dist/js/schema/core/abstract/3d_tensor.json */
1603
+ /** Schema dist/js/schema/core/abstract/coordinate_3d.json */
1614
1604
  /**
1615
1605
  * @minItems 3
1616
1606
  * @maxItems 3
1617
1607
  */
1618
- export type DimensionalTensorSchema = [
1619
- [
1620
- number,
1621
- number,
1622
- number
1623
- ],
1624
- [
1625
- number,
1626
- number,
1627
- number
1628
- ],
1629
- [
1630
- number,
1631
- number,
1632
- number
1633
- ]
1634
- ];
1635
- /** Schema dist/js/schema/core/abstract/3d_vector_basis.json */
1636
- export interface DimensionalVectorBasis {
1637
- /**
1638
- * @minItems 3
1639
- * @maxItems 3
1640
- */
1641
- a: [number, number, number];
1642
- /**
1643
- * @minItems 3
1644
- * @maxItems 3
1645
- */
1646
- b: [number, number, number];
1647
- /**
1648
- * @minItems 3
1649
- * @maxItems 3
1650
- */
1651
- c: [number, number, number];
1652
- }
1653
- /** Schema dist/js/schema/core/abstract/point.json */
1608
+ export type Coordinate3DSchema = [number, number, number];
1609
+ /** Schema dist/js/schema/core/abstract/kpoint.json */
1654
1610
  /**
1611
+ * A k-point is a point in reciprocal space of a crystal.
1612
+ *
1655
1613
  * @minItems 3
1656
1614
  * @maxItems 3
1657
1615
  */
1658
- export type PointSchema = [number, number, number];
1659
- /** Schema dist/js/schema/core/abstract/vector.json */
1660
- export type VectorSchema = [number, number, number] | [boolean, boolean, boolean];
1616
+ export type KpointSchema = [number, number, number];
1617
+ /** Schema dist/js/schema/core/abstract/matrix_3x3.json */
1618
+ /**
1619
+ * @minItems 3
1620
+ * @maxItems 3
1621
+ */
1622
+ export type Matrix3X3Schema = [[number, number, number], [number, number, number], [number, number, number]];
1623
+ /** Schema dist/js/schema/core/abstract/vector_3d.json */
1624
+ /**
1625
+ * @minItems 3
1626
+ * @maxItems 3
1627
+ */
1628
+ export type Vector3DSchema = [number, number, number];
1629
+ /** Schema dist/js/schema/core/abstract/vector_boolean_3d.json */
1630
+ export type VectorBoolean3DSchema = [boolean, boolean, boolean];
1661
1631
  /** Schema dist/js/schema/core/primitive/1d_data_series.json */
1662
1632
  export type DimensionDataSeriesSchema = [number | string, ...(number | string)[]][];
1663
- /** Schema dist/js/schema/core/primitive/3d_lattice.json */
1664
- export interface DimensionalLatticeSchema {
1665
- /**
1666
- * length of the first lattice vector
1667
- */
1668
- a: number;
1669
- /**
1670
- * length of the second lattice vector
1671
- */
1672
- b: number;
1673
- /**
1674
- * length of the third lattice vector
1675
- */
1676
- c: number;
1677
- /**
1678
- * angle between first and second lattice vector
1679
- */
1680
- alpha: number;
1681
- /**
1682
- * angle between second and third lattice vector
1683
- */
1684
- beta: number;
1685
- /**
1686
- * angle between first and third lattice vector
1687
- */
1688
- gamma: number;
1689
- }
1690
1633
  /** Schema dist/js/schema/core/primitive/array_of_3_booleans.json */
1691
1634
  /**
1692
1635
  * @minItems 3
@@ -1703,11 +1646,11 @@ export type ArrayOf3NumberElementsSchema = [number, number, number];
1703
1646
  /**
1704
1647
  * array of objects containing integer id each
1705
1648
  */
1706
- export type AtomicIds = {
1649
+ export type ArrayOfIds = {
1707
1650
  /**
1708
1651
  * integer id of this entry
1709
1652
  */
1710
- id?: number;
1653
+ id: number;
1711
1654
  }[];
1712
1655
  /** Schema dist/js/schema/core/primitive/array_of_strings.json */
1713
1656
  /**
@@ -1928,6 +1871,32 @@ export type LinkedListSchema = ({
1928
1871
  */
1929
1872
  flowchartId: string;
1930
1873
  })[];
1874
+ /** Schema dist/js/schema/core/primitive/object_with_id.json */
1875
+ /**
1876
+ * object containing integer id
1877
+ */
1878
+ export interface ObjectWithId {
1879
+ /**
1880
+ * integer id of this entry
1881
+ */
1882
+ id: number;
1883
+ }
1884
+ /** Schema dist/js/schema/core/primitive/object_with_id_and_value.json */
1885
+ /**
1886
+ * object containing integer id and value each
1887
+ */
1888
+ export interface ObjectWithIdAndValueSchema {
1889
+ /**
1890
+ * value of this entry
1891
+ */
1892
+ value: {
1893
+ [k: string]: unknown;
1894
+ };
1895
+ /**
1896
+ * integer id of this entry
1897
+ */
1898
+ id: number;
1899
+ }
1931
1900
  /** Schema dist/js/schema/core/primitive/scalar.json */
1932
1901
  export interface ScalarSchema {
1933
1902
  value: number;
@@ -2599,38 +2568,65 @@ export type AtomicScalarsVectorsSchema = {
2599
2568
  /**
2600
2569
  * integer id of this entry
2601
2570
  */
2602
- id?: number;
2571
+ id: number;
2603
2572
  }[];
2604
- /** Schema dist/js/schema/core/reusable/atomic_strings.json */
2573
+ /** Schema dist/js/schema/core/reusable/atomic_string.json */
2605
2574
  /**
2606
- * array of objects containing integer id each
2575
+ * object containing integer id and value each
2607
2576
  */
2608
- export type AtomicStringsVectorsSchema = {
2609
- value?: string;
2577
+ export interface AtomicStringSchema {
2578
+ /**
2579
+ * value of this entry
2580
+ */
2581
+ value: string;
2610
2582
  /**
2611
2583
  * integer id of this entry
2612
2584
  */
2613
- id?: number;
2614
- }[];
2615
- /** Schema dist/js/schema/core/reusable/atomic_vectors.json */
2585
+ id: number;
2586
+ }
2587
+ /** Schema dist/js/schema/core/reusable/atomic_vector.json */
2616
2588
  /**
2617
- * array of objects containing integer id each
2589
+ * object containing integer id and value each
2618
2590
  */
2591
+ export interface AtomicVectorSchema {
2592
+ /**
2593
+ * value of this entry
2594
+ *
2595
+ * @minItems 3
2596
+ * @maxItems 3
2597
+ */
2598
+ value: [number, number, number];
2599
+ /**
2600
+ * integer id of this entry
2601
+ */
2602
+ id: number;
2603
+ }
2604
+ /** Schema dist/js/schema/core/reusable/atomic_vectors.json */
2619
2605
  export type AtomicVectorsSchema = {
2620
- value?: [number, number, number] | [boolean, boolean, boolean];
2606
+ /**
2607
+ * value of this entry
2608
+ *
2609
+ * @minItems 3
2610
+ * @maxItems 3
2611
+ */
2612
+ value: [number, number, number];
2621
2613
  /**
2622
2614
  * integer id of this entry
2623
2615
  */
2624
- id?: number;
2616
+ id: number;
2625
2617
  }[];
2626
2618
  /** Schema dist/js/schema/core/reusable/band_gap.json */
2627
2619
  export interface BandGapSchema {
2628
2620
  /**
2621
+ * A k-point is a point in reciprocal space of a crystal.
2622
+ *
2629
2623
  * @minItems 3
2630
2624
  * @maxItems 3
2631
2625
  */
2632
2626
  kpointConduction?: [number, number, number];
2633
2627
  /**
2628
+ * A k-point is a point in reciprocal space of a crystal.
2629
+ *
2634
2630
  * @minItems 3
2635
2631
  * @maxItems 3
2636
2632
  */
@@ -6166,53 +6162,51 @@ export interface MaterialSchema {
6166
6162
  */
6167
6163
  unitCellFormula?: string;
6168
6164
  basis: {
6165
+ /**
6166
+ * atomic elements schema
6167
+ */
6169
6168
  elements: {
6170
- id: number;
6169
+ /**
6170
+ * value of this entry
6171
+ */
6171
6172
  value: string;
6172
6173
  /**
6173
- * Occurrence is for fractional occupations
6174
+ * integer id of this entry
6174
6175
  */
6175
- occurrence?: number;
6176
- oxidationState?: number;
6176
+ id: number;
6177
6177
  }[];
6178
+ /**
6179
+ * atomic coordinates schema
6180
+ */
6178
6181
  coordinates: {
6179
- id?: number;
6180
- value?: [number, number, number] | [boolean, boolean, boolean];
6181
- }[];
6182
- units?: "crystal" | "cartesian";
6183
- labels?: {
6184
- id?: number;
6185
- value?: number;
6186
- }[];
6187
- };
6188
- lattice: {
6189
- vectors?: {
6190
- /**
6191
- * lattice parameter for fractional coordinates
6192
- */
6193
- alat?: number;
6194
- units?: "angstrom" | "bohr";
6195
6182
  /**
6183
+ * value of this entry
6184
+ *
6196
6185
  * @minItems 3
6197
6186
  * @maxItems 3
6198
6187
  */
6199
- a: [number, number, number];
6188
+ value: [number, number, number];
6200
6189
  /**
6201
- * @minItems 3
6202
- * @maxItems 3
6190
+ * integer id of this entry
6203
6191
  */
6204
- b: [number, number, number];
6192
+ id: number;
6193
+ }[];
6194
+ units?: "crystal" | "cartesian";
6195
+ /**
6196
+ * atomic labels schema
6197
+ */
6198
+ labels?: {
6205
6199
  /**
6206
- * @minItems 3
6207
- * @maxItems 3
6200
+ * value of this entry
6208
6201
  */
6209
- c: [number, number, number];
6210
- };
6211
- type: "CUB" | "BCC" | "FCC" | "TET" | "MCL" | "ORC" | "ORCC" | "ORCF" | "ORCI" | "HEX" | "BCT" | "TRI" | "MCLC" | "RHL";
6212
- units?: {
6213
- length?: "angstrom" | "bohr";
6214
- angle?: "degree" | "radian";
6215
- };
6202
+ value: (number | string | number) | number;
6203
+ /**
6204
+ * integer id of this entry
6205
+ */
6206
+ id: number;
6207
+ }[];
6208
+ };
6209
+ lattice: {
6216
6210
  /**
6217
6211
  * length of the first lattice vector
6218
6212
  */
@@ -6237,6 +6231,33 @@ export interface MaterialSchema {
6237
6231
  * angle between first and third lattice vector
6238
6232
  */
6239
6233
  gamma: number;
6234
+ vectors?: {
6235
+ /**
6236
+ * @minItems 3
6237
+ * @maxItems 3
6238
+ */
6239
+ a: [number, number, number];
6240
+ /**
6241
+ * @minItems 3
6242
+ * @maxItems 3
6243
+ */
6244
+ b: [number, number, number];
6245
+ /**
6246
+ * @minItems 3
6247
+ * @maxItems 3
6248
+ */
6249
+ c: [number, number, number];
6250
+ /**
6251
+ * lattice parameter for fractional coordinates
6252
+ */
6253
+ alat?: number;
6254
+ units?: "angstrom" | "bohr";
6255
+ };
6256
+ type?: "CUB" | "BCC" | "FCC" | "TET" | "MCL" | "ORC" | "ORCC" | "ORCF" | "ORCI" | "HEX" | "BCT" | "TRI" | "MCLC" | "RHL";
6257
+ units?: {
6258
+ length?: "angstrom" | "bohr";
6259
+ angle?: "degree" | "radian";
6260
+ };
6240
6261
  };
6241
6262
  derivedProperties?: ({
6242
6263
  name?: "volume";
@@ -12773,13 +12794,8 @@ export interface SpinPolarizationMixin {
12773
12794
  [k: string]: unknown;
12774
12795
  }
12775
12796
  /** Schema dist/js/schema/model/model_parameters.json */
12776
- export type ModelParameters = {
12777
- hubbardType?: "u";
12778
- spinPolarization?: "collinear" | "non-collinear";
12779
- spinOrbitCoupling?: boolean;
12780
- dispersionCorrection?: "dft-d2" | "dft-d3" | "xdm" | "ts";
12781
- [k: string]: unknown;
12782
- } & ({
12797
+ export type ModelParameters = ModelParameters1 & ModelParameters2;
12798
+ export type ModelParameters2 = {
12783
12799
  functional?: "pz";
12784
12800
  [k: string]: unknown;
12785
12801
  } | {
@@ -12792,7 +12808,14 @@ export type ModelParameters = {
12792
12808
  functional?: "hse06" | "b3lyp";
12793
12809
  } | {
12794
12810
  functional?: "b2plyp";
12795
- });
12811
+ };
12812
+ export interface ModelParameters1 {
12813
+ hubbardType?: "u";
12814
+ spinPolarization?: "collinear" | "non-collinear";
12815
+ spinOrbitCoupling?: boolean;
12816
+ dispersionCorrection?: "dft-d2" | "dft-d3" | "xdm" | "ts";
12817
+ [k: string]: unknown;
12818
+ }
12796
12819
  /** Schema dist/js/schema/model/model_without_method.json */
12797
12820
  export interface ModelWithoutMethodSchemaBase {
12798
12821
  /**
@@ -14991,7 +15014,18 @@ export interface ModelLocalDensityApproximation {
14991
15014
  tags?: string[];
14992
15015
  }
14993
15016
  /** Schema dist/js/schema/models_directory/legacy/dft.json */
14994
- export type LegacyModelDensityFunctionalTheory = {
15017
+ export type LegacyModelDensityFunctionalTheory = LegacyModelDensityFunctionalTheory1 & LegacyModelDensityFunctionalTheory2;
15018
+ export type LegacyModelDensityFunctionalTheory2 = {
15019
+ subtype?: "lda";
15020
+ functional?: "pz" | "pw" | "vwn" | "other";
15021
+ } | {
15022
+ subtype?: "gga";
15023
+ functional?: "pbe" | "pbesol" | "pw91" | "other";
15024
+ } | {
15025
+ subtype?: "hybrid";
15026
+ functional?: "b3lyp" | "hse06";
15027
+ };
15028
+ export interface LegacyModelDensityFunctionalTheory1 {
14995
15029
  /**
14996
15030
  * general type of the model, eg. `dft`
14997
15031
  */
@@ -15019,18 +15053,9 @@ export type LegacyModelDensityFunctionalTheory = {
15019
15053
  data?: {};
15020
15054
  };
15021
15055
  [k: string]: unknown;
15022
- } & ({
15023
- subtype?: "lda";
15024
- functional?: "pz" | "pw" | "vwn" | "other";
15025
- } | {
15026
- subtype?: "gga";
15027
- functional?: "pbe" | "pbesol" | "pw91" | "other";
15028
- } | {
15029
- subtype?: "hybrid";
15030
- functional?: "b3lyp" | "hse06";
15031
- });
15056
+ }
15032
15057
  /**
15033
- * This interface was referenced by `undefined`'s JSON-Schema
15058
+ * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
15034
15059
  * via the `definition` "lda".
15035
15060
  */
15036
15061
  export interface Lda {
@@ -15038,7 +15063,7 @@ export interface Lda {
15038
15063
  functional?: "pz" | "pw" | "vwn" | "other";
15039
15064
  }
15040
15065
  /**
15041
- * This interface was referenced by `undefined`'s JSON-Schema
15066
+ * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
15042
15067
  * via the `definition` "gga".
15043
15068
  */
15044
15069
  export interface Gga {
@@ -15046,7 +15071,7 @@ export interface Gga {
15046
15071
  functional?: "pbe" | "pbesol" | "pw91" | "other";
15047
15072
  }
15048
15073
  /**
15049
- * This interface was referenced by `undefined`'s JSON-Schema
15074
+ * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
15050
15075
  * via the `definition` "hybrid".
15051
15076
  */
15052
15077
  export interface Hybrid {
@@ -15605,11 +15630,15 @@ export interface BandGapsSchema {
15605
15630
  name: "band_gaps";
15606
15631
  values?: {
15607
15632
  /**
15633
+ * A k-point is a point in reciprocal space of a crystal.
15634
+ *
15608
15635
  * @minItems 3
15609
15636
  * @maxItems 3
15610
15637
  */
15611
15638
  kpointConduction?: [number, number, number];
15612
15639
  /**
15640
+ * A k-point is a point in reciprocal space of a crystal.
15641
+ *
15613
15642
  * @minItems 3
15614
15643
  * @maxItems 3
15615
15644
  */
@@ -15629,6 +15658,8 @@ export interface BandGapsSchema {
15629
15658
  }[];
15630
15659
  eigenvalues?: {
15631
15660
  /**
15661
+ * A k-point is a point in reciprocal space of a crystal.
15662
+ *
15632
15663
  * @minItems 3
15633
15664
  * @maxItems 3
15634
15665
  */
@@ -16302,76 +16333,159 @@ export interface ZeroPointEnergySchema {
16302
16333
  */
16303
16334
  export interface AtomicForces {
16304
16335
  name?: "atomic_forces";
16305
- /**
16306
- * array of objects containing integer id each
16307
- */
16308
16336
  values?: {
16309
- value?: [number, number, number] | [boolean, boolean, boolean];
16337
+ /**
16338
+ * value of this entry
16339
+ *
16340
+ * @minItems 3
16341
+ * @maxItems 3
16342
+ */
16343
+ value: [number, number, number];
16310
16344
  /**
16311
16345
  * integer id of this entry
16312
16346
  */
16313
- id?: number;
16347
+ id: number;
16314
16348
  }[];
16315
16349
  units?: "eV/bohr" | "eV/angstrom" | "Ry/a.u." | "newton" | "kg*m/s^2" | "eV/a.u.";
16316
16350
  }
16351
+ /** Schema dist/js/schema/properties_directory/structural/basis/atomic_constraint.json */
16352
+ /**
16353
+ * constraint of atoms by ids, used to constraint the position etc.
16354
+ */
16355
+ export interface AtomicConstraintSchema {
16356
+ /**
16357
+ * value of this entry
16358
+ */
16359
+ value: [boolean, boolean, boolean];
16360
+ /**
16361
+ * integer id of this entry
16362
+ */
16363
+ id: number;
16364
+ }
16317
16365
  /** Schema dist/js/schema/properties_directory/structural/basis/atomic_constraints.json */
16318
16366
  /**
16319
16367
  * atomic constraints schema
16320
16368
  */
16321
- export interface AtomicConstraints {
16369
+ export type AtomicConstraintsSchema = {
16370
+ /**
16371
+ * value of this entry
16372
+ */
16373
+ value: [boolean, boolean, boolean];
16374
+ /**
16375
+ * integer id of this entry
16376
+ */
16377
+ id: number;
16378
+ }[];
16379
+ /** Schema dist/js/schema/properties_directory/structural/basis/atomic_constraints_property.json */
16380
+ /**
16381
+ * atomic constraints property schema (as stored in a database)
16382
+ */
16383
+ export interface AtomicConstraintsPropertySchema {
16322
16384
  name?: "atomic_constraints";
16323
16385
  /**
16324
- * array of objects containing integer id each
16386
+ * atomic constraints schema
16325
16387
  */
16326
16388
  values?: {
16327
- value?: [number, number, number] | [boolean, boolean, boolean];
16389
+ /**
16390
+ * value of this entry
16391
+ */
16392
+ value: [boolean, boolean, boolean];
16328
16393
  /**
16329
16394
  * integer id of this entry
16330
16395
  */
16331
- id?: number;
16396
+ id: number;
16332
16397
  }[];
16333
16398
  }
16334
16399
  /** Schema dist/js/schema/properties_directory/structural/basis/atomic_coordinate.json */
16335
16400
  /**
16336
- * coordinates of atoms by ids, vector, unitless
16401
+ * coordinate of an atom
16337
16402
  */
16338
- export interface AtomicCoordinate {
16339
- id?: number;
16340
- value?: [number, number, number] | [boolean, boolean, boolean];
16403
+ export interface AtomicCoordinateSchema {
16404
+ /**
16405
+ * value of this entry
16406
+ *
16407
+ * @minItems 3
16408
+ * @maxItems 3
16409
+ */
16410
+ value: [number, number, number];
16411
+ /**
16412
+ * integer id of this entry
16413
+ */
16414
+ id: number;
16341
16415
  }
16342
16416
  /** Schema dist/js/schema/properties_directory/structural/basis/atomic_coordinates.json */
16343
16417
  /**
16344
- * coordinates of atoms by ids, vector, unitless
16418
+ * atomic coordinates schema
16345
16419
  */
16346
- export interface AtomicCoordinates {
16347
- name?: "atomic_coordinates";
16348
- values?: {
16349
- id?: number;
16350
- value?: [number, number, number] | [boolean, boolean, boolean];
16351
- }[];
16352
- units?: "km" | "m" | "cm" | "mm" | "um" | "nm" | "angstrom" | "a.u." | "bohr" | "pm";
16353
- }
16420
+ export type AtomicCoordinatesSchema = {
16421
+ /**
16422
+ * value of this entry
16423
+ *
16424
+ * @minItems 3
16425
+ * @maxItems 3
16426
+ */
16427
+ value: [number, number, number];
16428
+ /**
16429
+ * integer id of this entry
16430
+ */
16431
+ id: number;
16432
+ }[];
16354
16433
  /** Schema dist/js/schema/properties_directory/structural/basis/atomic_element.json */
16355
16434
  /**
16356
- * elements of atoms by ids, string, unitless
16435
+ * chemical element of an atom according to the periodic table
16357
16436
  */
16358
- export interface AtomicElements {
16359
- id: number;
16437
+ export interface AtomicElementSchema {
16438
+ /**
16439
+ * value of this entry
16440
+ */
16360
16441
  value: string;
16361
16442
  /**
16362
- * Occurrence is for fractional occupations
16443
+ * integer id of this entry
16363
16444
  */
16364
- occurrence?: number;
16365
- oxidationState?: number;
16445
+ id: number;
16366
16446
  }
16447
+ /** Schema dist/js/schema/properties_directory/structural/basis/atomic_elements.json */
16448
+ /**
16449
+ * atomic elements schema
16450
+ */
16451
+ export type AtomicElementsSchema = {
16452
+ /**
16453
+ * value of this entry
16454
+ */
16455
+ value: string;
16456
+ /**
16457
+ * integer id of this entry
16458
+ */
16459
+ id: number;
16460
+ }[];
16367
16461
  /** Schema dist/js/schema/properties_directory/structural/basis/atomic_label.json */
16368
16462
  /**
16369
- * Optional numeric label (e.g., 1, 2, as in Fe1, Fe2) to distinguish same atomic species to attach different spin magnetic moment.
16463
+ * Optional label (e.g., 1, 2, as in Fe1, Fe2) to distinguish species, e.g. to have magnetic moment.
16370
16464
  */
16371
- export interface AtomicLabel {
16372
- id?: number;
16373
- value?: number;
16465
+ export interface AtomicLabelSchema {
16466
+ /**
16467
+ * value of this entry
16468
+ */
16469
+ value: (number | string) | number;
16470
+ /**
16471
+ * integer id of this entry
16472
+ */
16473
+ id: number;
16374
16474
  }
16475
+ /** Schema dist/js/schema/properties_directory/structural/basis/atomic_labels.json */
16476
+ /**
16477
+ * atomic labels schema
16478
+ */
16479
+ export type AtomicLabelsSchema = {
16480
+ /**
16481
+ * value of this entry
16482
+ */
16483
+ value: (number | string | number) | number;
16484
+ /**
16485
+ * integer id of this entry
16486
+ */
16487
+ id: number;
16488
+ }[];
16375
16489
  /** Schema dist/js/schema/properties_directory/structural/basis/bonds.json */
16376
16490
  export type BondsSchema = {
16377
16491
  /**
@@ -16385,36 +16499,63 @@ export type BondsSchema = {
16385
16499
  /**
16386
16500
  * integer id of this entry
16387
16501
  */
16388
- id?: number;
16502
+ id: number;
16389
16503
  },
16390
16504
  {
16391
16505
  /**
16392
16506
  * integer id of this entry
16393
16507
  */
16394
- id?: number;
16508
+ id: number;
16395
16509
  }
16396
16510
  ];
16397
16511
  bondType?: "single" | "double" | "triple" | "quadruple" | "aromatic" | "tautomeric" | "dative" | "other";
16398
16512
  }[];
16513
+ /** Schema dist/js/schema/properties_directory/structural/basis/units_enum.json */
16514
+ export type BasisUnitsEnum = "crystal" | "cartesian";
16399
16515
  /** Schema dist/js/schema/properties_directory/structural/basis.json */
16400
16516
  export interface BasisSchema {
16517
+ /**
16518
+ * atomic elements schema
16519
+ */
16401
16520
  elements: {
16402
- id: number;
16521
+ /**
16522
+ * value of this entry
16523
+ */
16403
16524
  value: string;
16404
16525
  /**
16405
- * Occurrence is for fractional occupations
16526
+ * integer id of this entry
16406
16527
  */
16407
- occurrence?: number;
16408
- oxidationState?: number;
16528
+ id: number;
16409
16529
  }[];
16530
+ /**
16531
+ * atomic coordinates schema
16532
+ */
16410
16533
  coordinates: {
16411
- id?: number;
16412
- value?: [number, number, number] | [boolean, boolean, boolean];
16534
+ /**
16535
+ * value of this entry
16536
+ *
16537
+ * @minItems 3
16538
+ * @maxItems 3
16539
+ */
16540
+ value: [number, number, number];
16541
+ /**
16542
+ * integer id of this entry
16543
+ */
16544
+ id: number;
16413
16545
  }[];
16414
16546
  units?: "crystal" | "cartesian";
16547
+ /**
16548
+ * atomic labels schema
16549
+ */
16415
16550
  labels?: {
16416
- id?: number;
16417
- value?: number;
16551
+ /**
16552
+ * value of this entry
16553
+ */
16554
+ value: (number | string | number) | number;
16555
+ /**
16556
+ * integer id of this entry
16557
+ */
16558
+ id: number;
16418
16559
  }[];
16419
16560
  }
16420
16561
  /** Schema dist/js/schema/properties_directory/structural/density.json */
@@ -16445,13 +16586,46 @@ export interface InChIKeyRepresentationSchema {
16445
16586
  name?: "inchi_key";
16446
16587
  value: string;
16447
16588
  }
16448
- /** Schema dist/js/schema/properties_directory/structural/lattice/lattice_bravais.json */
16449
- export interface LatticeImplicitSchema {
16450
- type: "CUB" | "BCC" | "FCC" | "TET" | "MCL" | "ORC" | "ORCC" | "ORCF" | "ORCI" | "HEX" | "BCT" | "TRI" | "MCLC" | "RHL";
16451
- units?: {
16452
- length?: "angstrom" | "bohr";
16453
- angle?: "degree" | "radian";
16454
- };
16589
+ /** Schema dist/js/schema/properties_directory/structural/lattice/lattice_vectors.json */
16590
+ export interface LatticeUnitsSchema {
16591
+ length?: "angstrom" | "bohr";
16592
+ angle?: "degree" | "radian";
16593
+ }
16594
+ /** Schema dist/js/schema/properties_directory/structural/lattice/type_enum.json */
16595
+ export type LatticeTypeEnum = "CUB" | "BCC" | "FCC" | "TET" | "MCL" | "ORC" | "ORCC" | "ORCF" | "ORCI" | "HEX" | "BCT" | "TRI" | "MCLC" | "RHL";
16596
+ /** Schema dist/js/schema/properties_directory/structural/lattice/type_extended_enum.json */
16597
+ export type LatticeTypeExtendedEnum = "BCC" | "BCT-1" | "BCT-2" | "CUB" | "FCC" | "HEX" | "MCL" | "MCLC-1" | "MCLC-2" | "MCLC-3" | "MCLC-4" | "MCLC-5" | "ORC" | "ORCC" | "ORCF-1" | "ORCF-2" | "ORCF-3" | "ORCI" | "RHL-1" | "RHL-2" | "TET" | "TRI_1a" | "TRI_1b" | "TRI_2a" | "TRI_2b";
16598
+ /** Schema dist/js/schema/properties_directory/structural/lattice/units/angle_enum.json */
16599
+ export type LatticeUnitsAngleEnum = "degree" | "radian";
16600
+ /** Schema dist/js/schema/properties_directory/structural/lattice/units/length_enum.json */
16601
+ export type LatticeUnitsLengthEnum = "angstrom" | "bohr";
16602
+ /** Schema dist/js/schema/properties_directory/structural/lattice/vectors/units_enum.json */
16603
+ export type LatticeVectorsUnitsEnum = "angstrom" | "bohr";
16604
+ /** Schema dist/js/schema/properties_directory/structural/lattice/vectors.json */
16605
+ export interface LatticeVectorsSchema {
16606
+ /**
16607
+ * @minItems 3
16608
+ * @maxItems 3
16609
+ */
16610
+ a: [number, number, number];
16611
+ /**
16612
+ * @minItems 3
16613
+ * @maxItems 3
16614
+ */
16615
+ b: [number, number, number];
16616
+ /**
16617
+ * @minItems 3
16618
+ * @maxItems 3
16619
+ */
16620
+ c: [number, number, number];
16621
+ /**
16622
+ * lattice parameter for fractional coordinates
16623
+ */
16624
+ alat?: number;
16625
+ units?: "angstrom" | "bohr";
16626
+ }
16627
+ /** Schema dist/js/schema/properties_directory/structural/lattice.json */
16628
+ export interface LatticeSchema {
16455
16629
  /**
16456
16630
  * length of the first lattice vector
16457
16631
  */
@@ -16476,42 +16650,7 @@ export interface LatticeImplicitSchema {
16476
16650
  * angle between first and third lattice vector
16477
16651
  */
16478
16652
  gamma: number;
16479
- }
16480
- /** Schema dist/js/schema/properties_directory/structural/lattice/lattice_vectors.json */
16481
- export interface LatticeExplicitUnit {
16482
- /**
16483
- * lattice parameter for fractional coordinates
16484
- */
16485
- alat?: number;
16486
- units?: "angstrom" | "bohr";
16487
- /**
16488
- * @minItems 3
16489
- * @maxItems 3
16490
- */
16491
- a: [number, number, number];
16492
- /**
16493
- * @minItems 3
16494
- * @maxItems 3
16495
- */
16496
- b: [number, number, number];
16497
- /**
16498
- * @minItems 3
16499
- * @maxItems 3
16500
- */
16501
- c: [number, number, number];
16502
- }
16503
- /** Schema dist/js/schema/properties_directory/structural/lattice/type_enum.json */
16504
- export type LatticeTypeEnum = "CUB" | "BCC" | "FCC" | "TET" | "MCL" | "ORC" | "ORCC" | "ORCF" | "ORCI" | "HEX" | "BCT" | "TRI" | "MCLC" | "RHL";
16505
- /** Schema dist/js/schema/properties_directory/structural/lattice/type_extended_enum.json */
16506
- export type LatticeTypeExtendedEnum = "BCC" | "BCT-1" | "BCT-2" | "CUB" | "FCC" | "HEX" | "MCL" | "MCLC-1" | "MCLC-2" | "MCLC-3" | "MCLC-4" | "MCLC-5" | "ORC" | "ORCC" | "ORCF-1" | "ORCF-2" | "ORCF-3" | "ORCI" | "RHL-1" | "RHL-2" | "TET" | "TRI_1a" | "TRI_1b" | "TRI_2a" | "TRI_2b";
16507
- /** Schema dist/js/schema/properties_directory/structural/lattice.json */
16508
- export interface LatticeSchema {
16509
16653
  vectors?: {
16510
- /**
16511
- * lattice parameter for fractional coordinates
16512
- */
16513
- alat?: number;
16514
- units?: "angstrom" | "bohr";
16515
16654
  /**
16516
16655
  * @minItems 3
16517
16656
  * @maxItems 3
@@ -16527,36 +16666,17 @@ export interface LatticeSchema {
16527
16666
  * @maxItems 3
16528
16667
  */
16529
16668
  c: [number, number, number];
16669
+ /**
16670
+ * lattice parameter for fractional coordinates
16671
+ */
16672
+ alat?: number;
16673
+ units?: "angstrom" | "bohr";
16530
16674
  };
16531
- type: "CUB" | "BCC" | "FCC" | "TET" | "MCL" | "ORC" | "ORCC" | "ORCF" | "ORCI" | "HEX" | "BCT" | "TRI" | "MCLC" | "RHL";
16675
+ type?: "CUB" | "BCC" | "FCC" | "TET" | "MCL" | "ORC" | "ORCC" | "ORCF" | "ORCI" | "HEX" | "BCT" | "TRI" | "MCLC" | "RHL";
16532
16676
  units?: {
16533
16677
  length?: "angstrom" | "bohr";
16534
16678
  angle?: "degree" | "radian";
16535
16679
  };
16536
- /**
16537
- * length of the first lattice vector
16538
- */
16539
- a: number;
16540
- /**
16541
- * length of the second lattice vector
16542
- */
16543
- b: number;
16544
- /**
16545
- * length of the third lattice vector
16546
- */
16547
- c: number;
16548
- /**
16549
- * angle between first and second lattice vector
16550
- */
16551
- alpha: number;
16552
- /**
16553
- * angle between second and third lattice vector
16554
- */
16555
- beta: number;
16556
- /**
16557
- * angle between first and third lattice vector
16558
- */
16559
- gamma: number;
16560
16680
  }
16561
16681
  /** Schema dist/js/schema/properties_directory/structural/magnetic_moments.json */
16562
16682
  /**
@@ -16564,15 +16684,18 @@ export interface LatticeSchema {
16564
16684
  */
16565
16685
  export interface MagneticMoments {
16566
16686
  name?: "magnetic_moments";
16567
- /**
16568
- * array of objects containing integer id each
16569
- */
16570
16687
  values?: {
16571
- value?: [number, number, number] | [boolean, boolean, boolean];
16688
+ /**
16689
+ * value of this entry
16690
+ *
16691
+ * @minItems 3
16692
+ * @maxItems 3
16693
+ */
16694
+ value: [number, number, number];
16572
16695
  /**
16573
16696
  * integer id of this entry
16574
16697
  */
16575
- id?: number;
16698
+ id: number;
16576
16699
  }[];
16577
16700
  units?: "uB";
16578
16701
  }
@@ -16590,7 +16713,7 @@ export type MolecularPatternSchema = ({
16590
16713
  /**
16591
16714
  * integer id of this entry
16592
16715
  */
16593
- id?: number;
16716
+ id: number;
16594
16717
  }[];
16595
16718
  /**
16596
16719
  * SMARTS string for classification of FG; https://en.wikipedia.org/wiki/SMILES_arbitrary_target_specification
@@ -16609,7 +16732,7 @@ export type MolecularPatternSchema = ({
16609
16732
  /**
16610
16733
  * integer id of this entry
16611
16734
  */
16612
- id?: number;
16735
+ id: number;
16613
16736
  }[];
16614
16737
  isAromatic?: boolean;
16615
16738
  } | {
@@ -16625,7 +16748,7 @@ export type MolecularPatternSchema = ({
16625
16748
  /**
16626
16749
  * integer id of this entry
16627
16750
  */
16628
- id?: number;
16751
+ id: number;
16629
16752
  }[];
16630
16753
  })[];
16631
16754
  /** Schema dist/js/schema/properties_directory/structural/p_norm.json */
@@ -16654,7 +16777,7 @@ export interface FunctionalGroupPatternSchema {
16654
16777
  /**
16655
16778
  * integer id of this entry
16656
16779
  */
16657
- id?: number;
16780
+ id: number;
16658
16781
  }[];
16659
16782
  /**
16660
16783
  * SMARTS string for classification of FG; https://en.wikipedia.org/wiki/SMILES_arbitrary_target_specification
@@ -16675,7 +16798,7 @@ export interface RingPatternSchema {
16675
16798
  /**
16676
16799
  * integer id of this entry
16677
16800
  */
16678
- id?: number;
16801
+ id: number;
16679
16802
  }[];
16680
16803
  isAromatic?: boolean;
16681
16804
  }
@@ -16696,7 +16819,7 @@ export interface SpecialBondPatternSchema {
16696
16819
  /**
16697
16820
  * integer id of this entry
16698
16821
  */
16699
- id?: number;
16822
+ id: number;
16700
16823
  }[];
16701
16824
  }
16702
16825
  /** Schema dist/js/schema/properties_directory/structural/symmetry.json */