@mat3ra/esse 2025.8.9-0 → 2025.8.14-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.
@@ -140,19 +140,7 @@ export interface AtomicSpeciesSchema {
140
140
  }[];
141
141
  }
142
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 {
143
+ export type CellSchema = {
156
144
  /**
157
145
  * Target pressure [KBar] in a variable-cell md or relaxation run.
158
146
  */
@@ -173,7 +161,17 @@ export interface CellSchema1 {
173
161
  * Select which of the cell parameters should be moved
174
162
  */
175
163
  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";
176
- }
164
+ } & ({
165
+ /**
166
+ * CASE ( calculation == 'vc-relax' )
167
+ */
168
+ cell_dynamics?: "none" | "sd" | "damp-pr" | "damp-w" | "bfgs";
169
+ } | {
170
+ /**
171
+ * CASE ( calculation == 'vc-md' )
172
+ */
173
+ cell_dynamics?: "none" | "pr" | "w";
174
+ });
177
175
  /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/cell_parameters.json */
178
176
  export interface CellParametersSchema {
179
177
  /**
@@ -536,29 +534,7 @@ export interface HubbardSchema {
536
534
  })[];
537
535
  }
538
536
  /** 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 {
537
+ export type IonsSchema = {
562
538
  ion_positions?: "default" | "from_input";
563
539
  ion_velocities?: "default" | "from_input";
564
540
  /**
@@ -637,7 +613,27 @@ export interface IonsSchema1 {
637
613
  * Determines the maximum value of dt in the FIRE minimization; dtmax = fire_dtmax*dt
638
614
  */
639
615
  fire_dtmax?: number;
640
- }
616
+ } & ({
617
+ /**
618
+ * CASE: calculation == 'relax'
619
+ */
620
+ ion_dynamics?: "bfgs" | "damp" | "fire";
621
+ } | {
622
+ /**
623
+ * CASE: calculation == 'md'
624
+ */
625
+ ion_dynamics?: "verlet" | "langevin" | "langevin-smc";
626
+ } | {
627
+ /**
628
+ * CASE: calculation == 'vc-relax'
629
+ */
630
+ ion_dynamics?: "bfgs" | "damp";
631
+ } | {
632
+ /**
633
+ * CASE: calculation == 'vc-md'
634
+ */
635
+ ion_dynamics?: "beeman";
636
+ });
641
637
  /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/k_points.json */
642
638
  export interface KPointsSchema {
643
639
  card_option?: "tpiba" | "automatic" | "crystal" | "gamma" | "tpiba_b" | "crystal_b" | "tpiba_c" | "crystal_c";
@@ -678,8 +674,7 @@ export interface KPointsSchema {
678
674
  } | null;
679
675
  }
680
676
  /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x/system.json */
