fairyfly_therm.config module

Fairyfly_therm configurations.

Import this into every module where access configurations are needed.

Usage:

from fairyfly_therm.config import folders
print(folders.lbnl_data_path)
folders.lbnl_data_path = "C:/Users/Person/LBNL"
class fairyfly_therm.config.Folders(config_file=None, mute=True)[source]

Bases: object

Fairyfly_therm folders.

Parameters:

  • config_file – The path to the config.json file from which folders are loaded. If None, the config.json module included in this package will be used. Default: None.

  • mute – If False, the paths to the various folders will be printed as they are found. If True, no printing will occur upon initialization of this class. Default: True.

Properties:

  • therm_path

  • therm_exe

  • therm_version

  • therm_version_str

  • lbnl_data_path

  • therm_settings_path

  • therm_lib_path

  • material_lib_file

  • gas_lib_file

  • bc_steady_state_lib_file

  • config_file

  • mute

THERM_VERSION = (8, 1, 30, 0)
property bc_steady_state_lib_file

Get the path to the modifierset library in the standards_data_folder.

property config_file

Get or set the path to the config.json file from which folders are loaded.

Setting this to None will result in using the config.json module included in this package.

property gas_lib_file

Get the path to the gas library file.

property lbnl_data_path

Get or set the path to the folder containing the LBNL data.

This folder typically exists under the User profile and contains sub-folders for all installed versions of LBNL THERM and WINDOW. The THERM sub-folder contains a lib sub-folder with XML files for all materials, boundary conditions, etc.

property material_lib_file

Get the path to the material library file.

property therm_exe

Get the path to Therm executable.

Will be none if no Therm installation was found.

property therm_lib_path

Get or set the path to the folder from which therm materials are loaded.

This will be the therm folder within within the user’s standards folder if it exists.

property therm_path

Get or set the path to Therm installation folder.

This is typically the folder within the lbnl program files directory that starts with THERM and contains executables and dlls.

property therm_settings_path

Get the path to the .ini file with THERM settings.

Will be None if no LBNL data folder was found.

property therm_version

Get a tuple for the version of therm (eg. (8, 1, 30)).

This will be None if the version could not be sensed or if no Therm installation was found.

property therm_version_str

Get text for the full version of therm (eg.”8.1.30”).

This will be None if the version could not be sensed or if no Therm installation was found.