API reference

This page provides an auto-generated summary of IMAS-Python’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

IMAS-Python public API

convert_core_edge_plasma.convert_to_plasma_profiles(...)

Convert a core_profiles or edge_profiles IDS to a plasma_profiles IDS.

convert_core_edge_plasma.convert_to_plasma_sources(...)

Convert a core_sources or edge_sources IDS to a plasma_sources IDS.

convert_core_edge_plasma.convert_to_plasma_transport(...)

Convert a core_transport or edge_transport IDS to a plasma_transport IDS.

db_entry.DBEntry()

Represents an IMAS database entry, which is a collection of stored IDSs.

ids_convert.convert_ids(toplevel, version, *)

Convert an IDS to the specified data dictionary version.

ids_data_type.IDSDataType(value[, names, ...])

Enum representing the possible data types in an IDS

ids_factory.IDSFactory([version, xml_path])

Factory class generating IDSToplevel elements for specific DD versions.

ids_identifiers.identifiers

Object to list and get identifiers.

ids_metadata.IDSMetadata(structure_xml, ...)

Container for IDS Metadata stored in the Data Dictionary.

ids_metadata.IDSType(value[, names, module, ...])

Data dictionary indication of the time-variation character of a DD node

ids_primitive.IDSPrimitive(parent, metadata)

IDS leaf node

ids_struct_array.IDSStructArray(parent, metadata)

IDS array of structures (AoS) node

ids_structure.IDSStructure(parent, metadata)

IDS structure node

ids_toplevel.IDSToplevel(parent, structure_xml)

This is any IDS Structure which has ids_properties as child node
Last update: 2026-01-28