@mat3ra/esse 2025.4.3-0 → 2025.4.15-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 (48) hide show
  1. package/dist/js/example/core/reusable/band_gap.json +1 -1
  2. package/dist/js/example/methods_directory/physical/psp/file.json +20 -1
  3. package/dist/js/example/methods_directory/physical/psp.json +20 -1
  4. package/dist/js/example/properties_directory/non_scalar/band_gaps.json +2 -2
  5. package/dist/js/example/properties_directory/workflow/convergence/electronic.json +1 -1
  6. package/dist/js/schema/core/reusable/band_gap.json +1 -1
  7. package/dist/js/schema/core/reusable/energy.json +1 -1
  8. package/dist/js/schema/core/reusable/energy_accuracy_levels.json +32 -0
  9. package/dist/js/schema/core/reusable/scalar_with_accuracy_levels.json +24 -0
  10. package/dist/js/schema/definitions/units.json +2 -2
  11. package/dist/js/schema/element.json +1 -1
  12. package/dist/js/schema/methods_directory/physical/psp/file.json +77 -0
  13. package/dist/js/schema/methods_directory/physical/psp/file_data_item.json +77 -0
  14. package/dist/js/schema/methods_directory/physical/psp.json +77 -0
  15. package/dist/js/schema/properties_directory/elemental/ionization_potential.json +1 -1
  16. package/dist/js/schema/properties_directory/non_scalar/average_potential_profile.json +1 -1
  17. package/dist/js/schema/properties_directory/non_scalar/band_gaps.json +1 -1
  18. package/dist/js/schema/properties_directory/non_scalar/band_structure.json +1 -1
  19. package/dist/js/schema/properties_directory/non_scalar/density_of_states.json +1 -1
  20. package/dist/js/schema/properties_directory/non_scalar/potential_profile.json +1 -1
  21. package/dist/js/schema/properties_directory/non_scalar/reaction_energy_profile.json +1 -1
  22. package/dist/js/schema/properties_directory/non_scalar/total_energy_contributions.json +1 -1
  23. package/dist/js/schema/properties_directory/scalar/electron_affinity.json +1 -1
  24. package/dist/js/schema/properties_directory/scalar/fermi_energy.json +1 -1
  25. package/dist/js/schema/properties_directory/scalar/formation_energy.json +1 -1
  26. package/dist/js/schema/properties_directory/scalar/ionization_potential.json +1 -1
  27. package/dist/js/schema/properties_directory/scalar/reaction_energy_barrier.json +1 -1
  28. package/dist/js/schema/properties_directory/scalar/surface_energy.json +1 -1
  29. package/dist/js/schema/properties_directory/scalar/total_energy.json +1 -1
  30. package/dist/js/schema/properties_directory/scalar/total_force.json +1 -1
  31. package/dist/js/schema/properties_directory/scalar/valence_band_offset.json +1 -1
  32. package/dist/js/schema/properties_directory/scalar/zero_point_energy.json +1 -1
  33. package/dist/js/schema/properties_directory/structural/atomic_forces.json +1 -1
  34. package/dist/js/schema/properties_directory/workflow/convergence/electronic.json +1 -1
  35. package/dist/js/schema/properties_directory/workflow/convergence/ionic.json +1 -1
  36. package/dist/js/schemas.json +1 -1
  37. package/dist/js/types.d.ts +177 -26
  38. package/example/core/reusable/band_gap.json +1 -1
  39. package/example/methods_directory/physical/psp/file.json +20 -1
  40. package/example/properties_directory/non-scalar/band_gaps.json +2 -2
  41. package/example/properties_directory/workflow/convergence/electronic.json +1 -1
  42. package/package.json +29 -29
  43. package/schema/core/reusable/energy_accuracy_levels.json +23 -0
  44. package/schema/core/reusable/scalar_with_accuracy_levels.json +25 -0
  45. package/schema/definitions/units.json +2 -2
  46. package/schema/methods_directory/physical/psp/file_data_item.json +21 -0
  47. package/schema/properties_directory/workflow/convergence/electronic.json +1 -1
  48. package/schema/properties_directory/workflow/convergence/ionic.json +1 -1
