Simulation GUI

class pymoskito.simulation_gui.SimulationGui

The graphical user interface of PyMoskito

apply_regime_by_name(regime_name)

Apply the regime given by regime_name und update the regime index.

Returns:

True if successful, False if errors occurred.

Return type:

bool

closeEvent(self, a0: QCloseEvent | None)

export_simulation_data(ok)

Query the user for a custom name and export the current simulation results.

Parameters:

ok – unused parameter from QAction.triggered() Signal

increment_playback_time()

go one time step forward in playback

load_regimes_from_file(file_name)

load simulation regime from file :param file_name:

new_simulation_data(status, data)

Slot to be called when the simulation interface has completed the current job and new data is available.

Parameters:

• status (str) – Status of the simulation, either - finished : Simulation has been finished successfully or - failed : Simulation has failed.

• data (dict) – Dictionary, holding the simulation data.

pause_animation()

pause the animation

plot_data_vector(item)

Creates a plot widget based on the given item.

If a plot for this item is already open no new plot is created but the existing one is raised up again.

Parameters:

item (Qt.ListItem) – Item to plot.

postprocessing_clicked()

starts the post- and metaprocessing application

regime_dclicked(item)

Apply the selected regime to the current target.

reset_camera_clicked()

reset camera in vtk window

run_next_regime()

Execute the next regime in the regime batch.

start_animation()

start the animation

start_regime_execution()

Simulate all regimes in the regime list.

start_simulation()

start the simulation and disable start button

stop_animation()

Stop the animation if it is running and reset the playback time.

stop_regime_execution()

Stop the batch process.

update_gui()

Updates the graphical user interface to reflect changes of the current display time.

This includes:

• timestamp

• visualisation window

• time cursors in diagrams

update_playback_time()

adjust playback time to slider value

pymoskito.simulation_gui.run(regimes=None, show=True, execute=False, exit_after=False)

Helper function to launch the PyMoskito GUI

Parameters:

• regimes (String) – Path to a regime file to load

• show (bool) – If true, show the GUI otherwise operate in headless mode

• execute (bool) – If true, simulate all loaded regimes

• exit_after (bool) – If true, exit after all regimes are simulated