1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
from datetime import datetime
from typing import List, Optional
from pydantic import BaseModel, Field, field_validator
from emmet.core.common import convert_datetime
class FermiDoc(BaseModel):
"""
Fermi surfaces.
"""
fermi_surfaces: Optional[List[dict]] = Field(
None,
description="List of IFermi FermiSurface objects.",
)
surface_types: Optional[List[str]] = Field(
None,
description="Type of each fermi surface in the fermi_surfaces list.\
Is either CBM or VBM for semiconductors, or fermi_surface for metals.",
)
material_id: Optional[str] = Field(
None,
description="The Materials Project ID of the material. This comes in the form: mp-******.",
)
last_updated: Optional[datetime] = Field(
None,
description="Timestamp for the most recent calculation for this fermi surface document.",
)
# Make sure that the datetime field is properly formatted
@field_validator("last_updated", mode="before")
@classmethod
def handle_datetime(cls, v):
return convert_datetime(cls, v)
|