@@ -56,7 +56,23 @@ export interface NISTJARVISDbEntrySchema {
56
56
  * @minItems 3
57
57
  * @maxItems 3
58
58
  */
59
- lattice_mat?: [[number, number, number], [number, number, number], [number, number, number]];
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
+ ];
60
76
  /**
61
77
  * Atomic coordinates for each atom in the unit cell
62
78
  *
@@ -1605,7 +1621,23 @@ export interface DimensionalGridSchema {
1605
1621
  * @minItems 3
1606
1622
  * @maxItems 3
1607
1623
  */
1608
- export type DimensionalTensorSchema = [[number, number, number], [number, number, number], [number, number, number]];
1624
+ export type DimensionalTensorSchema = [
1625
+ [
1626
+ number,
1627
+ number,
1628
+ number
1629
+ ],
1630
+ [
1631
+ number,
1632
+ number,
1633
+ number
1634
+ ],
1635
+ [
1636
+ number,
1637
+ number,
1638
+ number
1639
+ ]
1640
+ ];
1609
1641
  /** Schema dist/js/schema/core/abstract/3d_vector_basis.json */
1610
1642
  export interface DimensionalVectorBasis {
1611
1643
  /**
@@ -2619,7 +2651,7 @@ export interface BandGapSchema {
2619
2651
  eigenvalueValence?: number;
2620
2652
  spin?: number;
2621
2653
  type: "direct" | "indirect";
2622
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
2654
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
2623
2655
  value: number;
2624
2656
  }
2625
2657
  /** Schema dist/js/schema/core/reusable/categories.json */
@@ -2720,7 +2752,19 @@ export interface DielectricTensor {
2720
2752
  /** Schema dist/js/schema/core/reusable/energy.json */
2721
2753
  export interface EnergySchema {
2722
2754
  name: string;
2723
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
2755
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
2756
+ value: number;
2757
+ }
2758
+ /** Schema dist/js/schema/core/reusable/energy_accuracy_levels.json */
2759
+ export interface ReusableSchemaForEnergyValueWithUnitCorrespondingToASpecificAccuracyLevelEGUsedForSuggestedWavefunctionAndChargeDensityCutoffs {
2760
+ /**
2761
+ * Unit of the energy value corresponding to a accuracy_level. The values are expressed in Ry.
2762
+ */
2763
+ unit: "Ry";
2764
+ /**
2765
+ * Accuracy level determines suggested scalar value.
2766
+ */
2767
+ accuracy_level: "standard" | "low" | "high";
2724
2768
  value: number;
2725
2769
  }
2726
2770
  /** Schema dist/js/schema/core/reusable/file_metadata.json */
@@ -2779,6 +2823,14 @@ export interface ObjectStorageContainerData {
2779
2823
  */
2780
2824
  TIMESTAMP?: string;
2781
2825
  }
2826
+ /** Schema dist/js/schema/core/reusable/scalar_with_accuracy_levels.json */
2827
+ export interface ReusableSchemaForScalarValuesWithAccuracyLevels {
2828
+ /**
2829
+ * Accuracy level determines suggested scalar value.
2830
+ */
2831
+ accuracy_level: "standard" | "low" | "high";
2832
+ value: number;
2833
+ }
2782
2834
  /** Schema dist/js/schema/definitions/constants.json */
2783
2835
  /**
2784
2836
  * Fundamental physical constants, 2022 NIST CODATA (https://doi.org/10.48550/arXiv.2409.03787)
@@ -2835,7 +2887,7 @@ export interface ElementSchema {
2835
2887
  value: number;
2836
2888
  } | {
2837
2889
  name?: "ionization_potential";
2838
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
2890
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
2839
2891
  value: number;
2840
2892
  })[];
2841
2893
  }
@@ -11790,6 +11842,39 @@ export interface PseudopotentialFile {
11790
11842
  * name of the data category
11791
11843
  */
11792
11844
  name?: "pseudopotential";
11845
+ /**
11846
+ * Suggested cutoff values for wave function and charge density.
11847
+ */
11848
+ cutoffs?: {
11849
+ /**
11850
+ * Energy cutoff values for wavefunction plane wave expansion.
11851
+ */
11852
+ wavefunction?: {
11853
+ /**
11854
+ * Unit of the energy value corresponding to a accuracy_level. The values are expressed in Ry.
11855
+ */
11856
+ unit: "Ry";
11857
+ /**
11858
+ * Accuracy level determines suggested scalar value.
11859
+ */
11860
+ accuracy_level: "standard" | "low" | "high";
11861
+ value: number;
11862
+ }[];
11863
+ /**
11864
+ * Energy cutoff values for charge density plane wave expansion.
11865
+ */
11866
+ density?: {
11867
+ /**
11868
+ * Unit of the energy value corresponding to a accuracy_level. The values are expressed in Ry.
11869
+ */
11870
+ unit: "Ry";
11871
+ /**
11872
+ * Accuracy level determines suggested scalar value.
11873
+ */
11874
+ accuracy_level: "standard" | "low" | "high";
11875
+ value: number;
11876
+ }[];
11877
+ };
11793
11878
  };
11794
11879
  /**
11795
11880
  * TODO: remove in the future
@@ -11861,6 +11946,39 @@ export interface FileDataItem {
11861
11946
  * name of the data category
11862
11947
  */
11863
11948
  name?: "pseudopotential";
11949
+ /**
11950
+ * Suggested cutoff values for wave function and charge density.
11951
+ */
11952
+ cutoffs?: {
11953
+ /**
11954
+ * Energy cutoff values for wavefunction plane wave expansion.
11955
+ */
11956
+ wavefunction?: {
11957
+ /**
11958
+ * Unit of the energy value corresponding to a accuracy_level. The values are expressed in Ry.
11959
+ */
11960
+ unit: "Ry";
11961
+ /**
11962
+ * Accuracy level determines suggested scalar value.
11963
+ */
11964
+ accuracy_level: "standard" | "low" | "high";
11965
+ value: number;
11966
+ }[];
11967
+ /**
11968
+ * Energy cutoff values for charge density plane wave expansion.
11969
+ */
11970
+ density?: {
11971
+ /**
11972
+ * Unit of the energy value corresponding to a accuracy_level. The values are expressed in Ry.
11973
+ */
11974
+ unit: "Ry";
11975
+ /**
11976
+ * Accuracy level determines suggested scalar value.
11977
+ */
11978
+ accuracy_level: "standard" | "low" | "high";
11979
+ value: number;
11980
+ }[];
11981
+ };
11864
11982
  }
