mat3ra-esse 2024.4.8.post1__py3-none-any.whl → 2024.4.8.post3__py3-none-any.whl

mat3ra/esse/models/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   version:   0.25.5

mat3ra/esse/models/core/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   version:   0.25.5

mat3ra/esse/models/core/abstract/2d_data.py

@@ -0,0 +1,17 @@
+# generated by datamodel-codegen:
+#   filename:  core/abstract/2d_data.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List, Union
+
+from pydantic import BaseModel, Field
+
+
+class Field2DimensionDataSchema(BaseModel):
+    xDataArray: List
+    """
+    array containing values of x Axis
+    """
+    yDataSeries: List[List[Union[float, str]]] = Field(..., title="1 dimension data series schema")

mat3ra/esse/models/core/abstract/2d_plot.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  core/abstract/2d_plot.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List, Optional, Union
+
+from pydantic import BaseModel, Field
+
+
+class AxisSchema(BaseModel):
+    label: str
+    """
+    label of an axis object
+    """
+    units: Optional[str] = None
+    """
+    units for an axis
+    """
+
+
+class Field2DimensionPlotSchema(BaseModel):
+    xAxis: AxisSchema = Field(..., title="axis schema")
+    yAxis: AxisSchema = Field(..., title="axis schema")
+    legend: Optional[List] = Field(None, min_length=1)
+    """
+    Legend of y Axis data series
+    """
+    xDataArray: List
+    """
+    array containing values of x Axis
+    """
+    yDataSeries: List[List[Union[float, str]]] = Field(..., title="1 dimension data series schema")

mat3ra/esse/models/core/abstract/3d_grid.py

@@ -0,0 +1,14 @@
+# generated by datamodel-codegen:
+#   filename:  core/abstract/3d_grid.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List
+
+from pydantic import BaseModel, Field
+
+
+class Field3DimensionalGridSchema(BaseModel):
+    dimensions: List[float] = Field(..., max_length=3, min_length=3, title="array of 3 number elements schema")
+    shifts: List[float] = Field(..., max_length=3, min_length=3, title="array of 3 number elements schema")

mat3ra/esse/models/core/abstract/3d_tensor.py

@@ -0,0 +1,19 @@
+# generated by datamodel-codegen:
+#   filename:  core/abstract/3d_tensor.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Any, List
+
+from pydantic import Field, RootModel
+
+
+class ArrayOf3NumberElementsSchema(RootModel[List[Any]]):
+    root: List[Any] = Field(..., title="array of 3 number elements schema")
+
+
+class Field3DimensionalTensorSchema(RootModel[List[ArrayOf3NumberElementsSchema]]):
+    root: List[ArrayOf3NumberElementsSchema] = Field(
+        ..., max_length=3, min_length=3, title="3 dimensional tensor schema"
+    )

mat3ra/esse/models/core/abstract/3d_vector_basis.py

@@ -0,0 +1,15 @@
+# generated by datamodel-codegen:
+#   filename:  core/abstract/3d_vector_basis.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List
+
+from pydantic import BaseModel, Field
+
+
+class Field3DimensionalVectorBasis(BaseModel):
+    a: List[float] = Field(..., max_length=3, min_length=3, title="array of 3 number elements schema")
+    b: List[float] = Field(..., max_length=3, min_length=3, title="array of 3 number elements schema")
+    c: List[float] = Field(..., max_length=3, min_length=3, title="array of 3 number elements schema")

mat3ra/esse/models/core/abstract/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   version:   0.25.5

mat3ra/esse/models/core/abstract/point.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  core/abstract/point.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List
+
+from pydantic import Field, RootModel
+
+
+class PointSchema(RootModel[List[float]]):
+    root: List[float] = Field(..., max_length=3, min_length=3, title="point schema")

mat3ra/esse/models/core/abstract/vector.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  core/abstract/vector.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List, Union
+
+from pydantic import Field, RootModel
+
+
+class ESSE(RootModel[Union[List[float], List[bool]]]):
+    root: Union[List[float], List[bool]] = Field(..., title="vector schema")

mat3ra/esse/models/core/primitive/1d_data_series.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/1d_data_series.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List, Union
+
+from pydantic import Field, RootModel
+
+
+class Field1DimensionDataSeriesSchema(RootModel[List[List[Union[float, str]]]]):
+    root: List[List[Union[float, str]]] = Field(..., title="1 dimension data series schema")

