PropertyDoc

class emmet.core.material_property.PropertyDoc(**data)

Bases: BasePropertyMetadata

Base model definition for any singular materials property.

This may contain any amount of structure metadata for the purpose of search. This is intended to be inherited and extended, not used directly

Parameters:

  • builder_meta (EmmetMeta | None)

  • nsites (int | None)

  • elements (list[Annotated[ElementTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.element_adapter.<lambda>, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.element_adapter.<lambda>, return_type=str, when_used=always)]] | None)

  • nelements (int | None)

  • composition (Annotated[CompositionTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.composition_adapter.<lambda>, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.composition_adapter.<lambda>, return_type=dict[str, float], when_used=always)] | None)

  • composition_reduced (Annotated[CompositionTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.composition_adapter.<lambda>, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.composition_adapter.<lambda>, return_type=dict[str, float], when_used=always)] | None)

  • formula_pretty (str | None)

  • formula_anonymous (str | None)

  • chemsys (str | None)

  • volume (float | None)

  • density (float | None)

  • density_atomic (float | None)

  • symmetry (SymmetryData | None)

  • material_id (Annotated[MPID | AlphaID, BeforeValidator(func=functools.partial(<function _fault_tolerant_id_serde at 0x7f75d76d4cc0>, legacy=True, prefix='mp', padlen=8), json_schema_input_type=PydanticUndefined), PlainSerializer(func=functools.partial(<function _fault_tolerant_id_serde at 0x7f75d76d4cc0>, serialize=True, legacy=True, prefix='mp', padlen=8), return_type=PydanticUndefined, when_used=always)] | None)

  • deprecated (bool)

  • deprecation_reasons (list[DeprecationMessage | str] | None)

  • last_updated (Annotated[datetime, BeforeValidator(func=~emmet.core.utils.convert_datetime, json_schema_input_type=PydanticUndefined)])

  • origins (list[PropertyOrigin] | None)

  • warnings (list[str])

  • structure (Annotated[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, SkipJsonSchema()])

  • property_name (str)

model_config: ClassVar[ConfigDict] = {}

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