honeybee.config module

Honeybee configurations.

Import this into every module where access configurations are needed.

Usage:

from honeybee.config import folders
print(folders.python_exe_path)
print(folders.default_simulation_folder)
folders.default_simulation_folder = "C:/my_sim_folder"
class honeybee.config.Folders(config_file=None, mute=True)[source]

Bases: object

Honeybee 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:

  • default_simulation_folder

  • honeybee_core_version

  • honeybee_core_version_str

  • honeybee_schema_version

  • honeybee_schema_version_str

  • python_package_path

  • python_scripts_path

  • python_exe_path

  • python_version

  • python_version_str

  • default_standards_folder

  • config_file

  • mute

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 default_simulation_folder

Get or set the path to the default simulation folder.

property default_standards_folder

Get or set the path to the default standards library used by extensions.

property honeybee_core_version

Get a tuple for the installed version of honeybee-core (eg. (1, 47, 26)).

This will be None if the version could not be sensed (it was not installed via pip).

property honeybee_core_version_str

Get a string for the installed version of honeybee-core (eg. “1.47.26”).

This will be None if the version could not be sensed.

property honeybee_schema_version

Get a tuple for the installed version of honeybee-schema (eg. (1, 35, 0)).

This will be None if the version could not be sensed (it was not installed via pip) or if no honeybee-schema installation was found next to the honeybee-core installation.

property honeybee_schema_version_str

Get a string for the installed version of honeybee-schema (eg. “1.35.0”).

This will be None if the version could not be sensed.

property python_exe_path

Get the path to the Python executable to be used for Ladybug Tools CLI calls.

If a version of Python is found within the ladybug_tools installation folder, this will be the path to that version of Python. Otherwise, it will be assumed that this is package is installed in cPython outside of the ladybug_tools folder and the sys.executable will be returned.

property python_package_path

Get the path to where this Python package is installed.

property python_scripts_path

Get the path to where Python CLI executable files are installed.

This can be used to call command line interface (CLI) executable files directly (instead of using their usual entry points).

property python_version

Get a tuple for the version of python (eg. (3, 8, 2)).

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

property python_version_str

Get text for the full version of python (eg.”3.8.2”).

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