ElectronicDos

class emmet.core.band_theory.ElectronicDos(**data)

Bases: BandTheoryBase

Electronic density of states (DOS) with possible projections.

Parameters:
  • identifier (str | None)

  • structure (Annotated[StructureTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.structure_adapter.pop_empty_structure_keys, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.structure_adapter.<lambda>, return_type=~emmet.core.types.pymatgen_types.structure_adapter.TypedStructureDict, when_used=always)] | None)

  • spin_up_densities (list[float] | None)

  • spin_down_densities (list[float] | None)

  • energies (list[float] | None)

  • efermi (float | None)

  • projected_densities (ProjectedDos | None)

classmethod from_pmg(dos, **kwargs)

Create an electronic DOS from a pymatgen object.

Return type:

Self

Parameters:

dos (Dos | CompleteDos)

to_pmg()

Serialize to pymatgen.

Return type:

Dos | CompleteDos

model_config: ClassVar[ConfigDict] = {}

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