idstools.compute.distribution_sources¶

This module provides compute functions and classes for distribution_sources ids data

Module Contents¶

class idstools.compute.distribution_sources.DistributionSourcesCompute(ids)[source]¶

This class provides compute functions for distribution sources ids.

ids¶

The distribution sources IDS (Integrated Data Structure) object containing source/sink data and parameters relevant to fast particle and energetic ion distributions such as neutral beams or fusion products.

Type:¶

object

ids¶

get_rho_tor_norm(time_slice: int, source_index=0) → None | numpy.ndarray[source]¶

The function get_rho_tor_norm returns the normalized toroidal rho values from a given time slice of a source.

Parameters:¶

time_slice: int¶

The parameter “time_slice” is an integer that represents the time slice for which you want to retrieve the value of “rho_tor_norm”.

Returns:¶

the variable rho_tor_norm.

get_source_info(time_slice, process_index=0)[source]¶

The function get_source_info retrieves information about sources, including labels, particle data, and power, and returns it in a dictionary format.

Returns:¶

a dictionary called sources_dict.

get_volume(time_slice: int, source_index=0) → None | numpy.ndarray[source]¶

The function get_volume retrieves the volume from a specific time slice of a source’s profiles.

Parameters:¶

time_slice: int¶

The parameter “time_slice” is an optional integer that specifies the index of the time slice for which you want to retrieve the volume.

Returns:¶

the volume of a grid at a given time slice. The volume is obtained from the distribution_sources.source[time_slice].profiles_1d[0].grid.volume attribute.If the volume cannot be read , the function returns None.

idstools.compute.distribution_sources.logger¶