SummaryBuilderInputs

class emmet.builders.materials.summary.SummaryBuilderInputs(**data)

Bases: BaseModel

Input model for building summary documents.

Bundles the property summary documents and property shim documents needed to construct a single SummaryDoc. Property summary documents contribute field values to the resulting SummaryDoc, while property shim documents are used solely to populate the has_props mapping.

Parameters:

• property_summary_docs (list[MaterialsSummary | ThermoSummary | XASSummary | GBSummary | ElectronicStructureSummary | BandstructureSummary | DosSummary | MagnetismSummary | ElasticitySummary | DielectricSummary | PiezoelectricSummary | SurfacesSummary | OxiStatesSummary | ProvenanceSummary | PhononSummary])

• property_shim_docs (list[ChargeDensityData | EosData | AbsorptionData | ElectrodesData | SubstratesData | ChemenvData])

model_config: ClassVar[ConfigDict] = {}

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