BandStructureSummaryData

class emmet.core.electronic_structure.BandStructureSummaryData(**data)

Bases: ElectronicStructureSummary

Schematize high-level band structure data for the API.

Parameters:

• task_id (Annotated[MPID | AlphaID, BeforeValidator(func=~emmet.core.types.typing._fault_tolerant_id_serde, json_schema_input_type=PydanticUndefined), PlainSerializer(func=~emmet.core.types.typing.<lambda>, return_type=PydanticUndefined, when_used=always)])

• band_gap (float)

• cbm (Annotated[TypedBandDict | None, BeforeValidator(func=~emmet.core.electronic_structure._deser_cbm_vbm, json_schema_input_type=PydanticUndefined)] | None)

• vbm (Annotated[TypedBandDict | None, BeforeValidator(func=~emmet.core.electronic_structure._deser_cbm_vbm, json_schema_input_type=PydanticUndefined)] | None)

• efermi (float | None)

• is_gap_direct (bool)

• is_metal (bool)

• magnetic_ordering (Annotated[Ordering, BeforeValidator(func=~emmet.core.electronic_structure.<lambda>, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.electronic_structure.<lambda>, return_type=str, when_used=always)])

• equivalent_labels (Annotated[dict[str, dict[str, dict[str, str]]], BeforeValidator(func=~emmet.core.electronic_structure._deser_equiv_labels, json_schema_input_type=PydanticUndefined)])

• nbands (float)

• direct_gap (float)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].