11865
11983
  /** Schema dist/js/schema/methods_directory/physical/psp.json */
11866
11984
  /**
@@ -12000,6 +12118,39 @@ export interface UnitMethodPseudopotential {
12000
12118
  * name of the data category
12001
12119
  */
12002
12120
  name?: "pseudopotential";
12121
+ /**
12122
+ * Suggested cutoff values for wave function and charge density.
12123
+ */
12124
+ cutoffs?: {
12125
+ /**
12126
+ * Energy cutoff values for wavefunction plane wave expansion.
12127
+ */
12128
+ wavefunction?: {
12129
+ /**
12130
+ * Unit of the energy value corresponding to a accuracy_level. The values are expressed in Ry.
12131
+ */
12132
+ unit: "Ry";
12133
+ /**
12134
+ * Accuracy level determines suggested scalar value.
12135
+ */
12136
+ accuracy_level: "standard" | "low" | "high";
12137
+ value: number;
12138
+ }[];
12139
+ /**
12140
+ * Energy cutoff values for charge density plane wave expansion.
12141
+ */
12142
+ density?: {
12143
+ /**
12144
+ * Unit of the energy value corresponding to a accuracy_level. The values are expressed in Ry.
12145
+ */
12146
+ unit: "Ry";
12147
+ /**
12148
+ * Accuracy level determines suggested scalar value.
12149
+ */
12150
+ accuracy_level: "standard" | "low" | "high";
12151
+ value: number;
12152
+ }[];
12153
+ };
12003
12154
  };
12004
12155
  /**
12005
12156
  * TODO: remove in the future
@@ -15418,7 +15569,7 @@ export interface Electronegativity {
15418
15569
  */
15419
15570
  export interface IonizationPotential {
15420
15571
  name?: "ionization_potential";
15421
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
15572
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
15422
15573
  value: number;
15423
15574
  }
15424
15575
  /** Schema dist/js/schema/properties_directory/non_scalar/average_potential_profile.json */
@@ -15441,7 +15592,7 @@ export interface AveragePotentialProfileSchema {
15441
15592
  /**
15442
15593
  * units for an axis
15443
15594
  */
15444
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
15595
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
15445
15596
  };
