fairyfly_therm.run module

Module for running files through THERM CLI.

fairyfly_therm.run.run_model(model, directory=None, silent=False, simulation_par=None)[source]

Run a fairyfly Model through THERM CLI.

Parameters:

  • model – Path to a THMZ file to be run using THERM CLI.

  • directory – The directory in which the simulation files will be written. If None, this will default to the fairyfly-core default_simulation_folder.

  • silent – Boolean to note whether the THERM simulation should be run silently.

  • simulation_par – A fairyfly-therm SimulationParameter object to specify how the THERM simulation should be run. If None, default simulation parameters will be generated. (Default: None).

Returns:

The path to the input thmz_file with results inside of it.

fairyfly_therm.run.run_thmz(thmz_file, silent=False)[source]

Run a .thmz file using the THERM CLI.

Parameters:

  • thmz_file – Path to a THMZ file to be run using THERM CLI.

  • silent – Boolean to note whether the THERM simulation should be run silently.

Returns:

The path to the input thmz_file with results inside of it.