@mat3ra/esse 2026.10.25-0 → 2026.10.31-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.
@@ -4831,6 +4831,24 @@ export type AtomicVectorsSchema = {
4831
4831
  */
4832
4832
  id: number;
4833
4833
  }[];
4834
+ /** Schema dist/js/schema/core/reusable/band_energies.json */
4835
+ /**
4836
+ * the band energies and occupations of one spin channel at one k-point
4837
+ */
4838
+ export interface BandEnergiesSchema {
4839
+ /**
4840
+ * spin of the channel
4841
+ */
4842
+ spin?: 0.5 | -0.5;
4843
+ /**
4844
+ * band energies, in band order
4845
+ */
4846
+ energies: number[];
4847
+ /**
4848
+ * band occupations, in the same order as energies
4849
+ */
4850
+ occupations?: number[];
4851
+ }
4834
4852
  /** Schema dist/js/schema/core/reusable/band_gap.json */
4835
4853
  export interface BandGapSchema {
4836
4854
  /**
@@ -5096,6 +5114,40 @@ export interface DielectricTensor {
5096
5114
  */
5097
5115
  components: [number, number, number][];
5098
5116
  }
5117
+ /** Schema dist/js/schema/core/reusable/eigenvalues_at_kpoint.json */
5118
+ /**
5119
+ * the eigenvalues at one k-point: its coordinates, its integration weight, and the band energies and occupations of each spin channel
5120
+ */
5121
+ export interface EigenvaluesAtKPointSchema {
5122
+ /**
5123
+ * A k-point is a point in reciprocal space of a crystal.
5124
+ *
5125
+ * @minItems 3
5126
+ * @maxItems 3
5127
+ */
5128
+ kpoint?: [number, number, number];
5129
+ /**
5130
+ * integration weight of the k-point
5131
+ */
5132
+ weight?: number;
5133
+ /**
5134
+ * one entry per spin channel; a spin-unpolarized calculation has a single entry
5135
+ */
5136
+ eigenvalues: {
5137
+ /**
5138
+ * spin of the channel
5139
+ */
5140
+ spin?: 0.5 | -0.5;
5141
+ /**
5142
+ * band energies, in band order
5143
+ */
5144
+ energies: number[];
5145
+ /**
5146
+ * band occupations, in the same order as energies
5147
+ */
5148
+ occupations?: number[];
5149
+ }[];
5150
+ }
5099
5151
  /** Schema dist/js/schema/core/reusable/energy.json */
5100
5152
  export interface EnergySchema {
5101
5153
  name: string;
@@ -56890,11 +56942,26 @@ export interface BandGapsPropertySchema {
56890
56942
  * @maxItems 3
56891
56943
  */
56892
56944
  kpoint?: [number, number, number];
56945
+ /**
56946
+ * integration weight of the k-point
56947
+ */
56893
56948
  weight?: number;
56894
- eigenvalues?: {
56895
- spin?: number;
56896
- energies?: unknown[];
56897
- occupations?: unknown[];
56949
+ /**
56950
+ * one entry per spin channel; a spin-unpolarized calculation has a single entry
56951
+ */
56952
+ eigenvalues: {
56953
+ /**
56954
+ * spin of the channel
56955
+ */
56956
+ spin?: 0.5 | -0.5;
56957
+ /**
56958
+ * band energies, in band order
56959
+ */
56960
+ energies: number[];
56961
+ /**
56962
+ * band occupations, in the same order as energies
56963
+ */
56964
+ occupations?: number[];
56898
56965
  }[];
56899
56966
  }[];
56900
56967
  }
@@ -57029,6 +57096,44 @@ export interface DielectricTensorPropertySchema {
57029
57096
  components: [number, number, number][];
57030
57097
  }[];
57031
57098
  }
57099
+ /** Schema dist/js/schema/properties_directory/non_scalar/eigenvalues_at_kpoints.json */
57100
+ /**
57101
+ * the band energies (and occupations) at each k-point of a calculation, in one energy unit
57102
+ */
57103
+ export interface EigenvaluesAtKPointsPropertySchema {
57104
+ name: "eigenvalues_at_kpoints";
57105
+ units: "kcal/mol" | "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
57106
+ values: {
57107
+ /**
57108
+ * A k-point is a point in reciprocal space of a crystal.
57109
+ *
57110
+ * @minItems 3
57111
+ * @maxItems 3
57112
+ */
57113
+ kpoint?: [number, number, number];
57114
+ /**
57115
+ * integration weight of the k-point
57116
+ */
57117
+ weight?: number;
57118
+ /**
57119
+ * one entry per spin channel; a spin-unpolarized calculation has a single entry
57120
+ */
57121
+ eigenvalues: {
57122
+ /**
57123
+ * spin of the channel
57124
+ */
57125
+ spin?: 0.5 | -0.5;
57126
+ /**
57127
+ * band energies, in band order
57128
+ */
57129
+ energies: number[];
57130
+ /**
57131
+ * band occupations, in the same order as energies
57132
+ */
57133
+ occupations?: number[];
57134
+ }[];
57135
+ }[];
57136
+ }
57032
57137
  /** Schema dist/js/schema/properties_directory/non_scalar/file_content.json */
