@mat3ra/esse 2026.6.5-0 → 2026.6.12-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.
- package/dist/js/example/core/reusable/formation_energy_contribution.json +9 -0
- package/dist/js/example/properties_directory/non_scalar/formation_energy_contributions.json +32 -0
- package/dist/js/schema/core/reusable/formation_energy_contribution.json +53 -0
- package/dist/js/schema/properties_directory/enum_options.json +8 -1
- package/dist/js/schema/properties_directory/non_scalar/formation_energy_contributions.json +73 -0
- package/dist/js/schema/property/holder.json +72 -0
- package/dist/js/schemas.json +1 -1
- package/dist/js/types.d.ts +109 -1
- package/example/core/reusable/formation_energy_contribution.json +9 -0
- package/example/properties_directory/non-scalar/formation_energy_contributions.json +32 -0
- package/manifest/properties.yaml +5 -0
- package/package.json +1 -1
- package/schema/core/reusable/formation_energy_contribution.json +53 -0
- package/schema/properties_directory/enum_options.json +8 -1
- package/schema/properties_directory/non-scalar/formation_energy_contributions.json +24 -0
- package/schema/property/holder.json +3 -0
package/dist/js/types.d.ts
CHANGED
|
@@ -5090,6 +5090,40 @@ export interface FileMetadata {
|
|
|
5090
5090
|
*/
|
|
5091
5091
|
filetype?: string;
|
|
5092
5092
|
}
|
|
5093
|
+
/** Schema dist/js/schema/core/reusable/formation_energy_contribution.json */
|
|
5094
|
+
/**
|
|
5095
|
+
* Total energy contribution of one material used in formation energy calculation.
|
|
5096
|
+
*/
|
|
5097
|
+
export interface FormationEnergyContributionSchema {
|
|
5098
|
+
/**
|
|
5099
|
+
* formula or label for the material used in the formation energy calculation
|
|
5100
|
+
*/
|
|
5101
|
+
formula: string;
|
|
5102
|
+
/**
|
|
5103
|
+
* number of atoms in the material
|
|
5104
|
+
*/
|
|
5105
|
+
n_atoms: number;
|
|
5106
|
+
/**
|
|
5107
|
+
* whether the material is an elemental reference
|
|
5108
|
+
*/
|
|
5109
|
+
is_elemental: boolean;
|
|
5110
|
+
/**
|
|
5111
|
+
* total energy of the material
|
|
5112
|
+
*/
|
|
5113
|
+
total_energy: number;
|
|
5114
|
+
/**
|
|
5115
|
+
* total energy per atom of the material
|
|
5116
|
+
*/
|
|
5117
|
+
total_energy_per_atom: number;
|
|
5118
|
+
/**
|
|
5119
|
+
* precision value for the total energy property
|
|
5120
|
+
*/
|
|
5121
|
+
precision_value: number;
|
|
5122
|
+
/**
|
|
5123
|
+
* metric used to report total energy precision
|
|
5124
|
+
*/
|
|
5125
|
+
precision_metric: "unknown" | "KPPRA" | "spacing";
|
|
5126
|
+
}
|
|
5093
5127
|
/** Schema dist/js/schema/core/reusable/frequency_function_matrix.json */
|
|
5094
5128
|
/**
|
|
5095
5129
|
* Schema for a function of frequency yielding a nx3 matrix
|
|
@@ -52211,7 +52245,7 @@ export type ExternalSource = "ICSD" | "MaterialsProject" | "MaterialsProjectLega
|
|
|
52211
52245
|
* This interface was referenced by `PropertiesDirectoryEnumOptions`'s JSON-Schema
|
|
52212
52246
|
* via the `definition` "PropertyType".
|
|
52213
52247
|
*/
|
|
52214
|
-
export type PropertyType = "scalar" | "non-scalar" | "tensor" | "object";
|
|
52248
|
+
export type PropertyType = "scalar" | "non-scalar" | "tensor" | "object" | "array-of-objects";
|
|
52215
52249
|
/**
|
|
52216
52250
|
* This interface was referenced by `PropertiesDirectoryEnumOptions`'s JSON-Schema
|
|
52217
52251
|
* via the `definition` "ScalarPropertyEnum".
|
|
@@ -52232,6 +52266,11 @@ export type TensorPropertyEnum = "atomic_forces" | "magnetic_moments" | "stress_
|
|
|
52232
52266
|
* via the `definition` "ObjectPropertyEnum".
|
|
52233
52267
|
*/
|
|
52234
52268
|
export type ObjectPropertyEnum = "total_energy_contributions";
|
|
52269
|
+
/**
|
|
52270
|
+
* This interface was referenced by `PropertiesDirectoryEnumOptions`'s JSON-Schema
|
|
52271
|
+
* via the `definition` "ArrayOfObjectsPropertyEnum".
|
|
52272
|
+
*/
|
|
52273
|
+
export type ArrayOfObjectsPropertyEnum = "formation_energy_contributions";
|
|
52235
52274
|
/**
|
|
52236
52275
|
* This interface was referenced by `PropertiesDirectoryEnumOptions`'s JSON-Schema
|
|
52237
52276
|
* via the `definition` "ProtoPropertyEnum".
|
|
@@ -52513,6 +52552,43 @@ export interface FinalStructurePropertySchema {
|
|
|
52513
52552
|
*/
|
|
52514
52553
|
materialId: string;
|
|
52515
52554
|
}
|
|
52555
|
+
/** Schema dist/js/schema/properties_directory/non_scalar/formation_energy_contributions.json */
|
|
52556
|
+
/**
|
|
52557
|
+
* Elemental reference total energies used to calculate formation energy.
|
|
52558
|
+
*/
|
|
52559
|
+
export interface FormationEnergyContributionsPropertySchema {
|
|
52560
|
+
name: "formation_energy_contributions";
|
|
52561
|
+
values: {
|
|
52562
|
+
/**
|
|
52563
|
+
* formula or label for the material used in the formation energy calculation
|
|
52564
|
+
*/
|
|
52565
|
+
formula: string;
|
|
52566
|
+
/**
|
|
52567
|
+
* number of atoms in the material
|
|
52568
|
+
*/
|
|
52569
|
+
n_atoms: number;
|
|
52570
|
+
/**
|
|
52571
|
+
* whether the material is an elemental reference
|
|
52572
|
+
*/
|
|
52573
|
+
is_elemental: boolean;
|
|
52574
|
+
/**
|
|
52575
|
+
* total energy of the material
|
|
52576
|
+
*/
|
|
52577
|
+
total_energy: number;
|
|
52578
|
+
/**
|
|
52579
|
+
* total energy per atom of the material
|
|
52580
|
+
*/
|
|
52581
|
+
total_energy_per_atom: number;
|
|
52582
|
+
/**
|
|
52583
|
+
* precision value for the total energy property
|
|
52584
|
+
*/
|
|
52585
|
+
precision_value: number;
|
|
52586
|
+
/**
|
|
52587
|
+
* metric used to report total energy precision
|
|
52588
|
+
*/
|
|
52589
|
+
precision_metric: "unknown" | "KPPRA" | "spacing";
|
|
52590
|
+
}[];
|
|
52591
|
+
}
|
|
52516
52592
|
/** Schema dist/js/schema/properties_directory/non_scalar/hubbard_u.json */
|
|
52517
52593
|
/**
|
|
52518
52594
|
* Hubbard U values in eV corresponding to atomic species, orbital and site number.
|
|
@@ -56178,6 +56254,38 @@ export interface PropertyHolderSchema {
|
|
|
56178
56254
|
};
|
|
56179
56255
|
name: "total_energy_contributions";
|
|
56180
56256
|
units?: "kcal/mol" | "kJ/mol" | "eV" | "J/mol" | "hartree" | "cm-1" | "Ry" | "eV/atom";
|
|
56257
|
+
} | {
|
|
56258
|
+
name: "formation_energy_contributions";
|
|
56259
|
+
values: {
|
|
56260
|
+
/**
|
|
56261
|
+
* formula or label for the material used in the formation energy calculation
|
|
56262
|
+
*/
|
|
56263
|
+
formula: string;
|
|
56264
|
+
/**
|
|
56265
|
+
* number of atoms in the material
|
|
56266
|
+
*/
|
|
56267
|
+
n_atoms: number;
|
|
56268
|
+
/**
|
|
56269
|
+
* whether the material is an elemental reference
|
|
56270
|
+
*/
|
|
56271
|
+
is_elemental: boolean;
|
|
56272
|
+
/**
|
|
56273
|
+
* total energy of the material
|
|
56274
|
+
*/
|
|
56275
|
+
total_energy: number;
|
|
56276
|
+
/**
|
|
56277
|
+
* total energy per atom of the material
|
|
56278
|
+
*/
|
|
56279
|
+
total_energy_per_atom: number;
|
|
56280
|
+
/**
|
|
56281
|
+
* precision value for the total energy property
|
|
56282
|
+
*/
|
|
56283
|
+
precision_value: number;
|
|
56284
|
+
/**
|
|
56285
|
+
* metric used to report total energy precision
|
|
56286
|
+
*/
|
|
56287
|
+
precision_metric: "unknown" | "KPPRA" | "spacing";
|
|
56288
|
+
}[];
|
|
56181
56289
|
} | {
|
|
56182
56290
|
xAxis: {
|
|
56183
56291
|
/**
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "formation_energy_contributions",
|
|
3
|
+
"values": [
|
|
4
|
+
{
|
|
5
|
+
"formula": "SiC",
|
|
6
|
+
"n_atoms": 4,
|
|
7
|
+
"is_elemental": false,
|
|
8
|
+
"total_energy": -520.003969643439,
|
|
9
|
+
"total_energy_per_atom": -130.00099241085975,
|
|
10
|
+
"precision_value": 8192,
|
|
11
|
+
"precision_metric": "KPPRA"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"formula": "Si",
|
|
15
|
+
"n_atoms": 2,
|
|
16
|
+
"is_elemental": true,
|
|
17
|
+
"total_energy": -261.003969643439,
|
|
18
|
+
"total_energy_per_atom": -130.5019848217195,
|
|
19
|
+
"precision_value": 8192,
|
|
20
|
+
"precision_metric": "KPPRA"
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"formula": "C",
|
|
24
|
+
"n_atoms": 2,
|
|
25
|
+
"is_elemental": true,
|
|
26
|
+
"total_energy": -321.003969643439,
|
|
27
|
+
"total_energy_per_atom": -160.5019848217195,
|
|
28
|
+
"precision_value": 8000,
|
|
29
|
+
"precision_metric": "KPPRA"
|
|
30
|
+
}
|
|
31
|
+
]
|
|
32
|
+
}
|
package/manifest/properties.yaml
CHANGED
|
@@ -129,6 +129,11 @@ total_energy_contributions:
|
|
|
129
129
|
schemaId: properties-directory/non-scalar/total-energy-contributions
|
|
130
130
|
isResult: true
|
|
131
131
|
|
|
132
|
+
formation_energy_contributions:
|
|
133
|
+
defaults:
|
|
134
|
+
schemaId: properties-directory/non-scalar/formation-energy-contributions
|
|
135
|
+
isResult: true
|
|
136
|
+
|
|
132
137
|
band_gaps:
|
|
133
138
|
types:
|
|
134
139
|
- direct
|
package/package.json
CHANGED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$id": "core/reusable/formation-energy-contribution",
|
|
3
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
4
|
+
"title": "Formation energy contribution schema",
|
|
5
|
+
"description": "Total energy contribution of one material used in formation energy calculation.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"formula": {
|
|
9
|
+
"description": "formula or label for the material used in the formation energy calculation",
|
|
10
|
+
"type": "string"
|
|
11
|
+
},
|
|
12
|
+
"n_atoms": {
|
|
13
|
+
"description": "number of atoms in the material",
|
|
14
|
+
"type": "integer"
|
|
15
|
+
},
|
|
16
|
+
"is_elemental": {
|
|
17
|
+
"description": "whether the material is an elemental reference",
|
|
18
|
+
"type": "boolean"
|
|
19
|
+
},
|
|
20
|
+
"total_energy": {
|
|
21
|
+
"description": "total energy of the material",
|
|
22
|
+
"type": "number"
|
|
23
|
+
},
|
|
24
|
+
"total_energy_per_atom": {
|
|
25
|
+
"description": "total energy per atom of the material",
|
|
26
|
+
"type": "number"
|
|
27
|
+
},
|
|
28
|
+
"precision_value": {
|
|
29
|
+
"description": "precision value for the total energy property",
|
|
30
|
+
"type": "number",
|
|
31
|
+
"default": -1
|
|
32
|
+
},
|
|
33
|
+
"precision_metric": {
|
|
34
|
+
"description": "metric used to report total energy precision",
|
|
35
|
+
"type": "string",
|
|
36
|
+
"enum": [
|
|
37
|
+
"unknown",
|
|
38
|
+
"KPPRA",
|
|
39
|
+
"spacing"
|
|
40
|
+
],
|
|
41
|
+
"default": "unknown"
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
"required": [
|
|
45
|
+
"formula",
|
|
46
|
+
"n_atoms",
|
|
47
|
+
"is_elemental",
|
|
48
|
+
"total_energy",
|
|
49
|
+
"total_energy_per_atom",
|
|
50
|
+
"precision_metric",
|
|
51
|
+
"precision_value"
|
|
52
|
+
]
|
|
53
|
+
}
|
|
@@ -15,7 +15,8 @@
|
|
|
15
15
|
"scalar",
|
|
16
16
|
"non-scalar",
|
|
17
17
|
"tensor",
|
|
18
|
-
"object"
|
|
18
|
+
"object",
|
|
19
|
+
"array-of-objects"
|
|
19
20
|
]
|
|
20
21
|
},
|
|
21
22
|
"ScalarPropertyEnum": {
|
|
@@ -77,6 +78,12 @@
|
|
|
77
78
|
"total_energy_contributions"
|
|
78
79
|
]
|
|
79
80
|
},
|
|
81
|
+
"ArrayOfObjectsPropertyEnum": {
|
|
82
|
+
"type": "string",
|
|
83
|
+
"enum": [
|
|
84
|
+
"formation_energy_contributions"
|
|
85
|
+
]
|
|
86
|
+
},
|
|
80
87
|
"ProtoPropertyEnum": {
|
|
81
88
|
"type": "string",
|
|
82
89
|
"enum": [
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$id": "properties-directory/non-scalar/formation-energy-contributions",
|
|
3
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
4
|
+
"title": "Formation energy contributions property schema",
|
|
5
|
+
"description": "Elemental reference total energies used to calculate formation energy.",
|
|
6
|
+
"type": "object",
|
|
7
|
+
"properties": {
|
|
8
|
+
"name": {
|
|
9
|
+
"enum": [
|
|
10
|
+
"formation_energy_contributions"
|
|
11
|
+
]
|
|
12
|
+
},
|
|
13
|
+
"values": {
|
|
14
|
+
"type": "array",
|
|
15
|
+
"items": {
|
|
16
|
+
"$ref": "../../core/reusable/formation_energy_contribution.json"
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"required": [
|
|
21
|
+
"name",
|
|
22
|
+
"values"
|
|
23
|
+
]
|
|
24
|
+
}
|
|
@@ -75,6 +75,9 @@
|
|
|
75
75
|
{
|
|
76
76
|
"$ref": "../properties_directory/non-scalar/total_energy_contributions.json"
|
|
77
77
|
},
|
|
78
|
+
{
|
|
79
|
+
"$ref": "../properties_directory/non-scalar/formation_energy_contributions.json"
|
|
80
|
+
},
|
|
78
81
|
{
|
|
79
82
|
"$ref": "../properties_directory/non-scalar/phonon_dos.json"
|
|
80
83
|
},
|