`iemap`

Module Contents

Classes

`ObjectIdStr`	str(object='') -> str
`UpdatedAt`
`User`
`Project`
`Parameter`
`SwAgent`
`Calculation`
`SwAgent1`
`Experiment`
`ChemicalCompositionItem`
`Lattice`
`Input`
`Lattice1`
`Output`
`Material`
`Axis`
`Units`
`CreatedAt1`
`UpdatedAt1`
`PropertyFile`
`Property`
`Process`
`CreatedAt2`
`UpdatedAt2`
`Publication`
`fileType`	Generic enumeration.
`FileProject`
`newProject`
`PropertyForm`
`ProjectFileForm`

Functions

`validate_datetime`(cls, values)	Reusable validator for pydantic models
`as_form`(cls: Type[pydantic.BaseModel])

class iemap.ObjectIdStr

Bases: str

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

classmethod __get_validators__(cls)

classmethod validate(cls, v)

class iemap.UpdatedAt

Bases: pydantic.BaseModel

_date :Optional[str]

class iemap.User

Bases: pydantic.BaseModel

email :str

affiliation :str

class iemap.Project

Bases: pydantic.BaseModel

name :str

description :str

label :str

class iemap.Parameter

Bases: pydantic.BaseModel

name :str

type :str

value :float

class iemap.SwAgent

Bases: pydantic.BaseModel

name :str

version :str

class iemap.Calculation

Bases: pydantic.BaseModel

method :str

swAgent :SwAgent

class iemap.SwAgent1

Bases: pydantic.BaseModel

name :str

version :str

class iemap.Experiment

Bases: pydantic.BaseModel

method :str

swAgent :SwAgent1

class iemap.ChemicalCompositionItem

Bases: pydantic.BaseModel

element :str

percentage :str

class iemap.Lattice

Bases: pydantic.BaseModel

a :str

b :str

c :str

alpha :str

beta :str

gamma :str

class iemap.Input

Bases: pydantic.BaseModel

lattice :Lattice

sites :str

species :str

class iemap.Lattice1

Bases: pydantic.BaseModel

a :str

b :str

c :str

alpha :str

beta :str

gamma :str

class iemap.Output

Bases: pydantic.BaseModel

lattice :Lattice1

sites :str

species :str

class iemap.Material

Bases: pydantic.BaseModel

formula :str

elements :List[Union[str, str]]

chemicalComposition :List[ChemicalCompositionItem]

input :Optional[Input]

output :Optional[Output]

class iemap.Axis

Bases: pydantic.BaseModel

labelX :str

labelY :str

class iemap.Units

Bases: pydantic.BaseModel

x :str

y :str

class iemap.CreatedAt1

Bases: pydantic.BaseModel

_date :str

class iemap.UpdatedAt1

Bases: pydantic.BaseModel

_date :str

class iemap.PropertyFile

Bases: pydantic.BaseModel

name :str

hash :Optional[str]

extention :Optional[str]

size :Optional[str]

createdAt :Annotated[datetime.datetime, Field(default_factory=lambda: datetime.now().utcnow())]

updatedAt :Annotated[datetime.datetime, Field(default_factory=lambda: datetime.now().utcnow())]

class iemap.Property

Bases: pydantic.BaseModel

name :str

type :str

value :float

file :Optional[PropertyFile]

isCalculated :bool

isPhysical :bool

class iemap.Process

Bases: pydantic.BaseModel

isExperiment :bool

isSimulation :bool

parameters :List[Parameter]

calculation :Calculation

experiment :Experiment

material :Material

properties :List[Property]

iemapID :str

class iemap.CreatedAt2

Bases: pydantic.BaseModel

_date :str

class iemap.UpdatedAt2

Bases: pydantic.BaseModel

_date :str

class iemap.Publication

Bases: pydantic.BaseModel

class Config

validate_assignment = True

name :str

date :datetime.datetime

url :Optional[str]

_set_publication_date_type(cls, date: datetime.datetime)

class iemap.fileType

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

Code = Code

Tabular = Tabular

Image = Image

Raw_Inst_Data = Raw Instrument Data

static from_str(label)

class iemap.FileProject

Bases: pydantic.BaseModel

class Config

use_enum_values = True

hash :Optional[str]

description :str

name :str

extention :str

type :fileType

isProcessed :bool

size :Optional[str]

createdAt :Annotated[datetime.datetime, Field(default_factory=lambda: datetime.now().utcnow())]

updatedAt :Annotated[datetime.datetime, Field(default_factory=lambda: datetime.now().utcnow())]

publication :Optional[Publication]

iemap.validate_datetime(cls, values): Reusable validator for pydantic models

class iemap.newProject

Bases: pydantic.BaseModel

class Config

validate_assignment = True

createdAt :Annotated[datetime.datetime, Field(default_factory=lambda: datetime.now().utcnow())]

updatedAt :Annotated[datetime.datetime, Field(default_factory=lambda: datetime.now().utcnow())]

user :User

project :Project

projectWP :str

process :Process

files :Optional[List[FileProject]]

_v :Optional[str]

iemap.as_form(cls: Type[pydantic.BaseModel])

class iemap.PropertyForm

Bases: pydantic.BaseModel

name :str

type :str

axis_labelX :str

axis_labelY :str

value :float

units_x :str

units_y :str

isCalculated :bool

isPhysical :bool

class iemap.ProjectFileForm

Bases: pydantic.BaseModel

name :str

description :str

type :str

isProcessed :str

publication_name :Optional[str] =

publication_date :Optional[str]

publication_url :Optional[str] =

iemap

Module Contents

Classes

Functions

`iemap`