15446
15597
  name?: "average_potential_profile";
15447
15598
  /**
@@ -15483,7 +15634,7 @@ export interface BandGapsSchema {
15483
15634
  eigenvalueValence?: number;
15484
15635
  spin?: number;
15485
15636
  type: "direct" | "indirect";
15486
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
15637
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
15487
15638
  value: number;
15488
15639
  }[];
15489
15640
  eigenvalues?: {
@@ -15520,7 +15671,7 @@ export interface BandStructureSchema {
15520
15671
  /**
15521
15672
  * units for an axis
15522
15673
  */
15523
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
15674
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
15524
15675
  };
15525
15676
  name?: "band_structure";
15526
15677
  /**
@@ -15584,7 +15735,7 @@ export interface DensityOfStatesSchema {
15584
15735
  /**
15585
15736
  * units for an axis
15586
15737
  */
15587
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
15738
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
15588
15739
  };
15589
15740
  yAxis: {
15590
15741
  /**
@@ -15895,7 +16046,7 @@ export interface PotentialProfileSchema {
15895
16046
  /**
15896
16047
  * units for an axis
15897
16048
  */
15898
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
16049
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
15899
16050
  };
15900
16051
  name?: "potential_profile";
15901
16052
  /**
@@ -15930,7 +16081,7 @@ export interface ReactionEnergyProfileSchema {
15930
16081
  /**
15931
16082
  * units for an axis
15932
16083
  */
15933
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
16084
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
15934
16085
  };
15935
16086
  name?: "reaction_energy_profile";
15936
16087
  /**
@@ -16049,7 +16200,7 @@ export interface TotalEnergyContributionsSchema {
16049
16200
  value: number;
16050
16201
  };
16051
16202
  name?: "total_energy_contributions";
16052
- units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom";
16203
+ units?: "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
16053
16204
  }
16054
16205
  /** Schema dist/js/schema/properties_directory/non_scalar/vibrational_spectrum.json */
