@mat3ra/esse 2025.4.15-0 → 2025.4.17-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.
@@ -156,19 +156,7 @@ export interface AtomicSpeciesSchema {
156
156
  }[];
157
157
  }
158
158
  /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/cell.json */
159
- export type CellSchema = CellSchema1 & CellSchema2;
160
- export type CellSchema2 = {
161
- /**
162
- * CASE ( calculation == 'vc-relax' )
163
- */
164
- cell_dynamics?: "none" | "sd" | "damp-pr" | "damp-w" | "bfgs";
165
- } | {
166
- /**
167
- * CASE ( calculation == 'vc-md' )
168
- */
169
- cell_dynamics?: "none" | "pr" | "w";
170
- };
171
- export interface CellSchema1 {
159
+ export type CellSchema = {
172
160
  /**
173
161
  * Target pressure [KBar] in a variable-cell md or relaxation run.
174
162
  */
@@ -189,7 +177,17 @@ export interface CellSchema1 {
189
177
  * Select which of the cell parameters should be moved
190
178
  */
191
179
  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";
192
- }
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
+ });
193
191
  /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/cell_parameters.json */
194
192
  export interface CellParametersSchema {
195
193
  /**
@@ -552,29 +550,7 @@ export interface HubbardSchema {
552
550
  })[];
553
551
  }
554
552
  /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/ions.json */
555
- export type IonsSchema = IonsSchema1 & IonsSchema2;
556
- export type IonsSchema2 = {
557
- /**
558
- * CASE: calculation == 'relax'
559
- */
560
- ion_dynamics?: "bfgs" | "damp" | "fire";
561
- } | {
562
- /**
563
- * CASE: calculation == 'md'
564
- */
565
- ion_dynamics?: "verlet" | "langevin" | "langevin-smc";
566
- } | {
567
- /**
568
- * CASE: calculation == 'vc-relax'
569
- */
570
- ion_dynamics?: "bfgs" | "damp";
571
- } | {
572
- /**
573
- * CASE: calculation == 'vc-md'
574
- */
575
- ion_dynamics?: "beeman";
576
- };
577
- export interface IonsSchema1 {
553
+ export type IonsSchema = {
578
554
  ion_positions?: "default" | "from_input";
579
555
  ion_velocities?: "default" | "from_input";
580
556
  /**
@@ -653,7 +629,27 @@ export interface IonsSchema1 {
653
629
  * Determines the maximum value of dt in the FIRE minimization; dtmax = fire_dtmax*dt
654
630
  */
655
631
  fire_dtmax?: number;
656
- }
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
+ });
657
653
  /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/k_points.json */
658
654
  export interface KPointsSchema {
659
655
  card_option?: "tpiba" | "automatic" | "crystal" | "gamma" | "tpiba_b" | "crystal_b" | "tpiba_c" | "crystal_c";
@@ -694,8 +690,7 @@ export interface KPointsSchema {
694
690
  } | null;
695
691
  }
696
692
  /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x/system.json */
