ConversionElectrodeDoc

class emmet.core.electrode.ConversionElectrodeDoc(**data)

Bases: ConversionVoltagePairDoc, BaseElectrode

Conversion electrode

Parameters:

• builder_meta (EmmetMeta | None)

• battery_type (BatteryType | None)

• battery_id (str | None)

• thermo_type (str | None)

• battery_formula (str | None)

• working_ion (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)

• num_steps (int | None)

• max_voltage_step (float | None)

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

• framework (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)

• framework_formula (str | 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)

• chemsys (str | None)

• formula_anonymous (str | None)

• warnings (list[str])

• formula_charge (str | None)

• formula_discharge (str | None)

• max_delta_volume (float | None)

• average_voltage (float | None)

• capacity_grav (float | None)

• capacity_vol (float | None)

• energy_grav (float | None)

• energy_vol (float | None)

• fracA_charge (float | None)

• fracA_discharge (float | None)

• reaction (Annotated[BalancedReactionTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.balanced_reaction_adapter.<lambda>, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.balanced_reaction_adapter.<lambda>, return_type=~emmet.core.types.pymatgen_types.balanced_reaction_adapter.TypedBalancedReactionDict, when_used=always)] | None)

• initial_comp_formula (str | None)

• adj_pairs (list[ConversionVoltagePairDoc] | None)

• electrode_object (Annotated[ConversionElectrodeTypeVar, BeforeValidator(func=~emmet.core.types.pymatgen_types.electrode_adapter.electrode_object_deserializer, json_schema_input_type=PydanticUndefined), WrapSerializer(func=~emmet.core.types.pymatgen_types.electrode_adapter.electrode_object_serializer, return_type=dict[str, Any], when_used=always)] | None)

static get_conversion_elec_doc(ce)

Return type:

dict

Parameters:

ce (ConversionElectrode)

Gets a summary doc for a ConversionElectrode object. Args:

ie (pymatgen ConversionElectrode): electrode_object

Returns:

summary doc

model_config: ClassVar[ConfigDict] = {}

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