fairyfly_therm.cli.simulate module

Fairyfly therm simulation running commands.

fairyfly_therm.cli.simulate.simulate_model(model_file, folder=None, log_file=None)[source]

Simulate a Fairyfly Model in THERM.

Parameters:

  • model_file – Full path to a Fairyfly Model file (FFJSON or FFpkl).

  • computer (Folder on this) – be written. If None, the files will be output to the fairyfly default simulation folder and placed in a project folder with the same name as the model-file.

  • will (into which the THMZ and simulation files) – be written. If None, the files will be output to the fairyfly default simulation folder and placed in a project folder with the same name as the model-file.

  • output_file – Optional THMZ file path to output the THMZ string of the translation. If None, the string will be returned from this function.