thunderboltz.ThunderBoltz.run

ThunderBoltz.run(src_path=None, bin_path=None, out_file='thunderboltz', monitor=False, dryrun=False, debug=False, std_banner=False, live=False, live_rate=False)[source]
Execute with the current parameters in the simulation directory.

The internal API ThunderBoltz version will be used in lieu of user-provided binary/source files.

Parameters:

  • src_path (str) – Optional path to source files to copy into the simulation directory. The source is then compiled there.

  • bin_path (str) – Optional path to binary executable to copy into the simulation directory.

  • out_file (str) – The file name for stdout buffer of the ThunderBoltz process.

  • monitor (bool) – Runtime flag, when set to True will generate an empty monitor file in the simulation directory. Deleting this file will cause the ThunderBoltz process to exit, but allow the wrapper to continue execution. This is useful performing several simulation calculations sequentially, but a manual exit is required for each one.

  • dryrun (bool) – Setup all the files for the calculation, but do not run the calculation.

  • debug – (bool): Compile with C++ -g debug flag.

  • std_banner (bool) – Toggle banner output streaming to stdout in addition to being written to the out_file buffer.

  • live (bool) – Run and update time series plotting GUI during simulation.

  • live_rate (bool) – Run and update rate plotting GUI during simulation.

Raises:

RuntimeError – if there is no simulation directory set or if the one provided does not exist.