16055
16206
  export interface VibrationalSpectrumSchema {
@@ -16089,25 +16240,25 @@ export interface VibrationalSpectrumSchema {
16089
16240
  /** Schema dist/js/schema/properties_directory/scalar/electron_affinity.json */
16090
16241
  export interface ElectronAffinitySchema {
16091
16242
  name: "electron_affinity";
16092
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16243
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16093
16244
  value: number;
16094
16245
  }
16095
16246
  /** Schema dist/js/schema/properties_directory/scalar/fermi_energy.json */
16096
16247
  export interface FermiEnergySchema {
16097
16248
  name: "fermi_energy";
16098
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16249
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16099
16250
  value: number;
16100
16251
  }
16101
16252
  /** Schema dist/js/schema/properties_directory/scalar/formation_energy.json */
16102
16253
  export interface FormationEnergySchema {
16103
16254
  name: "formation_energy";
16104
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16255
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16105
16256
  value: number;
16106
16257
  }
16107
16258
  /** Schema dist/js/schema/properties_directory/scalar/ionization_potential.json */
16108
16259
  export interface IonizationPotentialSchema {
16109
16260
  name: "ionization_potential";
16110
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16261
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16111
16262
  value: number;
16112
16263
  }
16113
16264
  /** Schema dist/js/schema/properties_directory/scalar/pressure.json */
@@ -16122,37 +16273,37 @@ export interface Pressure {
16122
16273
  /** Schema dist/js/schema/properties_directory/scalar/reaction_energy_barrier.json */
16123
16274
  export interface ReactionEnergyBarrierSchema {
16124
16275
  name: "reaction_energy_barrier";
16125
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16276
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16126
16277
  value: number;
16127
16278
  }
16128
16279
  /** Schema dist/js/schema/properties_directory/scalar/surface_energy.json */
16129
16280
  export interface SurfaceEnergySchema {
16130
16281
  name: "surface_energy";
16131
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16282
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16132
16283
  value: number;
16133
16284
  }
16134
16285
  /** Schema dist/js/schema/properties_directory/scalar/total_energy.json */
16135
16286
  export interface TotalEnergySchema {
16136
16287
  name: "total_energy";
16137
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16288
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16138
16289
  value: number;
16139
16290
  }
16140
16291
  /** Schema dist/js/schema/properties_directory/scalar/total_force.json */
16141
16292
  export interface TotalForcesSchema {
16142
16293
  name?: "total_force";
16143
- units?: "eV/bohr" | "eV/angstrom" | "rydberg/a.u." | "newton" | "kg*m/s^2" | "eV/a.u.";
16294
+ units?: "eV/bohr" | "eV/angstrom" | "Ry/a.u." | "newton" | "kg*m/s^2" | "eV/a.u.";
16144
16295
  value: number;
16145
16296
  }
16146
16297
  /** Schema dist/js/schema/properties_directory/scalar/valence_band_offset.json */
16147
16298
  export interface ValenceBandOffsetSchema {
16148
16299
  name: "valence_band_offset";
16149
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16300
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16150
16301
  value: number;
16151
16302
  }
16152
16303
  /** Schema dist/js/schema/properties_directory/scalar/zero_point_energy.json */
16153
16304
  export interface ZeroPointEnergySchema {
16154
16305
  name: "zero_point_energy";
16155
- units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "rydberg" | "eV/atom") | "eV/A^2";
16306
+ units: ("kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
16156
16307
  value: number;
16157
16308
  }
16158
16309
  /** Schema dist/js/schema/properties_directory/structural/atomic_forces.json */
@@ -16171,7 +16322,7 @@ export interface AtomicForces {
16171
16322
  */
16172
16323
  id?: number;
16173
16324
  }[];
16174
- units?: "eV/bohr" | "eV/angstrom" | "rydberg/a.u." | "newton" | "kg*m/s^2" | "eV/a.u.";
16325
+ units?: "eV/bohr" | "eV/angstrom" | "Ry/a.u." | "newton" | "kg*m/s^2" | "eV/a.u.";
16175
16326
  }
16176
16327
  /** Schema dist/js/schema/properties_directory/structural/basis/atomic_constraints.json */
16177
16328
  /**
@@ -16586,7 +16737,7 @@ export interface VolumeSchema {
16586
16737
  /** Schema dist/js/schema/properties_directory/workflow/convergence/electronic.json */
16587
16738
  export interface ElectronicSelfConsistencyConvergenceSchema {
16588
16739
  name?: "convergence_electronic";
16589
- units?: "eV" | "rydberg" | "hartree";
16740
+ units?: "eV" | "Ry" | "hartree";
16590
16741
  data: number[][];
16591
16742
  }
16592
16743
  /** Schema dist/js/schema/properties_directory/workflow/convergence/ionic.json */
@@ -16621,7 +16772,7 @@ export interface IonicConvergenceSchema {
16621
16772
  /**
16622
16773
  * units for force tolerance
16623
16774
  */
16624
- units?: "eV" | "rydberg" | "hartree";
16775
+ units?: "eV" | "Ry" | "hartree";
16625
16776
  data?: number[];
16626
16777
  };
16627
16778
  }[];
@@ -11,6 +11,6 @@
11
11
  ],
12
12
  "name": "band_gap",
13
13
  "type": "direct",
14
- "units": "rydberg",
14
+ "units": "Ry",
15
15
  "value": 0.0947
16
16
  }
@@ -44,6 +44,25 @@
44
44
  "name": "pseudopotential",
45
45
  "source": "dojo-oncv",
46
46
  "type": "nc",
47
- "version": "0.4"
47
+ "version": "0.4",
48
+ "cutoffs": {
49
+ "wavefunction": [
50
+ {
51
+ "accuracy_level": "standard",
52
+ "value": 42.0,
53
+ "unit": "Ry"
54
+ },
55
+ {
56
+ "accuracy_level": "high",
57
+ "value": 50.0,
58
+ "unit": "Ry"
59
+ },
60
+ {
61
+ "accuracy_level": "low",
62
+ "value": 38.0,
63
+ "unit": "Ry"
64
+ }
65
+ ]
66
+ }
48
67
  }
49
68
  }
@@ -13,12 +13,12 @@
13
13
  0
14
14
  ],
15
15
  "type": "direct",
16
- "units": "rydberg",
16
+ "units": "Ry",
17
17
  "value": 0.0947
18
18
  },
19
19
  {
20
20
  "type": "indirect",
21
- "units": "rydberg",
21
+ "units": "Ry",
22
22
  "value": 0.0
23
23
  }