57033
57138
  export interface FileContentPropertySchema {
57034
57139
  name: "file_content";
@@ -59975,6 +60080,46 @@ export interface HubbardParametersReusableSchema {
59975
60080
  value: number;
59976
60081
  }[];
59977
60082
  }
60083
+ /** Schema dist/js/schema/properties_directory/scalar/band_edge_conduction_min.json */
60084
+ /**
60085
+ * lowest unoccupied band energy of a crystal
60086
+ */
60087
+ export interface ConductionBandMinimumPropertySchema {
60088
+ name: "band_edge_conduction_min";
60089
+ /**
60090
+ * A k-point is a point in reciprocal space of a crystal.
60091
+ *
60092
+ * @minItems 3
60093
+ * @maxItems 3
60094
+ */
60095
+ kpoint?: [number, number, number];
60096
+ /**
60097
+ * spin of the channel the band edge belongs to
60098
+ */
60099
+ spin?: 0.5 | -0.5;
60100
+ units: ("kcal/mol" | "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
60101
+ value: number;
60102
+ }
60103
+ /** Schema dist/js/schema/properties_directory/scalar/band_edge_valence_max.json */
60104
+ /**
60105
+ * highest occupied band energy of a crystal
60106
+ */
60107
+ export interface ValenceBandMaximumPropertySchema {
60108
+ name: "band_edge_valence_max";
60109
+ /**
60110
+ * A k-point is a point in reciprocal space of a crystal.
60111
+ *
60112
+ * @minItems 3
60113
+ * @maxItems 3
60114
+ */
60115
+ kpoint?: [number, number, number];
60116
+ /**
60117
+ * spin of the channel the band edge belongs to
60118
+ */
60119
+ spin?: 0.5 | -0.5;
60120
+ units: ("kcal/mol" | "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
60121
+ value: number;
60122
+ }
59978
60123
  /** Schema dist/js/schema/properties_directory/scalar/defect_formation_energy.json */
59979
60124
  export interface DefectFormationEnergyPropertySchema {
59980
60125
  name: "defect_formation_energy";
@@ -60023,6 +60168,24 @@ export interface LUMOEnergyPropertySchema {
60023
60168
  units: ("kcal/mol" | "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom") | "eV/A^2";
60024
60169
  value: number;
60025
60170
  }
60171
+ /** Schema dist/js/schema/properties_directory/scalar/magnetization_absolute.json */
60172
+ /**
60173
+ * integral of the absolute value of the magnetization density over the cell
60174
+ */
60175
+ export interface AbsoluteMagnetizationPropertySchema {
60176
+ name: "magnetization_absolute";
60177
+ units: "uB";
60178
+ value: number;
60179
+ }
60180
+ /** Schema dist/js/schema/properties_directory/scalar/magnetization_total.json */
60181
+ /**
60182
+ * net magnetization of the cell: the integral of the magnetization density
60183
+ */
60184
+ export interface TotalMagnetizationPropertySchema {
60185
+ name: "magnetization_total";
60186
+ units: "uB";
60187
+ value: number;
60188
+ }
60026
60189
  /** Schema dist/js/schema/properties_directory/scalar/pressure.json */
60027
60190
  /**
60028
60191
  * average pressure in unit cell
@@ -60889,11 +61052,26 @@ export interface PropertyHolderSchema {
60889
61052
  * @maxItems 3
60890
61053
  */
60891
61054
  kpoint?: [number, number, number];
61055
+ /**
61056
+ * integration weight of the k-point
61057
+ */
60892
61058
  weight?: number;
60893
- eigenvalues?: {
60894
- spin?: number;
60895
- energies?: unknown[];
60896
- occupations?: unknown[];
61059
+ /**
61060
+ * one entry per spin channel; a spin-unpolarized calculation has a single entry
61061
+ */
61062
+ eigenvalues: {
61063
+ /**
61064
+ * spin of the channel
61065
+ */
61066
+ spin?: 0.5 | -0.5;
61067
+ /**
61068
+ * band energies, in band order
61069
+ */
61070
+ energies: number[];
61071
+ /**
61072
+ * band occupations, in the same order as energies
61073
+ */
61074
+ occupations?: number[];
60897
61075
  }[];
60898
61076
  }[];
60899
61077
  } | {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mat3ra/esse",
3
- "version": "2026.10.25-0",
3
+ "version": "2026.10.31-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",