idstools.view.core_profiles

Module Contents

class idstools.view.core_profiles.CoreProfilesView(ids)[source]
core_profiles_compute
ids
plot_density_profile(ax, time_slice, psi_cordinate=False, update=True, logscale=False)[source]

This function plots the electron density profile as a function of either the normalized toroidal flux coordinate or the poloidal magnetic flux coordinate.

Parameters:
ax

ax is a matplotlib axis object where the density profile plot will be drawn.

time_slice

The time index refers to the specific time step or snapshot of data that is being plotted. It is used to retrieve the electron density and other relevant data at that particular time.

psi_cordinate=False

A boolean parameter that determines whether the density profile should be plotted as a function of the poloidal flux coordinate (-psi) or the normalised toroidal flux coordinate (rho_tor). If psi_cordinate is True, the density profile will be plotted as a function of -psi. Defaults to False

update=True

The update parameter is a boolean flag that determines whether the plot should be updated or created from scratch. If update is True, the function will create a new plot with the given data. If update is False, the function will update an existing plot with the new. Defaults to True

logscale=False

log scale

Returns:

a tuple containing the matplotlib plot object for the electron density profile (ax_density_plot_dens) and the maximum electron density value (nmax).

plot_diamagnetic_velocity_profile(ax, time_slice, **kwargs)[source]
plot_efield_profile(ax, time_slice, **kwargs)[source]
plot_electron_density_ne0(ax)[source]

This function plots the electron density (ne0) as a function of time.

Parameters:
ax

The parameter “ax” is a matplotlib axis object, which is used to plot the electron density data.

plot_electron_pressure_properties(ax, time_slice, **kwargs)[source]
plot_ion_pressure_properties(ax, time_slice, **kwargs)[source]
plot_poloidal_velocity_profile(ax, time_slice, **kwargs)[source]
plot_toroidal_velocity_profile(ax, time_slice, **kwargs)[source]
plot_total_pressure_properties(ax, time_slice, **kwargs)[source]
show_info_on_plot(ax, info: str = '', location='right')[source]
view_current_density_profiles(ax, time_slice, **kwargs)[source]

The function view_current_density_profiles plots various current density profiles on a given axis.

Parameters:
ax

The parameter “ax” is an instance of the matplotlib Axes class. It represents the axes on which the plot will be drawn.

static view_plasma_composition_with_species_concentration(ids_object, time_slice, print_data=False, volume=None)[source]

Nice display of plasma composition with species concentrations

view_q_profile_and_magnetic_shear_profile(ax, time_slice, **kwargs)[source]

The function view_q_profile_and_magnetic_shear_profile plots the q-profile and magnetic shear profile using the given axis.

Parameters:
ax

The parameter “ax” is an instance of the matplotlib Axes class. It represents the axes on which the plot will be drawn.

idstools.view.core_profiles.logger