24
24
  ]
@@ -11,5 +11,5 @@
11
11
  ]
12
12
  ],
13
13
  "tolerance": 0.001,
14
- "units": "rydberg"
14
+ "units": "Ry"
15
15
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mat3ra/esse",
3
- "version": "2025.4.3-0",
3
+ "version": "2025.4.15-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,50 +27,50 @@
27
27
  },
28
28
  "homepage": "https://github.com/Exabyte-io/esse",
29
29
  "devDependencies": {
30
- "@exabyte-io/eslint-config": "git+https://github.com/Exabyte-io/eslint-config.git#53db65c75453137f1e7f4666371078c7cc7a5366",
30
+ "@exabyte-io/eslint-config": "^2025.1.15-0",
31
31
  "@mat3ra/tsconfig": "^2024.6.3-0",
32
- "@typescript-eslint/eslint-plugin": "^5.9.1",
33
- "@typescript-eslint/parser": "^5.9.1",
34
- "chai": "4.3.4",
32
+ "@typescript-eslint/eslint-plugin": "^5.62.0",
33
+ "@typescript-eslint/parser": "^5.62.0",
34
+ "chai": "4.5.0",
35
35
  "eslint": "^7.32.0",
36
- "eslint-config-airbnb": "^19.0.2",
37
- "eslint-config-prettier": "^8.5.0",
36
+ "eslint-config-airbnb": "^19.0.4",
37
+ "eslint-config-prettier": "^8.10.0",
38
38
  "eslint-import-resolver-exports": "^1.0.0-beta.5",
39
39
  "eslint-import-resolver-meteor": "^0.4.0",
40
40
  "eslint-import-resolver-node": "^0.3.9",
41
- "eslint-plugin-import": "^2.25.3",
42
- "eslint-plugin-jsdoc": "^50.6.0",
43
- "eslint-plugin-jsx-a11y": "^6.5.1",
41
+ "eslint-plugin-import": "^2.31.0",
42
+ "eslint-plugin-jsdoc": "^50.6.9",
43
+ "eslint-plugin-jsx-a11y": "^6.10.2",
44
44
  "eslint-plugin-mui-path-imports": "0.0.15",
45
45
  "eslint-plugin-prettier": "^4.2.1",
46
- "eslint-plugin-react": "^7.30.0",
47
- "eslint-plugin-react-hooks": "^4.3.0",
46
+ "eslint-plugin-react": "^7.37.4",
47
+ "eslint-plugin-react-hooks": "^4.6.2",
48
48
  "eslint-plugin-simple-import-sort": "^7.0.0",
49
49
  "husky": "^7.0.4",
50
- "lint-staged": "^12.1.2",
51
- "mocha": "10.3.0",
50
+ "lint-staged": "^12.5.0",
51
+ "mocha": "10.8.2",
52
52
  "nyc": "15.1.0",
53
- "prettier": "^2.5.1",
54
- "prettyjson": "^1.1.3",
53
+ "prettier": "^2.8.8",
54
+ "prettyjson": "^1.2.5",
55
55
  "ts-node": "^10.9.2",
56
- "typescript": "^4.5.5"
56
+ "typescript": "^4.9.5"
57
57
  },
58
58
  "license": "Apache-2.0",
