bim2sim.plugins package

BIM2SIM Plugins

class bim2sim.plugins.Plugin

Bases: object

Base class for bim2sim Plugins.

Notes:

This class is used as a namespace. Instantiation is not necessary.

Attributes:

name: Name of the Plugin sim_settings: simulation settings to use in Projects using this Plugin tasks: Set of tasks made available by this Plugin default_tasks: List of tasks, which should be executed elements: Additional Elements made available by this Plugin

default_tasks: List[Type[ITask]] = []
elements: set = {}
name: str = None
sim_settings: Type[BaseSimSettings] = None
tasks: Set[Type[ITask]] = {}
class bim2sim.plugins.PluginBPSBase

Bases: Plugin

default_tasks: List[Type[ITask]] = [<class 'bim2sim.tasks.common.load_ifc.LoadIFC'>, <class 'bim2sim.tasks.common.check_ifc.CheckIfc'>, <module 'bim2sim.tasks.common.create_elements' from '/builds/EBC/EBC_all/github_ci/bim2sim/bim2sim/tasks/common/create_elements.py'>, <class 'bim2sim.tasks.bps.sb_creation.CreateSpaceBoundaries'>, <class 'bim2sim.tasks.bps.disaggr_creation.DisaggregationCreationAndTypeCheck'>, <class 'bim2sim.tasks.bps.combine_tz.CombineThermalZones'>]
name: str = 'BPSBase'
sim_settings

alias of BuildingSimSettings

bim2sim.plugins.add_plugins_to_path(root: Path)

Add all directories under root to path.

bim2sim.plugins.available_plugins() → List[str]

List all available plugins.

bim2sim.plugins.get_plugin(module) → Type[Plugin]

Get Plugin class from module.

bim2sim.plugins.load_plugin(name: str) → Type[Plugin]

Load Plugin from module.

Args:

name: name of plugin module. Prefix ‘bim2sim_’ may be omitted.

Subpackages