mat3ra/esse/models/core/primitive/3d_lattice.py

@@ -0,0 +1,34 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/3d_lattice.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class Field3DimensionalLatticeSchema(BaseModel):
+    a: float
+    """
+    length of the first lattice vector
+    """
+    b: float
+    """
+    length of the second lattice vector
+    """
+    c: float
+    """
+    length of the third lattice vector
+    """
+    alpha: float
+    """
+    angle between first and second lattice vector
+    """
+    beta: float
+    """
+    angle between second and third lattice vector
+    """
+    gamma: float
+    """
+    angle between first and third lattice vector
+    """

mat3ra/esse/models/core/primitive/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   version:   0.25.5

mat3ra/esse/models/core/primitive/array_of_3_booleans.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/array_of_3_booleans.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List
+
+from pydantic import Field, RootModel
+
+
+class ArrayOf3BooleanElementsSchema(RootModel[List[bool]]):
+    root: List[bool] = Field(..., max_length=3, min_length=3, title="array of 3 boolean elements schema")

mat3ra/esse/models/core/primitive/array_of_3_numbers.py

@@ -0,0 +1,13 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/array_of_3_numbers.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List
+
+from pydantic import Field, RootModel
+
+
+class ArrayOf3NumberElementsSchema(RootModel[List[float]]):
+    root: List[float] = Field(..., max_length=3, min_length=3, title="array of 3 number elements schema")

mat3ra/esse/models/core/primitive/array_of_ids.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/array_of_ids.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from pydantic import BaseModel, Field, RootModel
+
+
+class AtomicId(BaseModel):
+    id: Optional[int] = None
+    """
+    integer id of this entry
+    """
+
+
+class AtomicIds(RootModel[List[AtomicId]]):
+    root: List[AtomicId] = Field(..., title="atomic ids")
+    """
+    array of objects containing integer id each
+    """

mat3ra/esse/models/core/primitive/array_of_strings.py

@@ -0,0 +1,16 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/array_of_strings.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import List
+
+from pydantic import Field, RootModel
+
+
+class ArrayOfStrings(RootModel[List[str]]):
+    root: List[str] = Field(..., title="array of strings")
+    """
+    array of strings, e.g. metadata tags
+    """

mat3ra/esse/models/core/primitive/axis.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/axis.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class AxisSchema(BaseModel):
+    label: str
+    """
+    label of an axis object
+    """
+    units: Optional[str] = None
+    """
+    units for an axis
+    """

mat3ra/esse/models/core/primitive/group_info.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/group_info.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class GroupInfoSchemaForNodesInAGraph(BaseModel):
+    groupName: Optional[str] = None
+    """
+    Human-readable name of group of nodes
+    """
+    groupId: Optional[str] = None
+    """
+    Unique identifier of the group a node belongs to
+    """

mat3ra/esse/models/core/primitive/integer_one_or_zero.py

@@ -0,0 +1,11 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/integer_one_or_zero.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from pydantic import Field, RootModel, conint
+
+
+class IntegerOneOrZero(RootModel[conint(ge=0, le=1)]):
+    root: conint(ge=0, le=1) = Field(..., title="integer one or zero")

mat3ra/esse/models/core/primitive/linked_list/__init__.py

@@ -0,0 +1,33 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/linked_list.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Any, Dict, List, Union
+
+from pydantic import Field, RootModel
+
+
+class BasicNodeSchemaLinkedList(RootModel[Dict[str, Any]]):
+    root: Dict[str, Any] = Field(..., title="basic node schema (linked list)")
+
+
+class NamedNodeSchema(RootModel[Dict[str, Any]]):
+    root: Dict[str, Any] = Field(..., title="Named node schema")
+
+
+class NamedNodeInGroupSchema(RootModel[Dict[str, Any]]):
+    root: Dict[str, Any] = Field(..., title="Named node in group schema")
+
+
+class TypedNodeSchema(RootModel[Dict[str, Any]]):
+    root: Dict[str, Any] = Field(..., title="Typed node schema")
+
+
+class LinkedListSchema(
+    RootModel[List[Union[BasicNodeSchemaLinkedList, NamedNodeSchema, NamedNodeInGroupSchema, TypedNodeSchema]]]
+):
+    root: List[Union[BasicNodeSchemaLinkedList, NamedNodeSchema, NamedNodeInGroupSchema, TypedNodeSchema]] = Field(
+        ..., title="linked list schema"
+    )

