idstools.compute.summary

This module provides compute functions and classes for summary ids data

more about summary ids.

Module Contents

class idstools.compute.summary.SummaryCompute(ids)[source]

This class provides compute functions for summary ids.

ids

The summary IDS (Integrated Data Structure) object containing high-level summary data and indices providing quick access to important discharge parameters and data references.

Type:

object

Initialization SummaryCompute object.

Parameters:
ids

summary ids object

ids
get_h_mode_info()[source]

The function getHModeInfo checks if the h_mode values are present in the global_quantities and returns information about the presence of HMode, as well as the minimum and maximum time values where HMode is present.

Returns:

“HModePresent”, “th_min”, and “th_max”. The values associated with these keys are the boolean value indicating whether HMode is present, the minimum value of time when HMode is present, and the maximum value of time when HMode is present, respectively.

Return type:

a dictionary with three keys

get_summary()[source]

The function get_summary processes and retrieves various waveforms and power values, handling missing data and logging critical errors when necessary.

Returns:

The get_summary method returns a dictionary named waveform containing various waveforms and their values. The waveforms included in the dictionary are “time”, “ip”, “current_non_inductive”, “current_bootstrap”, “v_loop”, “beta_tor_norm”, “beta_pol”, “energy_diamagnetic”, “energy_mhd”, “current_ohm”, “energy_total

idstools.compute.summary.EMPTY_DOUBLE = '-9e+40'
idstools.compute.summary.logger