idstools.cocos¶

Module Contents¶

class idstools.cocos.COCOS(index=None, values=None)[source]¶

COCOS module in Python.

This module provides functionality related to coordinate conventions in tokamak physics.

References

O. Sauter and S. Yu. Medvedev, “Tokamak Coordinate Conventions: COCOS”,Comput. Physics Commun 84 (2013), 293. cocos_module.f90 (CHEASE).

Initialize COCOS index using values, or values using COCOS index.

Parameters:¶

index=None¶

COCOS index dictionary with signs of Ip and B0. Example: {"COCOS": 11, "ipsign": 1, "b0sign": 1}

values=None¶

COCOS values dictionary with coordinate convention parameters.

get()[source]¶

Return COCOS index and values

Returns:¶

COCOS index and values in type dict

Return type:¶

dict

classmethod values_coefficients(COCOS_in, COCOS_out, ip_in, b0_in, ipsign_out, b0sign_out)[source]¶

Provide transformation values for a set of quantities for a given pair of input/output COCOS numbers.

Parameters:¶

COCOS_in¶

COCOS input

COCOS_out¶

COCOS output

ip_in¶

Plasma current (toroidal component) [A]

b0_in¶

Vacuum toroidal field [T]

ipsign_out¶

Desired sign of Ip in output

b0sign_out¶

Desired sign of B0 in output

Returns:¶

COCOS transformation values in type dict

Return type:¶

dict

idstools.cocos.compute_COCOS(ids, itime=None, i1=0)[source]¶

Compute COCOS values using experimental data in IDS/equilibrium.

Parameters:¶

ids¶

IDS/equilibrium for COCOS estimation

itime=None¶

Index of struct_array time_slice in IDS/equilibrium

i1=0¶

Index of struct_array profiles_2d in IDS/equilibrium. Default is 0.

Returns:¶

Dictionary with COCOS values

Return type:¶

dict

idstools.cocos.ids_compute_cocos(ids, itime=None, i1=0)[source]¶

Function Interface for computing COCOS.

Parameters:¶

ids¶

IDS for cocos estimation

itime=None¶

Index of struct_array time_slice in IDS/equilibrium

i1=0¶

Index of struct_array profiles_2d in IDS/equilibrium. Default is 0.

Returns:¶

COCOS number computed

Return type:¶

int

idstools.cocos.IDS_COCOS¶

idstools.cocos.logger¶