mat3ra/esse/models/core/primitive/linked_list/base_node.py

@@ -0,0 +1,31 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/linked_list/base_node.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class BasicNodeSchemaLinkedList(BaseModel):
+    next: Optional[str] = None
+    """
+    Flowchart ID of next node
+    """
+    head: Optional[bool] = None
+    """
+    Whether node is head node or not
+    """
+    flowchartId: str
+    """
+    Unique flowchart ID of node
+    """
+
+
+class FlowchartId(BaseModel):
+    flowchartId: str
+    """
+    Unique flowchart ID of node
+    """

mat3ra/esse/models/core/primitive/linked_list/named_node.py

@@ -0,0 +1,35 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/linked_list/named_node.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class NamedNodeSchema(BaseModel):
+    next: Optional[str] = None
+    """
+    Flowchart ID of next node
+    """
+    head: Optional[bool] = None
+    """
+    Whether node is head node or not
+    """
+    flowchartId: str
+    """
+    Unique flowchart ID of node
+    """
+    name: Optional[str] = None
+    """
+    entity name
+    """
+
+
+class FlowchartId(BaseModel):
+    flowchartId: str
+    """
+    Unique flowchart ID of node
+    """

mat3ra/esse/models/core/primitive/linked_list/named_node_in_group.py

@@ -0,0 +1,43 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/linked_list/named_node_in_group.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class NamedNodeInGroupSchema(BaseModel):
+    next: Optional[str] = None
+    """
+    Flowchart ID of next node
+    """
+    head: Optional[bool] = None
+    """
+    Whether node is head node or not
+    """
+    flowchartId: str
+    """
+    Unique flowchart ID of node
+    """
+    name: Optional[str] = None
+    """
+    entity name
+    """
+    groupName: Optional[str] = None
+    """
+    Human-readable name of group of nodes
+    """
+    groupId: Optional[str] = None
+    """
+    Unique identifier of the group a node belongs to
+    """
+
+
+class FlowchartId(BaseModel):
+    flowchartId: str
+    """
+    Unique flowchart ID of node
+    """

mat3ra/esse/models/core/primitive/linked_list/node_with_type.py

@@ -0,0 +1,32 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/linked_list/node_with_type.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+class TypedNodeSchema(BaseModel):
+    type: Optional[str] = None
+    next: Optional[str] = None
+    """
+    Flowchart ID of next node
+    """
+    head: Optional[bool] = None
+    """
+    Whether node is head node or not
+    """
+    flowchartId: str
+    """
+    Unique flowchart ID of node
+    """
+
+
+class FlowchartId(BaseModel):
+    flowchartId: str
+    """
+    Unique flowchart ID of node
+    """

mat3ra/esse/models/core/primitive/scalar.py

@@ -0,0 +1,11 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/scalar.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class ScalarSchema(BaseModel):
+    value: float

mat3ra/esse/models/core/primitive/slugified_entry.py

@@ -0,0 +1,18 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/slugified_entry.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class SlugifiedEntry(BaseModel):
+    name: str
+    """
+    descriptive human-readable name of entry
+    """
+    slug: str
+    """
+    machine-readable identifier
+    """

mat3ra/esse/models/core/primitive/slugified_entry_or_slug.py

@@ -0,0 +1,27 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/slugified_entry_or_slug.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from typing import Union
+
+from pydantic import BaseModel, Field, RootModel
+
+
+class SlugifiedEntry(BaseModel):
+    name: str
+    """
+    descriptive human-readable name of entry
+    """
+    slug: str
+    """
+    machine-readable identifier
+    """
+
+
+class ESSE(RootModel[Union[SlugifiedEntry, str]]):
+    root: Union[SlugifiedEntry, str] = Field(..., title="slugified entry or slug")
+    """
+    contains either object with slugified entry or slug only as a string
+    """

mat3ra/esse/models/core/primitive/string.py

@@ -0,0 +1,11 @@
+# generated by datamodel-codegen:
+#   filename:  core/primitive/string.json
+#   version:   0.25.5
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+
+
+class PrimitiveString(BaseModel):
+    value: str