mat3ra-esse 2025.8.14.post0__py3-none-any.whl → 2025.10.8.post0__py3-none-any.whl
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.
Potentially problematic release.
This version of mat3ra-esse might be problematic. Click here for more details.
- mat3ra/esse/data/examples.py +1 -1
- mat3ra/esse/data/schemas.py +1 -1
- mat3ra/esse/models/core/abstract/_2d_data.py +2 -2
- mat3ra/esse/models/core/abstract/_2d_plot.py +2 -6
- mat3ra/esse/models/core/primitive/_1d_data_series.py +3 -3
- mat3ra/esse/models/core/primitive/axis_3d_names_enum.py +13 -0
- mat3ra/esse/models/core/reference/__init__.py +8 -8
- mat3ra/esse/models/core/reference/exabyte.py +2 -8
- mat3ra/esse/models/core/reference/experiment/__init__.py +2 -2
- mat3ra/esse/models/core/reusable/coordinate_conditions/__init__.py +1 -78
- mat3ra/esse/models/core/reusable/coordinate_conditions/index.py +80 -0
- mat3ra/esse/models/core/reusable/hubbard_parameters.py +48 -0
- mat3ra/esse/models/core/reusable/kpoint.py +16 -0
- mat3ra/esse/models/core/reusable/repetition.py +14 -0
- mat3ra/esse/models/definitions/material.py +13 -0
- mat3ra/esse/models/element.py +10 -8
- mat3ra/esse/models/job/__init__.py +62 -62
- mat3ra/esse/models/material/__init__.py +12 -12
- mat3ra/esse/models/materials_category/compound_pristine_structures/two_dimensional/interface/configuration.py +80 -80
- mat3ra/esse/models/materials_category/defective_structures/one_dimensional/grain_boundary_linear/configuration.py +80 -80
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/adatom/configuration.py +35 -35
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/grain_boundary_planar/configuration.py +80 -80
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/island/configuration.py +53 -53
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/terrace/configuration.py +53 -53
- mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/interstitial.py +29 -29
- mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/substitutional.py +32 -32
- mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/vacancy.py +12 -12
- mat3ra/esse/models/materials_category/pristine_structures/three_dimensional/ideal_crystal.py +12 -12
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanoribbon.py +52 -52
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanotape.py +32 -32
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab.py +32 -32
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab_strained_supercell.py +32 -32
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab_strained_supercell_with_gap.py +1151 -0
- mat3ra/esse/models/materials_category/processed_structures/two_dimensional/passivation/configuration.py +17 -17
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/crystal_site.py +8 -8
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/point_defect_site.py +12 -12
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/void_region.py +12 -12
- mat3ra/esse/models/materials_category_components/entities/core/three_dimensional/crystal.py +8 -8
- mat3ra/esse/models/materials_category_components/entities/core/two_dimensional/vacuum.py +12 -12
- mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_lines.py +8 -8
- mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_lines_unique_repeated.py +8 -8
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/crystal_lattice_base.py +8 -8
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_non_uniform.py +12 -12
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_uniform.py +12 -12
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/supercell.py +12 -12
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/crystal_lattice_planes.py +8 -8
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/slab_stack_configuration.py +52 -52
- mat3ra/esse/models/materials_category_components/operations/core/modifications/perturb.py +12 -12
- mat3ra/esse/models/methods_directory/physical/psp/__init__.py +2 -2
- mat3ra/esse/models/methods_directory/physical/psp/file.py +2 -2
- mat3ra/esse/models/methods_directory/physical/psp/file_data_item.py +2 -2
- mat3ra/esse/models/properties_directory/derived_properties.py +6 -6
- mat3ra/esse/models/properties_directory/elemental/atomic_radius.py +1 -1
- mat3ra/esse/models/properties_directory/elemental/electronegativity.py +1 -2
- mat3ra/esse/models/properties_directory/elemental/ionization_potential.py +3 -4
- mat3ra/esse/models/properties_directory/jupyter_notebook_endpoint.py +20 -0
- mat3ra/esse/models/properties_directory/non_scalar/average_potential_profile.py +4 -8
- mat3ra/esse/models/properties_directory/non_scalar/band_gaps.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/band_structure.py +5 -9
- mat3ra/esse/models/properties_directory/non_scalar/charge_density_profile.py +4 -8
- mat3ra/esse/models/properties_directory/non_scalar/density_of_states.py +5 -8
- mat3ra/esse/models/properties_directory/non_scalar/dielectric_tensor.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/file_content.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/final_structure.py +22 -0
- mat3ra/esse/models/properties_directory/non_scalar/hubbard_u.py +4 -4
- mat3ra/esse/models/properties_directory/non_scalar/hubbard_v.py +3 -4
- mat3ra/esse/models/properties_directory/non_scalar/hubbard_v_nn.py +3 -4
- mat3ra/esse/models/properties_directory/non_scalar/is_relaxed.py +22 -0
- mat3ra/esse/models/properties_directory/non_scalar/phonon_dispersions.py +10 -14
- mat3ra/esse/models/properties_directory/non_scalar/phonon_dos.py +10 -14
- mat3ra/esse/models/properties_directory/non_scalar/potential_profile.py +8 -12
- mat3ra/esse/models/properties_directory/non_scalar/reaction_energy_profile.py +8 -12
- mat3ra/esse/models/properties_directory/non_scalar/stress_tensor.py +5 -7
- mat3ra/esse/models/properties_directory/non_scalar/total_energy_contributions.py +64 -51
- mat3ra/esse/models/properties_directory/non_scalar/vibrational_spectrum.py +10 -14
- mat3ra/esse/models/properties_directory/non_scalar/workflow.py +2234 -0
- mat3ra/esse/models/properties_directory/reusable/hubbard_parameters.py +48 -0
- mat3ra/esse/models/properties_directory/scalar/electron_affinity.py +1 -1
- mat3ra/esse/models/properties_directory/scalar/fermi_energy.py +1 -1
- mat3ra/esse/models/properties_directory/scalar/formation_energy.py +1 -1
- mat3ra/esse/models/properties_directory/scalar/ionization_potential.py +3 -3
- mat3ra/esse/models/properties_directory/scalar/pressure.py +3 -4
- mat3ra/esse/models/properties_directory/scalar/reaction_energy_barrier.py +3 -3
- mat3ra/esse/models/properties_directory/scalar/surface_energy.py +3 -3
- mat3ra/esse/models/properties_directory/scalar/total_energy.py +3 -3
- mat3ra/esse/models/properties_directory/scalar/total_force.py +3 -4
- mat3ra/esse/models/properties_directory/scalar/valence_band_offset.py +3 -3
- mat3ra/esse/models/properties_directory/scalar/zero_point_energy.py +3 -3
- mat3ra/esse/models/properties_directory/structural/atomic_forces.py +5 -5
- mat3ra/esse/models/properties_directory/structural/basis/atomic_constraints_property.py +3 -3
- mat3ra/esse/models/properties_directory/structural/basis/boundary_conditions.py +30 -0
- mat3ra/esse/models/properties_directory/structural/basis/predicted_properties.py +82 -0
- mat3ra/esse/models/properties_directory/structural/lattice/units/__init__.py +23 -1
- mat3ra/esse/models/properties_directory/structural/magnetic_moments.py +5 -5
- mat3ra/esse/models/properties_directory/structural/molecular_pattern.py +5 -5
- mat3ra/esse/models/properties_directory/structural/patterns/functional_group.py +1 -1
- mat3ra/esse/models/properties_directory/structural/patterns/ring.py +1 -1
- mat3ra/esse/models/properties_directory/structural/patterns/special_bond.py +1 -1
- mat3ra/esse/models/properties_directory/workflow/convergence/electronic.py +4 -4
- mat3ra/esse/models/properties_directory/workflow/convergence/ionic.py +6 -6
- mat3ra/esse/models/property/base.py +1492 -14
- mat3ra/esse/models/property/holder.py +3568 -0
- mat3ra/esse/models/property/meta_holder/Reusable_schema_for_energy_value_with_unit_corresponding_to_a_specific_accuracy_level__e/g.py +31 -0
- mat3ra/esse/models/property/meta_holder.py +140 -0
- mat3ra/esse/models/property/proto_holder.py +86 -0
- mat3ra/esse/models/property/raw.py +27 -11
- mat3ra/esse/models/property/source.py +24 -1
- mat3ra/esse/models/workflow/__init__.py +54 -54
- mat3ra/esse/models/workflow/base_flow.py +4 -4
- mat3ra/esse/models/workflow/subworkflow/__init__.py +7 -7
- mat3ra/esse/models/workflow/subworkflow/unit.py +10 -10
- mat3ra/esse/models/workflow/unit/__init__.py +12 -12
- mat3ra/esse/models/workflow/unit/io/__init__.py +4 -4
- mat3ra/esse/models/workflow/unit/io/db.py +2 -2
- mat3ra/esse/models/workflow/unit/io/object_storage.py +1 -1
- {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/METADATA +1 -1
- {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/RECORD +122 -118
- mat3ra/esse/models/property/meta.py +0 -200
- mat3ra/esse/models/software_directory/ml/exabyteml.py +0 -28
- mat3ra/esse/models/software_directory/ml/unit/execution/__init__.py +0 -879
- mat3ra/esse/models/software_directory/ml/unit/execution/evaluate/__init__.py +0 -3
- mat3ra/esse/models/software_directory/ml/unit/execution/evaluate/cross_validate.py +0 -293
- mat3ra/esse/models/software_directory/ml/unit/execution/initialize.py +0 -293
- mat3ra/esse/models/software_directory/ml/unit/execution/score.py +0 -286
- mat3ra/esse/models/software_directory/ml/unit/execution/train.py +0 -297
- mat3ra/esse/models/software_directory/ml/unit/processing/__init__.py +0 -276
- mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/__init__.py +0 -167
- mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/manipulation.py +0 -144
- mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/scale_and_reduce.py +0 -163
- mat3ra/esse/models/software_directory/ml/unit/processing/feature_selection/__init__.py +0 -148
- mat3ra/esse/models/software_directory/ml/unit/processing/feature_selection/filter_based.py +0 -144
- /mat3ra/esse/models/{software_directory/ml → properties_directory/reusable}/__init__.py +0 -0
- /mat3ra/esse/models/{software_directory/ml/unit → property/meta_holder/Reusable_schema_for_energy_value_with_unit_corresponding_to_a_specific_accuracy_level__e}/__init__.py +0 -0
- {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/WHEEL +0 -0
- {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/licenses/LICENSE.md +0 -0
- {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.10.8.post0.dist-info}/top_level.txt +0 -0
|
@@ -1,200 +0,0 @@
|
|
|
1
|
-
# generated by datamodel-codegen:
|
|
2
|
-
# filename: property/meta.json
|
|
3
|
-
# version: 0.28.5
|
|
4
|
-
|
|
5
|
-
from __future__ import annotations
|
|
6
|
-
|
|
7
|
-
from enum import Enum
|
|
8
|
-
from typing import Any, Dict, List, Optional
|
|
9
|
-
|
|
10
|
-
from pydantic import BaseModel, Field
|
|
11
|
-
|
|
12
|
-
from .The_source_of_a_property import (
|
|
13
|
-
field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc,
|
|
14
|
-
)
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
class Type(Enum):
|
|
18
|
-
experiment = "experiment"
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
class ExperimentAuthorSchema(BaseModel):
|
|
22
|
-
first: str
|
|
23
|
-
middle: Optional[str] = None
|
|
24
|
-
last: str
|
|
25
|
-
affiliation: Optional[str] = None
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
class ScalarItem(BaseModel):
|
|
29
|
-
value: Optional[str] = None
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
class ConditionSchema(BaseModel):
|
|
33
|
-
units: Optional[str] = None
|
|
34
|
-
"""
|
|
35
|
-
condition unit
|
|
36
|
-
"""
|
|
37
|
-
scalar: Optional[List[ScalarItem]] = None
|
|
38
|
-
"""
|
|
39
|
-
array of condition values
|
|
40
|
-
"""
|
|
41
|
-
name: str
|
|
42
|
-
"""
|
|
43
|
-
human-readable name of the condition
|
|
44
|
-
"""
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
class LocationSchema(BaseModel):
|
|
48
|
-
latitude: float
|
|
49
|
-
"""
|
|
50
|
-
location latitude
|
|
51
|
-
"""
|
|
52
|
-
longitude: float
|
|
53
|
-
"""
|
|
54
|
-
location longitude
|
|
55
|
-
"""
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
class Type56(Enum):
|
|
59
|
-
literature = "literature"
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
class PagesSchema(BaseModel):
|
|
63
|
-
start: str
|
|
64
|
-
end: Optional[str] = None
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
class LiteratureReferenceSchema(BaseModel):
|
|
68
|
-
type: Optional[Type56] = None
|
|
69
|
-
doi: Optional[str] = None
|
|
70
|
-
"""
|
|
71
|
-
Digital Object Identifier of the reference.
|
|
72
|
-
"""
|
|
73
|
-
isbn: Optional[str] = None
|
|
74
|
-
"""
|
|
75
|
-
International Standard Book Number of the reference.
|
|
76
|
-
"""
|
|
77
|
-
issn: Optional[str] = None
|
|
78
|
-
"""
|
|
79
|
-
International Standard Serial Number of the reference.
|
|
80
|
-
"""
|
|
81
|
-
url: Optional[str] = None
|
|
82
|
-
"""
|
|
83
|
-
Internet address of the reference.
|
|
84
|
-
"""
|
|
85
|
-
title: Optional[str] = None
|
|
86
|
-
"""
|
|
87
|
-
Title of the work.
|
|
88
|
-
"""
|
|
89
|
-
publisher: Optional[str] = None
|
|
90
|
-
"""
|
|
91
|
-
Publisher of the work.
|
|
92
|
-
"""
|
|
93
|
-
journal: Optional[str] = None
|
|
94
|
-
"""
|
|
95
|
-
Journal in which the work appeared.
|
|
96
|
-
"""
|
|
97
|
-
volume: Optional[str] = None
|
|
98
|
-
"""
|
|
99
|
-
Volume of the series in which the work appeared.
|
|
100
|
-
"""
|
|
101
|
-
year: Optional[str] = None
|
|
102
|
-
"""
|
|
103
|
-
Year in which the reference was published.
|
|
104
|
-
"""
|
|
105
|
-
issue: Optional[str] = None
|
|
106
|
-
"""
|
|
107
|
-
Issue of the collection in which the work appeared.
|
|
108
|
-
"""
|
|
109
|
-
pages: Optional[PagesSchema] = Field(None, title="pages schema")
|
|
110
|
-
"""
|
|
111
|
-
Start and end pages of the work.
|
|
112
|
-
"""
|
|
113
|
-
authors: Optional[List[ExperimentAuthorSchema]] = None
|
|
114
|
-
"""
|
|
115
|
-
List of authors of the work.
|
|
116
|
-
"""
|
|
117
|
-
editors: Optional[List[ExperimentAuthorSchema]] = None
|
|
118
|
-
"""
|
|
119
|
-
List of editors of the work.
|
|
120
|
-
"""
|
|
121
|
-
reference: Optional[List[Dict[str, Any]]] = None
|
|
122
|
-
"""
|
|
123
|
-
References cited by the work. Reference objects can nest as deeply as needed. This is useful, for example, when tracking the history of a value referenced in a scholarly article; the top level reference would contain information about where the data was accessed while the nested reference would contain information about where it was originally published.
|
|
124
|
-
"""
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
class InfoForCharacteristicObtainedByExperiment(BaseModel):
|
|
128
|
-
type: Optional[Type] = None
|
|
129
|
-
authors: List[ExperimentAuthorSchema]
|
|
130
|
-
"""
|
|
131
|
-
experiment authors
|
|
132
|
-
"""
|
|
133
|
-
title: str
|
|
134
|
-
"""
|
|
135
|
-
experiment title
|
|
136
|
-
"""
|
|
137
|
-
method: str
|
|
138
|
-
"""
|
|
139
|
-
method used in experiment
|
|
140
|
-
"""
|
|
141
|
-
conditions: List[ConditionSchema]
|
|
142
|
-
location: Optional[LocationSchema] = Field(None, title="location schema")
|
|
143
|
-
timestamp: float
|
|
144
|
-
"""
|
|
145
|
-
epoch time.
|
|
146
|
-
"""
|
|
147
|
-
note: Optional[str] = None
|
|
148
|
-
"""
|
|
149
|
-
Note about experiment
|
|
150
|
-
"""
|
|
151
|
-
references: Optional[List[LiteratureReferenceSchema]] = None
|
|
152
|
-
"""
|
|
153
|
-
references to literature articles
|
|
154
|
-
"""
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
class SystemTag(Enum):
|
|
158
|
-
isRefined = "isRefined"
|
|
159
|
-
isBest = "isBest"
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
class SchemaOfMaterialSMetaProperties(BaseModel):
|
|
163
|
-
slug: Optional[str] = None
|
|
164
|
-
"""
|
|
165
|
-
property slug, e.g. total_energy
|
|
166
|
-
"""
|
|
167
|
-
group: Optional[str] = None
|
|
168
|
-
"""
|
|
169
|
-
property group, e.g. qe:dft:gga:pbe
|
|
170
|
-
"""
|
|
171
|
-
data: Dict[str, Any]
|
|
172
|
-
"""
|
|
173
|
-
container of the information, specific to each property
|
|
174
|
-
"""
|
|
175
|
-
source: field_This_could_be_an_article__a_simulation_on_Exabyte__an_external_simulation__etc.Field = Field(
|
|
176
|
-
...,
|
|
177
|
-
title="The source of a property. This could be an article, a simulation on Exabyte, an external simulation, etc.",
|
|
178
|
-
)
|
|
179
|
-
exabyteId: Optional[List[str]] = None
|
|
180
|
-
"""
|
|
181
|
-
Id of the corresponding item in the entity bank that this property is obtained for
|
|
182
|
-
"""
|
|
183
|
-
precision: Optional[Dict[str, Any]] = None
|
|
184
|
-
count: Optional[float] = None
|
|
185
|
-
"""
|
|
186
|
-
total number of properties among which this property is the best.
|
|
187
|
-
"""
|
|
188
|
-
systemTags: Optional[List[SystemTag]] = None
|
|
189
|
-
"""
|
|
190
|
-
property system tags, marks property system characteristics, values refined or best (could be both)
|
|
191
|
-
"""
|
|
192
|
-
field_id: Optional[str] = Field(None, alias="_id")
|
|
193
|
-
"""
|
|
194
|
-
entity identity
|
|
195
|
-
"""
|
|
196
|
-
systemName: Optional[str] = None
|
|
197
|
-
schemaVersion: Optional[str] = "2022.8.16"
|
|
198
|
-
"""
|
|
199
|
-
entity's schema version. Used to distinct between different schemas.
|
|
200
|
-
"""
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# generated by datamodel-codegen:
|
|
2
|
-
# filename: software_directory/ml/exabyteml.json
|
|
3
|
-
# version: 0.28.5
|
|
4
|
-
|
|
5
|
-
from __future__ import annotations
|
|
6
|
-
|
|
7
|
-
from enum import Enum
|
|
8
|
-
from typing import Optional
|
|
9
|
-
|
|
10
|
-
from pydantic import BaseModel
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
class Name(Enum):
|
|
14
|
-
exabyteml = "exabyteml"
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
class Summary(Enum):
|
|
18
|
-
exabyte_machine_learning_engine = "exabyte machine learning engine"
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
class Version(Enum):
|
|
22
|
-
field_0_2_0 = "0.2.0"
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
class ExabyteMachineLearningEngineSchema(BaseModel):
|
|
26
|
-
name: Optional[Name] = None
|
|
27
|
-
summary: Optional[Summary] = None
|
|
28
|
-
version: Optional[Version] = None
|