bim2sim package

bim2sim library

bim2sim.run_project(project: Project, handler: DecisionHandler)

Run project using decision handler.

Subpackages

Submodules

bim2sim.project module

Project handling

class bim2sim.project.FolderStructure(path=None)

Bases: object

Project related file and folder handling.

CONFIG = 'config.toml'
DECISIONS = 'decisions.json'
EXPORT = 'export'
FINDER = 'finder'
IFC_BASE = 'ifc'
LOG = 'log'
property assets
property b2sroot

absolute path of bim2sim root folder

complete_project_folder()

Adds missing sub folders to given path

property config

absolute path to config

copy_assets(path)

copy assets to project folder

classmethod create(rootpath: str, ifc_paths: Dict = None, plugin: str | Type[Plugin] = None, open_conf: bool = False)

Create ProjectFolder and set it up.

Create instance, set source path, create project folder copy ifc, base config setup and open config if needed.

Args:

rootpath: path of root folder ifc_paths: dict with key: bim2sim domain and value: path

to corresponding ifc which gets copied into project folder

plugin: the target Plugin open_conf: flag to open the config file in default application

create_project_folder()

Creates a project folder on given path

property decisions

absolute path to decisions

delete(confirm=True)

Delete project folder and all files in it.

Raises:

AssertionError: if not existing on file system

property enrichment
property export

absolute path to export folder

property finder

absolute path to finder

property ifc_base

absolute path to ifc folder

is_project_folder(path=None)

Check if root path (or given path) is a project folder

property log

absolute path to log folder

property root

absolute root path

property sub_dirs

list of paths to sub folders

class bim2sim.project.Project(path: str = None, plugin: Type[Plugin] = None)

Bases: object

Project resource handling.

Args:

path: path to load project from plugin: Plugin to use. This overwrites plugin from config.

Raises:

AssertionError: on invalid path. E.g. if not existing

property config

returns configparser instance. Basic config is done if file is not present

classmethod create(project_folder, ifc_paths: Dict = None, plugin: str | Type[Plugin] = None, open_conf: bool = False)

Create new project

Args:

project_folder: directory of project ifc_paths: dict with key: IFCDomain and value: path

to corresponding ifc which gets copied into project folder

plugin: Plugin to use with this project. If passed as string,

make sure it is importable (see plugins.load_plugin)

open_conf: flag to open the config file in default application updated from config

delete()

Delete the project.

finalize(success=False)

cleanup method

is_active() → bool

Return True if current project is active, False otherwise.

static is_project_folder(path: str) → bool
reset()

Reset the current project.

rewrite_config()
run(interactive=False, cleanup=True)

Run project.

Args:
interactive: if True the Task execution order is determined by

Decisions else its derived by plugin

cleanup: execute cleanup logic. Not doing this is only relevant for

debugging

Raises:

AssertionError: if project setup is broken or on invalid Decisions

bim2sim.project.add_config_section(config: ConfigParser, sim_settings: BaseSimSettings, name: str) → ConfigParser

Add a section to config with all attributes and default values.

bim2sim.project.config_base_setup(path, backend=None)

Initial setup for config file

bim2sim.project.open_config(path)

Open config for user and wait for closing before continue.

bim2sim.sim_settings module

Module for defining simulation model specific process settings. This targets both, settings to set for the later simulation and settings for the model generation process in bim2sim.

class bim2sim.sim_settings.AutoSettingNameMeta(name, bases, namespace)

Bases: type

Sets the name to every SimulationSetting attribute based on its instance name.

class bim2sim.sim_settings.BaseSimSettings(filters: list = None)

Bases: object

Specification of basic bim2sim simulation settings which are common for all simulations

add_space_boundaries
building_rotation_overwrite
check_mandatory()

Check if mandatory settings have a value.

close_space_boundary_gaps
correct_space_boundaries
create_external_elements
dymola_simulation
fuzzy_threshold
group_unidentified
group_unidentified_
load_default_settings()

loads default values for all settings

max_wall_thickness
reset_guids
stories_to_load_guids
update_from_config(config)

Updates the simulation settings specification from the config file

weather_file_path
class bim2sim.sim_settings.BooleanSetting(*, name: str = 'set automatically', description: str | None = None, for_frontend: bool = False, any_string: bool = False, mandatory: bool = False, value: bool | None)