697
- export type SystemSchema = SystemSchema1 & SystemSchema2;
698
- export type SystemSchema1 = {
693
+ export type SystemSchema = ({
699
694
  /**
700
695
  * @minItems 6
701
696
  * @maxItems 6
@@ -708,8 +703,7 @@ export type SystemSchema1 = {
708
703
  cosAB?: number;
709
704
  cosAC?: number;
710
705
  cosBC?: number;
711
- };
712
- export interface SystemSchema2 {
706
+ }) & {
713
707
  ibrav: number;
714
708
  /**
715
709
  * number of atoms in the unit cell (ALL atoms, except if space_group is set, in which case, INEQUIVALENT atoms)
@@ -1073,7 +1067,7 @@ export interface SystemSchema2 {
1073
1067
  * Number of activated external ionic force fields.
1074
1068
  */
1075
1069
  nextffield?: number;
1076
- }
1070
+ };
1077
1071
  /** Schema dist/js/schema/3pse/file/applications/espresso/7.2/pw.x.json */
1078
1072
  export interface PwxMainSchema {
1079
1073
  "&CONTROL"?: {
@@ -6197,7 +6191,7 @@ export interface MaterialSchema {
6197
6191
  * lattice parameter for fractional coordinates
6198
6192
  */
6199
6193
  alat?: number;
6200
- units?: "km" | "m" | "cm" | "mm" | "um" | "nm" | "angstrom" | "a.u." | "bohr" | "pm";
6194
+ units?: "angstrom" | "bohr";
6201
6195
  /**
6202
6196
  * @minItems 3
6203
6197
  * @maxItems 3
@@ -12779,8 +12773,13 @@ export interface SpinPolarizationMixin {
12779
12773
  [k: string]: unknown;
12780
12774
  }
12781
12775
  /** Schema dist/js/schema/model/model_parameters.json */
12782
- export type ModelParameters = ModelParameters1 & ModelParameters2;
12783
- export type ModelParameters2 = {
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
+ } & ({
12784
12783
  functional?: "pz";
12785
12784
  [k: string]: unknown;
12786
12785
  } | {
@@ -12793,14 +12792,7 @@ export type ModelParameters2 = {
12793
12792
  functional?: "hse06" | "b3lyp";
12794
12793
  } | {
12795
12794
  functional?: "b2plyp";
12796
- };
12797
- export interface ModelParameters1 {
12798
- hubbardType?: "u";
12799
- spinPolarization?: "collinear" | "non-collinear";
12800
- spinOrbitCoupling?: boolean;
12801
- dispersionCorrection?: "dft-d2" | "dft-d3" | "xdm" | "ts";
12802
- [k: string]: unknown;
12803
- }
12795
+ });
12804
12796
  /** Schema dist/js/schema/model/model_without_method.json */
12805
12797
  export interface ModelWithoutMethodSchemaBase {
12806
12798
  /**
@@ -14999,18 +14991,7 @@ export interface ModelLocalDensityApproximation {
14999
14991
  tags?: string[];
15000
14992
  }
15001
14993
  /** Schema dist/js/schema/models_directory/legacy/dft.json */
15002
- export type LegacyModelDensityFunctionalTheory = LegacyModelDensityFunctionalTheory1 & LegacyModelDensityFunctionalTheory2;
15003
- export type LegacyModelDensityFunctionalTheory2 = {
15004
- subtype?: "lda";
15005
- functional?: "pz" | "pw" | "vwn" | "other";
15006
- } | {
15007
- subtype?: "gga";
15008
- functional?: "pbe" | "pbesol" | "pw91" | "other";
15009
- } | {
15010
- subtype?: "hybrid";
15011
- functional?: "b3lyp" | "hse06";
15012
- };
15013
- export interface LegacyModelDensityFunctionalTheory1 {
14994
+ export type LegacyModelDensityFunctionalTheory = {
15014
14995
  /**
15015
14996
  * general type of the model, eg. `dft`
15016
14997
  */
@@ -15038,9 +15019,18 @@ export interface LegacyModelDensityFunctionalTheory1 {
15038
15019
  data?: {};
15039
15020
  };
15040
15021
  [k: string]: unknown;
15041
- }
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
+ });
15042
15032
  /**
15043
- * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
15033
+ * This interface was referenced by `undefined`'s JSON-Schema
15044
15034
  * via the `definition` "lda".
15045
15035
  */
15046
15036
  export interface Lda {
@@ -15048,7 +15038,7 @@ export interface Lda {
15048
15038
  functional?: "pz" | "pw" | "vwn" | "other";
15049
15039
  }
15050
15040
  /**
15051
- * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
15041
+ * This interface was referenced by `undefined`'s JSON-Schema
15052
15042
  * via the `definition` "gga".
15053
15043
  */
15054
15044
  export interface Gga {
@@ -15056,7 +15046,7 @@ export interface Gga {
15056
15046
  functional?: "pbe" | "pbesol" | "pw91" | "other";
15057
15047
  }
15058
15048
  /**
15059
- * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
15049
+ * This interface was referenced by `undefined`'s JSON-Schema
15060
15050
  * via the `definition` "hybrid".
15061
15051
  */
15062
15052
  export interface Hybrid {
@@ -16493,7 +16483,7 @@ export interface LatticeExplicitUnit {
16493
16483
  * lattice parameter for fractional coordinates
16494
16484
  */
16495
16485
  alat?: number;
16496
- units?: "km" | "m" | "cm" | "mm" | "um" | "nm" | "angstrom" | "a.u." | "bohr" | "pm";
16486
+ units?: "angstrom" | "bohr";
16497
16487
  /**
16498
16488
  * @minItems 3
16499
16489
  * @maxItems 3
@@ -16521,7 +16511,7 @@ export interface LatticeSchema {
16521
16511
  * lattice parameter for fractional coordinates
16522
16512
  */
16523
16513
  alat?: number;
16524
- units?: "km" | "m" | "cm" | "mm" | "um" | "nm" | "angstrom" | "a.u." | "bohr" | "pm";
16514
+ units?: "angstrom" | "bohr";
16525
16515
  /**
16526
16516
  * @minItems 3
16527
16517
  * @maxItems 3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mat3ra/esse",
3
- "version": "2025.4.15-0",
3
+ "version": "2025.4.17-0",
4
4
  "description": "Mat3ra's Excellent Source of Schemas and Examples (ESSE) for Digital Materials R&D",
5
5
  "scripts": {
6
6
  "transpile": "tsc -p tsconfig-transpile.json",
@@ -15,7 +15,7 @@
15
15
  "default": 1
16
16
  },
17
17
  "units": {
18
- "$ref": "../../../definitions/units.json#/length"
18
+ "$ref": "../../../definitions/units.json#/length_atomic"
19
19
  }
20
20
  }
21
21
  }