mat3ra-esse 2025.7.15.post0__py3-none-any.whl → 2025.7.29.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/apse/file/applications/espresso/7.2/pw_x.py +6 -6
- mat3ra/esse/models/core/abstract/vector_2d.py +13 -0
- mat3ra/esse/models/core/primitive/array_of_2_numbers.py +13 -0
- mat3ra/esse/models/core/reusable/energy.py +2 -2
- mat3ra/esse/models/element.py +6 -6
- mat3ra/esse/models/material/__init__.py +14 -14
- mat3ra/esse/models/materials_category/compound_pristine_structures/two_dimensional/interface/__init__.py +3 -0
- mat3ra/esse/models/materials_category/compound_pristine_structures/two_dimensional/interface/configuration.py +6039 -0
- mat3ra/esse/models/materials_category/defective_structures/one_dimensional/grain_boundary_linear/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defective_structures/one_dimensional/grain_boundary_linear/configuration.py +6043 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/adatom/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/adatom/configuration.py +2116 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/base_configuration.py +1561 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/grain_boundary_planar/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/grain_boundary_planar/configuration.py +6039 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/island/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/island/configuration.py +2888 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/terrace/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defective_structures/two_dimensional/terrace/configuration.py +2892 -0
- mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/__init__.py +3 -0
- mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/base_configuration.py +544 -0
- mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/interstitial.py +1099 -0
- mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/substitutional.py +1099 -0
- mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/vacancy.py +556 -0
- mat3ra/esse/models/materials_category/pristine_structures/three_dimensional/ideal_crystal.py +14 -14
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanoribbon.py +1582 -0
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanotape.py +1148 -0
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab.py +78 -94
- mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab_strained_supercell.py +1147 -0
- 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/__init__.py +3 -0
- mat3ra/esse/models/materials_category/processed_structures/two_dimensional/passivation/configuration.py +1232 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/one_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/one_dimensional/miller_indices_2d.py +16 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/crystal_site.py +527 -2
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/point_defect_site.py +676 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/void_region.py +555 -0
- mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/void_site.py +1576 -0
- mat3ra/esse/models/materials_category_components/entities/core/three_dimensional/crystal.py +14 -14
- mat3ra/esse/models/materials_category_components/entities/core/two_dimensional/vacuum.py +14 -14
- mat3ra/esse/models/materials_category_components/entities/core/zero_dimensional/vacancy.py +22 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/__init__.py +3 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_base.py +541 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_lines.py +545 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/one_dimensional/crystal_lattice_lines_unique_repeated.py +708 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/crystal_lattice_base.py +541 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_non_uniform.py +14 -14
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_uniform.py +14 -14
- mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/supercell.py +14 -14
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/atomic_layers.py +4 -4
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/atomic_layers_unique.py +4 -4
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/atomic_layers_unique_repeated.py +4 -4
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/crystal_lattice_planes.py +18 -18
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/slab_stack_configuration.py +1561 -0
- mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/slab_unit_cell.py +74 -77
- mat3ra/esse/models/materials_category_components/operations/core/combinations/enums.py +13 -0
- mat3ra/esse/models/materials_category_components/operations/core/combinations/merge.py +9 -981
- mat3ra/esse/models/materials_category_components/operations/core/combinations/stack.py +3 -947
- mat3ra/esse/models/materials_category_components/operations/core/modifications/perturb.py +538 -0
- mat3ra/esse/models/properties_directory/derived_properties.py +11 -11
- mat3ra/esse/models/properties_directory/non_scalar/density_of_states.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/phonon_dispersions.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/phonon_dos.py +2 -2
- mat3ra/esse/models/properties_directory/non_scalar/total_energy_contributions.py +50 -50
- mat3ra/esse/models/properties_directory/non_scalar/vibrational_spectrum.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/electron_affinity.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/fermi_energy.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/formation_energy.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/ionization_potential.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/reaction_energy_barrier.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/surface_energy.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/total_energy.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/valence_band_offset.py +2 -2
- mat3ra/esse/models/properties_directory/scalar/zero_point_energy.py +2 -2
- mat3ra/esse/models/properties_directory/structural/basis/__init__.py +2 -2
- mat3ra/esse/models/properties_directory/structural/molecular_pattern.py +4 -4
- mat3ra/esse/models/properties_directory/workflow/convergence/ionic.py +2 -2
- {mat3ra_esse-2025.7.15.post0.dist-info → mat3ra_esse-2025.7.29.post0.dist-info}/METADATA +1 -1
- {mat3ra_esse-2025.7.15.post0.dist-info → mat3ra_esse-2025.7.29.post0.dist-info}/RECORD +85 -44
- {mat3ra_esse-2025.7.15.post0.dist-info → mat3ra_esse-2025.7.29.post0.dist-info}/WHEEL +0 -0
- {mat3ra_esse-2025.7.15.post0.dist-info → mat3ra_esse-2025.7.29.post0.dist-info}/licenses/LICENSE.md +0 -0
- {mat3ra_esse-2025.7.15.post0.dist-info → mat3ra_esse-2025.7.29.post0.dist-info}/top_level.txt +0 -0
|
@@ -131,13 +131,13 @@ class Value(Enum):
|
|
|
131
131
|
Og = "Og"
|
|
132
132
|
|
|
133
133
|
|
|
134
|
-
class
|
|
134
|
+
class Value131(Enum):
|
|
135
135
|
X = "X"
|
|
136
136
|
Vac = "Vac"
|
|
137
137
|
|
|
138
138
|
|
|
139
139
|
class AtomicElementSchema(BaseModel):
|
|
140
|
-
value: Union[Value,
|
|
140
|
+
value: Union[Value, Value131]
|
|
141
141
|
"""
|
|
142
142
|
All elements, including extra elements
|
|
143
143
|
"""
|
|
@@ -285,30 +285,30 @@ class VolumeSchema(BaseModel):
|
|
|
285
285
|
value: float
|
|
286
286
|
|
|
287
287
|
|
|
288
|
-
class
|
|
288
|
+
class Name497(Enum):
|
|
289
289
|
density = "density"
|
|
290
290
|
|
|
291
291
|
|
|
292
|
-
class
|
|
292
|
+
class Units193(Enum):
|
|
293
293
|
g_cm_3 = "g/cm^3"
|
|
294
294
|
|
|
295
295
|
|
|
296
296
|
class DensitySchema(BaseModel):
|
|
297
297
|
name: Literal["1#-datamodel-code-generator-#-object-#-special-#"]
|
|
298
|
-
units: Optional[
|
|
298
|
+
units: Optional[Units193] = None
|
|
299
299
|
value: float
|
|
300
300
|
|
|
301
301
|
|
|
302
|
-
class
|
|
302
|
+
class Units194(Enum):
|
|
303
303
|
angstrom = "angstrom"
|
|
304
304
|
|
|
305
305
|
|
|
306
306
|
class ScalarSchema(BaseModel):
|
|
307
|
-
units: Optional[
|
|
307
|
+
units: Optional[Units194] = None
|
|
308
308
|
value: float
|
|
309
309
|
|
|
310
310
|
|
|
311
|
-
class
|
|
311
|
+
class Name498(Enum):
|
|
312
312
|
symmetry = "symmetry"
|
|
313
313
|
|
|
314
314
|
|
|
@@ -328,7 +328,7 @@ class SymmetrySchema(BaseModel):
|
|
|
328
328
|
name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
|
|
329
329
|
|
|
330
330
|
|
|
331
|
-
class
|
|
331
|
+
class Name499(Enum):
|
|
332
332
|
elemental_ratio = "elemental_ratio"
|
|
333
333
|
|
|
334
334
|
|
|
@@ -341,7 +341,7 @@ class ElementalRatio(BaseModel):
|
|
|
341
341
|
"""
|
|
342
342
|
|
|
343
343
|
|
|
344
|
-
class
|
|
344
|
+
class Name500(Enum):
|
|
345
345
|
p_norm = "p-norm"
|
|
346
346
|
|
|
347
347
|
|
|
@@ -354,7 +354,7 @@ class PNorm(BaseModel):
|
|
|
354
354
|
value: float
|
|
355
355
|
|
|
356
356
|
|
|
357
|
-
class
|
|
357
|
+
class Name501(Enum):
|
|
358
358
|
inchi = "inchi"
|
|
359
359
|
|
|
360
360
|
|
|
@@ -363,7 +363,7 @@ class InChIRepresentationSchema(BaseModel):
|
|
|
363
363
|
value: str
|
|
364
364
|
|
|
365
365
|
|
|
366
|
-
class
|
|
366
|
+
class Name502(Enum):
|
|
367
367
|
inchi_key = "inchi_key"
|
|
368
368
|
|
|
369
369
|
|
|
@@ -442,7 +442,7 @@ class FileSourceSchema(BaseModel):
|
|
|
442
442
|
"""
|
|
443
443
|
|
|
444
444
|
|
|
445
|
-
class
|
|
445
|
+
class Name503(Enum):
|
|
446
446
|
default = "default"
|
|
447
447
|
atomsTooClose = "atomsTooClose"
|
|
448
448
|
atomsOverlap = "atomsOverlap"
|
|
@@ -455,7 +455,7 @@ class Severity(Enum):
|
|
|
455
455
|
|
|
456
456
|
|
|
457
457
|
class MaterialConsistencyCheckSchema(BaseModel):
|
|
458
|
-
name:
|
|
458
|
+
name: Name503
|
|
459
459
|
"""
|
|
460
460
|
Name of the consistency check that is performed, which is listed in an enum.
|
|
461
461
|
"""
|
|
@@ -137,13 +137,13 @@ class Value(Enum):
|
|
|
137
137
|
Og = "Og"
|
|
138
138
|
|
|
139
139
|
|
|
140
|
-
class
|
|
140
|
+
class Value201(Enum):
|
|
141
141
|
X = "X"
|
|
142
142
|
Vac = "Vac"
|
|
143
143
|
|
|
144
144
|
|
|
145
145
|
class AtomicElementSchema(BaseModel):
|
|
146
|
-
value: Union[Value,
|
|
146
|
+
value: Union[Value, Value201]
|
|
147
147
|
"""
|
|
148
148
|
All elements, including extra elements
|
|
149
149
|
"""
|
|
@@ -291,30 +291,30 @@ class VolumeSchema(BaseModel):
|
|
|
291
291
|
value: float
|
|
292
292
|
|
|
293
293
|
|
|
294
|
-
class
|
|
294
|
+
class Name825(Enum):
|
|
295
295
|
density = "density"
|
|
296
296
|
|
|
297
297
|
|
|
298
|
-
class
|
|
298
|
+
class Units332(Enum):
|
|
299
299
|
g_cm_3 = "g/cm^3"
|
|
300
300
|
|
|
301
301
|
|
|
302
302
|
class DensitySchema(BaseModel):
|
|
303
303
|
name: Literal["1#-datamodel-code-generator-#-object-#-special-#"]
|
|
304
|
-
units: Optional[
|
|
304
|
+
units: Optional[Units332] = None
|
|
305
305
|
value: float
|
|
306
306
|
|
|
307
307
|
|
|
308
|
-
class
|
|
308
|
+
class Units333(Enum):
|
|
309
309
|
angstrom = "angstrom"
|
|
310
310
|
|
|
311
311
|
|
|
312
312
|
class ScalarSchema(BaseModel):
|
|
313
|
-
units: Optional[
|
|
313
|
+
units: Optional[Units333] = None
|
|
314
314
|
value: float
|
|
315
315
|
|
|
316
316
|
|
|
317
|
-
class
|
|
317
|
+
class Name826(Enum):
|
|
318
318
|
symmetry = "symmetry"
|
|
319
319
|
|
|
320
320
|
|
|
@@ -334,7 +334,7 @@ class SymmetrySchema(BaseModel):
|
|
|
334
334
|
name: Literal["2#-datamodel-code-generator-#-object-#-special-#"]
|
|
335
335
|
|
|
336
336
|
|
|
337
|
-
class
|
|
337
|
+
class Name827(Enum):
|
|
338
338
|
elemental_ratio = "elemental_ratio"
|
|
339
339
|
|
|
340
340
|
|
|
@@ -347,7 +347,7 @@ class ElementalRatio(BaseModel):
|
|
|
347
347
|
"""
|
|
348
348
|
|
|
349
349
|
|
|
350
|
-
class
|
|
350
|
+
class Name828(Enum):
|
|
351
351
|
p_norm = "p-norm"
|
|
352
352
|
|
|
353
353
|
|
|
@@ -360,7 +360,7 @@ class PNorm(BaseModel):
|
|
|
360
360
|
value: float
|
|
361
361
|
|
|
362
362
|
|
|
363
|
-
class
|
|
363
|
+
class Name829(Enum):
|
|
364
364
|
inchi = "inchi"
|
|
365
365
|
|
|
366
366
|
|
|
@@ -369,7 +369,7 @@ class InChIRepresentationSchema(BaseModel):
|
|
|
369
369
|
value: str
|
|
370
370
|
|
|
371
371
|
|
|
372
|
-
class
|
|
372
|
+
class Name830(Enum):
|
|
373
373
|
inchi_key = "inchi_key"
|
|
374
374
|
|
|
375
375
|
|
|
@@ -448,7 +448,7 @@ class FileSourceSchema(BaseModel):
|
|
|
448
448
|
"""
|
|
449
449
|
|
|
450
450
|
|
|
451
|
-
class
|
|
451
|
+
class Name831(Enum):
|
|
452
452
|
default = "default"
|
|
453
453
|
atomsTooClose = "atomsTooClose"
|
|
454
454
|
atomsOverlap = "atomsOverlap"
|
|
@@ -461,7 +461,7 @@ class Severity(Enum):
|
|
|
461
461
|
|
|
462
462
|
|
|
463
463
|
class MaterialConsistencyCheckSchema(BaseModel):
|
|
464
|
-
name:
|
|
464
|
+
name: Name831
|
|
465
465
|
"""
|
|
466
466
|
Name of the consistency check that is performed, which is listed in an enum.
|
|
467
467
|
"""
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# generated by datamodel-codegen:
|
|
2
|
+
# filename: materials_category_components/entities/core/zero_dimensional/vacancy.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 ChemicalElement(Enum):
|
|
14
|
+
X = "X"
|
|
15
|
+
Vac = "Vac"
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
class VacancySchema(BaseModel):
|
|
19
|
+
chemical_element: Optional[ChemicalElement] = "Vac"
|
|
20
|
+
"""
|
|
21
|
+
Extra elements, used for convenience purposed
|
|
22
|
+
"""
|