pyrokinetics.databases.imas.pyro_to_ids

Contents

pyrokinetics.databases.imas.pyro_to_ids#

pyrokinetics.databases.imas.pyro_to_ids(pyro, comment=None, time_interval=None, format='hdf5', file_name=None, reference_values={})[source]#

Return a Gyrokinetics IDS structure from idspy_toolkit GKDB/IMAS/OMAS gyrokinetics schema as described in:

gkdb/gkdb/raw/master/doc/general/IOGKDB.pdf

Requires species and geometry data to already exist :type pyro: :param pyro: pyro object with data loaded :type pyro: Pyro :type comment: :param comment: String describing run :type comment: str :param name: Name for IDS :type name: str :type time_interval: :param time_interval: Final fraction of data over which to average fluxes (ignored if linear) :type time_interval: Float :type format: :param format: File format to save IDS in (currently hdf5 support) :type format: str :type file_name: :param file_name: Filename to save ids under :type file_name: str :type reference_values: :param reference_values: If normalised quantities aren’t defined, can be set via dictionary here :type reference_values: dict

Returns:

ids – Populated IDS

Return type:

Gyrokinetics IDS