roxieapi.output.parser module

class roxieapi.output.parser.OptData(id: int, name: str)

Bases: object

Data Of an optimization Step

class roxieapi.output.parser.RoxieOutputParser(xml_file: str)

Bases: object

Roxie output parser class.

Takes all different Roxie outputs, parses them, and provides a structured output of the results.

find_optstep(opt_step) → OptData | None

find_transstep(opt_step: int, trans_step: int) → TransStepData | None

get_3d_plot(plot_nr: int = 1) → Plot3D | None

Return the 3D plot with number i :param plon_nr: The plot number, defaults to 1 :return: The Plot3D definition, or None

get_conductor_forces(opt_step: int = 1, trans_step: int = 1) → DataFrame | None

Return Conductor forces for given Step, or None if not present

Parameters:

• opt_step – The Optimization step, defaults to 1

• trans_step – Transient step, defaults to 1

Returns:

The Conductor forces as Dataframe

get_crosssection_plot(plot_nr: int = 1) → Plot2D | None

Return the Crossection 2D plot with number i

Parameters:

plot_nr – The plot_number, defaults to 1

Returns:

The Plot2D object, or None

get_harmonic_coil(coil_nr: int = 1, opt_step: int = 1, trans_step: int = 1) → HarmonicCoil | None

Return the harmonic coil for given step and coil id, or None if not present

Parameters:

• coil_nr – Harmonic Coil Nr, defaults to 1

• opt_step – The Optimization Step Nr, defaults to 1

• trans_step – The Transient Step Nr, defaults to 1

Returns:

The Harmonic coil, or None

class roxieapi.output.parser.TransStepData(id: int, name: str)

Bases: object

Data of a transient step