681
- export type SystemSchema = SystemSchema1 & SystemSchema2;
682
- export type SystemSchema1 = {
677
+ export type SystemSchema = ({
683
678
  /**
684
679
  * @minItems 6
685
680
  * @maxItems 6
@@ -692,8 +687,7 @@ export type SystemSchema1 = {
692
687
  cosAB?: number;
693
688
  cosAC?: number;
694
689
  cosBC?: number;
695
- };
696
- export interface SystemSchema2 {
690
+ }) & {
697
691
  ibrav: number;
698
692
  /**
699
693
  * number of atoms in the unit cell (ALL atoms, except if space_group is set, in which case, INEQUIVALENT atoms)
@@ -1057,7 +1051,7 @@ export interface SystemSchema2 {
1057
1051
  * Number of activated external ionic force fields.
1058
1052
  */
1059
1053
  nextffield?: number;
1060
- }
1054
+ };
1061
1055
  /** Schema dist/js/schema/apse/file/applications/espresso/7.2/pw.x.json */
1062
1056
  export interface PwxMainSchema {
1063
1057
  "&CONTROL"?: {
@@ -6404,7 +6398,7 @@ export interface MaterialSchema {
6404
6398
  /**
6405
6399
  * value of this entry
6406
6400
  */
6407
- value: (number | string | number) | number;
6401
+ value: (number | string) | number;
6408
6402
  /**
6409
6403
  * integer id of this entry
6410
6404
  */
@@ -25481,7 +25475,7 @@ export interface IdealCrystalSchema {
25481
25475
  /**
25482
25476
  * value of this entry
25483
25477
  */
25484
- value: (number | string | number) | number;
25478
+ value: (number | string) | number;
25485
25479
  /**
25486
25480
  * integer id of this entry
25487
25481
  */
@@ -30091,7 +30085,7 @@ export interface CrystalSiteSchema {
30091
30085
  /**
30092
30086
  * value of this entry
30093
30087
  */
30094
- value: (number | string | number) | number;
30088
+ value: (number | string) | number;
30095
30089
  /**
30096
30090
  * integer id of this entry
30097
30091
  */
@@ -30361,7 +30355,7 @@ export interface PointDefectSiteSchema {
30361
30355
  /**
30362
30356
  * value of this entry
30363
30357
  */
30364
- value: (number | string | number) | number;
30358
+ value: (number | string) | number;
30365
30359
  /**
30366
30360
  * integer id of this entry
30367
30361
  */
@@ -30639,7 +30633,7 @@ export interface VoidRegionSchema {
30639
30633
  /**
30640
30634
  * value of this entry
30641
30635
  */
30642
- value: (number | string | number) | number;
30636
+ value: (number | string) | number;
30643
30637
  /**
30644
30638
  * integer id of this entry
30645
30639
  */
@@ -30955,7 +30949,7 @@ export interface CrystalSchema {
30955
30949
  /**
30956
30950
  * value of this entry
30957
30951
  */
30958
- value: (number | string | number) | number;
30952
+ value: (number | string) | number;
30959
30953
  /**
30960
30954
  * integer id of this entry
30961
30955
  */
@@ -31293,7 +31287,7 @@ export interface VacuumConfigurationSchema {
31293
31287
  /**
31294
31288
  * value of this entry
31295
31289
  */
31296
- value: (number | string | number) | number;
31290
+ value: (number | string) | number;
31297
31291
  /**
31298
31292
  * integer id of this entry
31299
31293
  */
@@ -31582,7 +31576,7 @@ export interface CrystalLatticeLinesSchema {
31582
31576
  /**
31583
31577
  * value of this entry
31584
31578
  */
31585
- value: (number | string | number) | number;
31579
+ value: (number | string) | number;
31586
31580
  /**
31587
31581
  * integer id of this entry
31588
31582
  */
@@ -31892,7 +31886,7 @@ export interface CrystalLatticeLinesUniqueRepeatedSchema {
31892
31886
  /**
31893
31887
  * value of this entry
31894
31888
  */
31895
- value: (number | string | number) | number;
31889
+ value: (number | string) | number;
31896
31890
  /**
31897
31891
  * integer id of this entry
31898
31892
  */
@@ -32161,7 +32155,7 @@ export interface CrystalLatticeBaseSchema {
32161
32155
  /**
32162
32156
  * value of this entry
32163
32157
  */
32164
- value: (number | string | number) | number;
32158
+ value: (number | string) | number;
32165
32159
  /**
32166
32160
  * integer id of this entry
32167
32161
  */
@@ -32438,7 +32432,7 @@ export interface NonUniformlyStrainedCrystalConfigurationSchema {
32438
32432
  /**
32439
32433
  * value of this entry
32440
32434
  */
32441
- value: (number | string | number) | number;
32435
+ value: (number | string) | number;
32442
32436
  /**
32443
32437
  * integer id of this entry
32444
32438
  */
@@ -32708,7 +32702,7 @@ export interface UniformlyStrainedCrystalConfigurationSchema {
32708
32702
  /**
32709
32703
  * value of this entry
32710
32704
  */
32711
- value: (number | string | number) | number;
32705
+ value: (number | string) | number;
32712
32706
  /**
32713
32707
  * integer id of this entry
32714
32708
  */
@@ -32977,7 +32971,7 @@ export interface SupercellConfigurationSchema {
32977
32971
  /**
32978
32972
  * value of this entry
32979
32973
  */
32980
- value: (number | string | number) | number;
32974
+ value: (number | string) | number;
32981
32975
  /**
32982
32976
  * integer id of this entry
32983
32977
  */
@@ -33281,7 +33275,7 @@ export interface AtomicLayersSchema {
33281
33275
  /**
33282
33276
  * value of this entry
33283
33277
  */
33284
- value: (number | string | number) | number;
33278
+ value: (number | string) | number;
33285
33279
  /**
33286
33280
  * integer id of this entry
33287
33281
  */
@@ -33584,7 +33578,7 @@ export interface AtomicLayersUniqueSchema {
33584
33578
  /**
33585
33579
  * value of this entry
33586
33580
  */
33587
- value: (number | string | number) | number;
33581
+ value: (number | string) | number;
33588
33582
  /**
33589
33583
  * integer id of this entry
33590
33584
  */
@@ -33877,7 +33871,7 @@ export interface AtomicLayersUniqueRepeatedSchema {
33877
33871
  /**
33878
33872
  * value of this entry
33879
33873
  */
33880
- value: (number | string | number) | number;
33874
+ value: (number | string) | number;
33881
33875
  /**
33882
33876
  * integer id of this entry
33883
33877
  */
@@ -34153,7 +34147,7 @@ export interface CrystalLatticePlanesSchema {
34153
34147
  /**
34154
34148
  * value of this entry
34155
34149
  */
34156
- value: (number | string | number) | number;
34150
+ value: (number | string) | number;
34157
34151
  /**
34158
34152
  * integer id of this entry
34159
34153
  */
@@ -35341,7 +35335,7 @@ export interface PerturbationSchema {
35341
35335
  /**
35342
35336
  * value of this entry
35343
35337
  */
35344
- value: (number | string | number) | number;
35338
+ value: (number | string) | number;
35345
35339
  /**
35346
35340
  * integer id of this entry
35347
35341
  */
@@ -41959,8 +41953,13 @@ export interface SpinPolarizationMixin {
41959
41953
  [k: string]: unknown;
41960
41954
  }
41961
41955
  /** Schema dist/js/schema/model/model_parameters.json */
41962
- export type ModelParameters = ModelParameters1 & ModelParameters2;
41963
- export type ModelParameters2 = {
41956
+ export type ModelParameters = {
41957
+ hubbardType?: "u";
41958
+ spinPolarization?: "collinear" | "non-collinear";
41959
+ spinOrbitCoupling?: boolean;
41960
+ dispersionCorrection?: "dft-d2" | "dft-d3" | "xdm" | "ts";
41961
+ [k: string]: unknown;
41962
+ } & ({
41964
41963
  functional?: "pz";
41965
41964
  [k: string]: unknown;
41966
41965
  } | {
@@ -41973,14 +41972,7 @@ export type ModelParameters2 = {
41973
41972
  functional?: "hse06" | "b3lyp";
41974
41973
  } | {
41975
41974
  functional?: "b2plyp";
41976
- };
41977
- export interface ModelParameters1 {
41978
- hubbardType?: "u";
41979
- spinPolarization?: "collinear" | "non-collinear";
41980
- spinOrbitCoupling?: boolean;
41981
- dispersionCorrection?: "dft-d2" | "dft-d3" | "xdm" | "ts";
41982
- [k: string]: unknown;
41983
- }
41975
+ });
41984
41976
  /** Schema dist/js/schema/model/model_without_method.json */
41985
41977
  export interface ModelWithoutMethodSchemaBase {
41986
41978
  /**
@@ -44179,18 +44171,7 @@ export interface ModelLocalDensityApproximation {
44179
44171
  tags?: string[];
44180
44172
  }
44181
44173
  /** Schema dist/js/schema/models_directory/legacy/dft.json */
44182
- export type LegacyModelDensityFunctionalTheory = LegacyModelDensityFunctionalTheory1 & LegacyModelDensityFunctionalTheory2;
44183
- export type LegacyModelDensityFunctionalTheory2 = {
44184
- subtype?: "lda";
44185
- functional?: "pz" | "pw" | "vwn" | "other";
44186
- } | {
44187
- subtype?: "gga";
44188
- functional?: "pbe" | "pbesol" | "pw91" | "other";
44189
- } | {
44190
- subtype?: "hybrid";
44191
- functional?: "b3lyp" | "hse06";
44192
- };
44193
- export interface LegacyModelDensityFunctionalTheory1 {
44174
+ export type LegacyModelDensityFunctionalTheory = {
44194
44175
  /**
44195
44176
  * general type of the model, eg. `dft`
44196
44177
  */
@@ -44218,9 +44199,18 @@ export interface LegacyModelDensityFunctionalTheory1 {
44218
44199
  data?: {};
44219
44200
  };
44220
44201
  [k: string]: unknown;
44221
- }
44202
+ } & ({
44203
+ subtype?: "lda";
44204
+ functional?: "pz" | "pw" | "vwn" | "other";
44205
+ } | {
44206
+ subtype?: "gga";
44207
+ functional?: "pbe" | "pbesol" | "pw91" | "other";
44208
+ } | {
44209
+ subtype?: "hybrid";
44210
+ functional?: "b3lyp" | "hse06";
44211
+ });
44222
44212
  /**
44223
- * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
44213
+ * This interface was referenced by `undefined`'s JSON-Schema
44224
44214
  * via the `definition` "lda".
44225
44215
  */
44226
44216
  export interface Lda {
@@ -44228,7 +44218,7 @@ export interface Lda {
44228
44218
  functional?: "pz" | "pw" | "vwn" | "other";
44229
44219
  }
44230
44220
  /**
44231
- * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
44221
+ * This interface was referenced by `undefined`'s JSON-Schema
44232
44222
  * via the `definition` "gga".
44233
44223
  */
44234
44224
  export interface Gga {
@@ -44236,7 +44226,7 @@ export interface Gga {
44236
44226
  functional?: "pbe" | "pbesol" | "pw91" | "other";
44237
44227
  }
44238
44228
  /**
44239
- * This interface was referenced by `LegacyModelDensityFunctionalTheory1`'s JSON-Schema
44229
+ * This interface was referenced by `undefined`'s JSON-Schema
44240
44230
  * via the `definition` "hybrid".
44241
44231
  */
44242
44232
  export interface Hybrid {
@@ -45645,7 +45635,7 @@ export type AtomicLabelsSchema = {
45645
45635
  /**
45646
45636
  * value of this entry
45647
45637
  */
45648
- value: (number | string | number) | number;
45638
+ value: (number | string) | number;
45649
45639
  /**
45650
45640
  * integer id of this entry
45651
45641
  */
@@ -45716,7 +45706,7 @@ export interface BasisSchema {
45716
45706
  /**
45717
45707
  * value of this entry
45718
45708
  */
45719
- value: (number | string | number) | number;
45709
+ value: (number | string) | number;
45720
45710
  /**
45721
45711
  * integer id of this entry
45722
45712
  */
@@ -46991,6 +46981,7 @@ export interface TemplateSchema {
46991
46981
  */
46992
46982
  name: string;
46993
46983
  }[];
46984
+ isManuallyChanged?: boolean;
46994
46985
  /**
46995
46986
  * Input file name. e.g. pw_scf.in
46996
46987
  */
@@ -47002,7 +46993,7 @@ export interface TemplateSchema {
47002
46993
  /**
47003
46994
  * Rendered content of the input file. e.g. &CONTROL calculation='scf' ...
47004
46995
  */
47005
- rendered: string;
46996
+ rendered?: string;
47006
46997
  /**
47007
46998
  * entity identity
47008
46999
  */
@@ -50663,7 +50654,7 @@ export interface ExecutionUnitSchemaForPhysicsBasedSimulationEnginesDefinedUsing
50663
50654
  /**
50664
50655
  * Rendered content of the input file. e.g. &CONTROL calculation='scf' ...
50665
50656
  */
50666
- rendered: string;
50657
+ rendered?: string;
50667
50658
  } | {
50668
50659
  templateId?: string;
50669
50660
  templateName?: string;
@@ -51205,7 +51196,7 @@ export interface ExecutionUnitSchemaForScriptingBasedApplications {
51205
51196
  /**
51206
51197
  * Rendered content of the input file. e.g. &CONTROL calculation='scf' ...
51207
51198
  */
51208
- rendered: string;
51199
+ rendered?: string;
51209
51200
  } | {
51210
51201
  templateId?: string;
51211
51202
  templateName?: string;
@@ -54962,7 +54953,7 @@ export interface ExecutionUnitInputSchemaForPhysicsBasedSimulationEngines {
54962
54953
  /**
54963
54954
  * Rendered content of the input file. e.g. &CONTROL calculation='scf' ...
54964
54955
  */
54965
- rendered: string;
54956
+ rendered?: string;
54966
54957
  } | {
54967
54958
  templateId?: string;
54968
54959
  templateName?: string;
@@ -54985,7 +54976,7 @@ export interface ExecutionUnitInputItemSchemaForPhysicsBasedSimulationEngines {
54985
54976
  /**
54986
54977
  * Rendered content of the input file. e.g. &CONTROL calculation='scf' ...
54987
54978
  */
54988
- rendered: string;
54979
+ rendered?: string;
54989
54980
  }
54990
54981
  /** Schema dist/js/schema/workflow/unit/input/_inputItemId.json */
54991
54982
  export interface ExecutionUnitInputIdItemSchemaForPhysicsBasedSimulationEngines {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mat3ra/esse",
3
- "version": "2025.8.9-0",
3
+ "version": "2025.8.14-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",
@@ -27,6 +27,9 @@
27
27
  "description": "render context provider names",
28
28
  "$ref": "../workflow/unit/runtime/_runtime_item_name_object.json"
29
29
  }
30
+ },
31
+ "isManuallyChanged": {
32
+ "type": "boolean"
30
33
  }
31
34
  },
32
35
  "required": [
@@ -19,7 +19,6 @@
19
19
  },
20
20
  "required": [
21
21
  "name",
22
- "content",
23
- "rendered"
22
+ "content"
24
23
  ]
25
24
  }