59
59
  "dependencies": {
60
- "@babel/cli": "7.16.0",
61
- "@babel/core": "7.24.1",
62
- "@babel/eslint-parser": "7.16.3",
63
- "@babel/plugin-proposal-class-properties": "7.16.0",
64
- "@babel/preset-env": "7.16.4",
65
- "@babel/preset-react": "7.16.7",
66
- "@babel/preset-typescript": "^7.22.5",
67
- "@babel/register": "^7.16.0",
68
- "@babel/runtime-corejs3": "7.16.8",
69
- "@types/chai": "^4.3.11",
60
+ "@babel/cli": "^7.27.0",
61
+ "@babel/core": "^7.26.10",
62
+ "@babel/eslint-parser": "^7.27.0",
63
+ "@babel/plugin-proposal-class-properties": "^7.18.6",
64
+ "@babel/preset-env": "^7.26.9",
65
+ "@babel/preset-react": "^7.26.3",
66
+ "@babel/preset-typescript": "^7.27.0",
67
+ "@babel/register": "^7.25.9",
68
+ "@babel/runtime-corejs3": "^7.27.0",
69
+ "@types/chai": "^4.3.20",
70
70
  "@types/js-yaml": "^4.0.9",
71
71
  "@types/json-schema-merge-allof": "^0.6.5",
72
- "@types/mocha": "^10.0.6",
73
- "ajv": "^8.12.0",
72
+ "@types/mocha": "^10.0.10",
73
+ "ajv": "^8.17.1",
74
74
  "ajv-formats": "^2.1.1",
75
75
  "js-yaml": "^4.1.0",
76
76
  "json-schema": "^0.4.0",
@@ -0,0 +1,23 @@
1
+ {
2
+ "$id": "core/reusable/energy-accuracy-levels",
3
+ "$schema": "http://json-schema.org/draft-07/schema#",
4
+ "title": "Reusable schema for energy value with unit corresponding to a specific accuracy level, e.g., used for suggested wavefunction and charge density cutoffs",
5
+ "type": "object",
6
+ "allOf": [
7
+ {
8
+ "$ref": "./scalar_with_accuracy_levels.json"
9
+ }
10
+ ],
11
+ "properties": {
12
+ "unit": {
13
+ "description": "Unit of the energy value corresponding to a accuracy_level. The values are expressed in Ry.",
14
+ "type": "string",
15
+ "enum": [
16
+ "Ry"
17
+ ]
18
+ }
19
+ },
20
+ "required": [
21
+ "unit"
22
+ ]
23
+ }
@@ -0,0 +1,25 @@
1
+ {
2
+ "$id": "core/reusable/scalar-with-accuracy-levels",
3
+ "$schema": "http://json-schema.org/draft-07/schema#",
4
+ "title": "Reusable schema for scalar values with accuracy levels",
5
+ "type": "object",
6
+ "allOf": [
7
+ {
8
+ "$ref": "../primitive/scalar.json"
9
+ }
10
+ ],
11
+ "properties": {
12
+ "accuracy_level": {
13
+ "description": "Accuracy level determines suggested scalar value.",
14
+ "type": "string",
15
+ "enum": [
16
+ "standard",
17
+ "low",
18
+ "high"
19
+ ]
20
+ }
21
+ },
22
+ "required": [
23
+ "accuracy_level"
24
+ ]
25
+ }
@@ -50,7 +50,7 @@
50
50
  "J/mol",
51
51
  "hartree",
52
52
  "cm-1",
53
- "rydberg",
53
+ "Ry",
54
54
  "eV/atom"
55
55
  ]
56
56
  },
@@ -71,7 +71,7 @@
71
71
  "enum": [
72
72
  "eV/bohr",
73
73
  "eV/angstrom",
74
- "rydberg/a.u.",
74
+ "Ry/a.u.",
75
75
  "newton",
76
76
  "kg*m/s^2",
77
77
  "eV/a.u."
@@ -70,6 +70,27 @@
70
70
  "enum": [
71
71
  "pseudopotential"
72
72
  ]
73
+ },
74
+ "cutoffs": {
75
+ "type": "object",
76
+ "description": "Suggested cutoff values for wave function and charge density.",
77
+ "additionalProperties": false,
78
+ "properties": {
79
+ "wavefunction": {
80
+ "type": "array",
81
+ "description": "Energy cutoff values for wavefunction plane wave expansion.",
82
+ "items": {
83
+ "$ref": "../../../core/reusable/energy_accuracy_levels.json"
84
+ }
85
+ },
86
+ "density": {
87
+ "type": "array",
88
+ "description": "Energy cutoff values for charge density plane wave expansion.",
89
+ "items": {
90
+ "$ref": "../../../core/reusable/energy_accuracy_levels.json"
91
+ }
92
+ }
93
+ }
73
94
  }
74
95
  },
75
96
  "required": [
@@ -12,7 +12,7 @@
12
12
  "units": {
13
13
  "enum": [
14
14
  "eV",
15
- "rydberg",
15
+ "Ry",
16
16
  "hartree"
17
17
  ]
18
18
  },
@@ -40,7 +40,7 @@
40
40
  "description": "units for force tolerance",
41
41
  "enum": [
42
42
  "eV",
43
- "rydberg",
43
+ "Ry",
44
44
  "hartree"
45
45
  ]
46
46
  },