Bases: Setting

model_config: ClassVar[ConfigDict] = {'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

value: bool | None
class bim2sim.sim_settings.BuildingSimSettings

Bases: BaseSimSettings

add_shadings
add_space_boundaries
ahu_cooling_overwrite
ahu_dehumidification_overwrite
ahu_heat_recovery_efficiency_overwrite
ahu_heat_recovery_overwrite
ahu_heating_overwrite
ahu_humidification_overwrite
ahu_tz_overwrite
base_infiltration_rate_overwrite
close_space_boundary_gaps
construction_class_doors
construction_class_walls
construction_class_windows
cooling_tz_overwrite
correct_space_boundaries
create_plots
heating_tz_overwrite
layers_and_materials
plot_singe_zone_guid
prj_custom_usages
prj_use_conditions
run_period_end_day
run_period_end_month
run_period_start_day
run_period_start_month
set_run_period
setpoints_from_template
sim_results
split_bounds
split_shadings
use_constant_infiltration_overwrite
use_maintained_illuminance
year_of_construction_overwrite
class bim2sim.sim_settings.ChoiceSetting(*, name: str = 'set automatically', description: str | None = None, for_frontend: bool = False, any_string: bool = False, mandatory: bool = False, value: str | List[str] | Enum | None, choices: dict, multiple_choice: bool = False)

Bases: Setting

check_content()
classmethod check_setting_config(choices)
choices: dict
model_config: ClassVar[ConfigDict] = {'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

multiple_choice: bool
value: str | List[str] | Enum | None
class bim2sim.sim_settings.GuidListSetting(*, name: str = 'set automatically', description: str | None = None, for_frontend: bool = False, any_string: bool = False, mandatory: bool = False, value: List[str] | None = None)

Bases: Setting

classmethod check_value(value)
model_config: ClassVar[ConfigDict] = {'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

value: List[str] | None
class bim2sim.sim_settings.NumberSetting(*, name: str = 'set automatically', description: str | None = None, for_frontend: bool = False, any_string: bool = False, mandatory: bool = False, value: float | int | None, min_value: float | int | None = None, max_value: float | int | None = None)

Bases: Setting

check_limits() → Self
check_setting_config() → Self
max_value: float | int | None
min_value: float | int | None
model_config: ClassVar[ConfigDict] = {'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

value: float | int | None
class bim2sim.sim_settings.PathSetting(*, name: str = 'set automatically', description: str | None = None, for_frontend: bool = False, any_string: bool = False, mandatory: bool = False, value: Path | Path | None)

Bases: Setting

model_config: ClassVar[ConfigDict] = {'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

value: Path | Path | None
class bim2sim.sim_settings.PlantSimSettings

Bases: BaseSimSettings

aggregations
tolerance_connect_by_position
verify_connection_by_position
class bim2sim.sim_settings.Setting(*, name: str = 'set automatically', description: str | None = None, for_frontend: bool = False, any_string: bool = False, mandatory: bool = False)

Bases: BaseModel

Base class for all simulation settings.

The attribute “value”, which contains the payload of the simulation setting, is added in the derived classes for the different data types (e.g. NumberSetting(Setting)).

The value, which is assigned to the attribute “value”, when instancing the setting, serves as a default value and can be changed according to the use case, if necessary.

Args:

name: Name of the setting. Is set automatically by AutoSettingNameMeta(type) description: description the setting for_frontend: should this setting be shown in the frontend any_string: any string is allowed instead of a given choice mandatory: whether a setting needs to be set

any_string: bool
description: str | None
for_frontend: bool
mandatory: bool
model_config: ClassVar[ConfigDict] = {'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
class bim2sim.sim_settings.SettingsManager(bound_simulation_settings)

Bases: dict

Manages the different settings of a SimulationSettings instance.

The manager is needed to maintain the different attributes of a simulation (e.g. choices) while making the read and write access to the setting still easy. This way you can call sim_settings.<setting_name> and get the value directly while under sim_settings.manager.<setting_name> you can still find all information.

Args:

bound_simulation_settings: instance of sim_settings this manager is bound to. E.g. BuildingSimSettings.

defaults = {}
property names

Returns a generator object with all settings that the bound_simulation_settings owns.