Use pyproject.toml for everything and update test resources problem

bim2sim/examples/e1_template_plugin.py

@@ -12,7 +12,7 @@
 
 
 def run_simple_project():
-    """Run the building simulation with teaser as backend in interactive mode.
+    """Run a bim2sim project with the TemplatePlugin.
 
     This example will show how to set up a project based on an IFC file,
     how to create bim2sim elements based on the existing IFC data with all
@@ -30,7 +30,7 @@ def run_simple_project():
 
     # Download additional test resources for arch domain, you might want to set
     # force_new to True to update your test resources
-    download_test_resources(IFCDomain.arch, force_new=True)
+    # download_test_resources(IFCDomain.arch, force_new=True)
 
     # Set the ifc path to use and define which domain the IFC belongs to.
     # This is done via a dictionary, where the key is the domain and the value
@@ -77,19 +77,6 @@ def run_simple_project():
             Path(bim2sim.__file__).parent.parent /
             'test/resources/weather_files/DEU_NW_Aachen.105010_TMYx.mos')
 
-    # Assign relevant elements
-    # TODO this is currently not true, as we need to use TEASERTemplate,
-    #  we need to solve #511 and #583 first
-    # The template plugin uses the BaseSimSettings which don't have any
-    # relevant elements defined. This means without overwriting the
-    # `relevant_elements` setting, no bim2sim elements will be created.
-    # Let's assign all `bps_elements` and the `Material` element. This way
-    # the IFC will be searched for all IFC entities that should be mapped into
-    # the classes defined in `bps_elements` and in the class `Material`.
-    # For further information about the elements structure and the mapping
-    # procedure please read the `elements` documentation
-    project.sim_settings.relevant_elements = {*bps_elements.items, Material}
-
     # Assign the enrichment for use conditions of thermal zones.
 
     # bim2sim allows to enrich the use conditions, e.g. how many persons are

bim2sim/plugins/PluginComfort/bim2sim_comfort/examples/e1_simple_project_comfort_energyplus.py

@@ -44,7 +44,7 @@ def run_example_1():
             'test/resources/weather_files/DEU_NW_Aachen.105010_TMYx.epw')
 
     # specified settings for workflows can be changed later as well
-    project.sim_settings.ep_install_path = 'C://EnergyPlusV9-4-0/'
+    # project.sim_settings.ep_install_path = 'C://EnergyPlusV9-4-0/'
     project.sim_settings.layers_and_materials = LOD.low
     project.sim_settings.construction_class_walls = 'heavy'
     project.sim_settings.construction_class_windows = \

bim2sim/plugins/PluginEnergyPlus/bim2sim_energyplus/examples/e2_complex_project_bps_energyplus.py

@@ -2,12 +2,11 @@
 from pathlib import Path
 
 import bim2sim
-from bim2sim import Project, ConsoleDecisionHandler
+from bim2sim import Project
 from bim2sim.kernel.decision.decisionhandler import DebugDecisionHandler
 from bim2sim.kernel.log import default_logging_setup
-from bim2sim.utilities.types import IFCDomain, LOD, ZoningCriteria
-from bim2sim.utilities.common_functions import download_test_resources, \
-    download_library
+from bim2sim.utilities.types import IFCDomain, LOD
+from bim2sim.utilities.common_functions import download_test_resources
 
 
 def run_example_complex_building_teaser():
@@ -43,7 +42,7 @@ def run_example_complex_building_teaser():
 
     # Set the install path to your EnergyPlus installation according to your
     # system requirements
-    project.sim_settings.ep_install_path = 'C://EnergyPlusV9-4-0/'
+    # project.sim_settings.ep_install_path = 'C://EnergyPlusV9-4-0/'
 
     # combine spaces to thermal zones based on their usage
     # use cooling

bim2sim/plugins/PluginTEASER/bim2sim_teaser/examples/e2_complex_project_teaser.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 
 import bim2sim
-from bim2sim import Project, ConsoleDecisionHandler
+from bim2sim import Project
 from bim2sim.kernel.decision.decisionhandler import DebugDecisionHandler
 from bim2sim.kernel.log import default_logging_setup
 from bim2sim.utilities.types import IFCDomain, LOD, ZoningCriteria
@@ -97,22 +97,16 @@ def run_example_complex_building_teaser():
     # create plots based on the results after simulation
     project.sim_settings.create_plots = True
 
-    # Run the project with pre configured answers for decisions
+    # Run the project with pre-configured answers for decisions
     space_boundary_genenerator = 'Other'
     handle_proxies = (*(None,) * 12,)
     construction_year = 2015
     answers = (space_boundary_genenerator,
                *handle_proxies,
                construction_year)
-    # handler = ConsoleDecisionHandler()
     handler = DebugDecisionHandler(answers)
     handler.handle(project.run())
 
-    # Have a look at the elements/elements that were created
-    elements = project.playground.state['elements']
-    # filter the elements only for outer walls
-    df_finals = project.playground.state['df_finals']
-
 
 if __name__ == '__main__':
     run_example_complex_building_teaser()

bim2sim/plugins/PluginTemplate/bim2sim_template/__init__.py

@@ -4,15 +4,12 @@
 """
 from bim2sim.plugins import Plugin
 from bim2sim.tasks import common, bps
-from bim2sim.plugins.PluginTEASER.bim2sim_teaser.sim_settings import \
-    TEASERSimSettings
+from bim2sim.sim_settings import BuildingSimSettings
 
 
 class PluginTemplate(Plugin):
     name = 'Template'
-    # TODO BuildingSimSetting don't work due to issues with #511 and #583
-    sim_settings = TEASERSimSettings
-    # sim_settings = BuildingSimSettings
+    sim_settings = BuildingSimSettings
     default_tasks = [
         common.LoadIFC,
         common.CheckIfc,

docs/requirements.txt

@@ -1,4 +1,4 @@
-sphinx
+sphinx<=8.0.2
 sphinx-rtd-theme
 livereload
 myst-parser

docs/source/user-guide/PluginTemplate.md

@@ -42,15 +42,14 @@ micromamba activate bim2sim
 
 # clone bim2sim repository (you can also use SSH if you prefer)
 # the option "--recurse-submodules" is needed to load submodules 
-git clone --recurse-submodules https://github.com/BIM2SIM/bim2sim.git
-# change into bim2sim folder
-cd bim2sim
-# use of development branch is recommended, as main branch is currently not updated regulary
-git checkout development
+git clone -b development https://github.com/BIM2SIM/bim2sim.git
 
 # install conda-forge packages (OCC not available via PyPi)
 micromamba install -c conda-forge pythonocc-core=7.7.0
 
+# change into bim2sim folder
+cd bim2sim
+
 # install pip requirements
 pip install -e '.'
 

pyproject.toml

@@ -23,17 +23,18 @@ authors = [
 ]
 description = "bim2sim is a framework to create simulation models for different purposes based on BIM models in IFC format."
 readme = "README.md"
-requires-python = ">=3.10, <=3.10.14"
+requires-python = ">=3.10, <=3.11.10"
 classifiers = [
     "Development Status :: XXX", # see https://en.wikipedia.org/wiki/Software_release_life_cycle
     "License :: XXX",
     "Natural Language :: English",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
 ]
 dependencies = [
-    "ifcopenshell>=0.7.0",
+    "ifcopenshell==0.7.0.240627",
     "docopt==0.6.2",
     "numpy==1.26.0",
     "pandas==2.1.3",
@@ -47,6 +48,9 @@ dependencies = [
     "rwthcolors==0.2.4",
     "SciencePlots==2.1.0",
     "pillow==10.1.0",
+    "gitpython==3.1.40",
+    "svglib==1.5.1",
+    "reportlab==4.2.2",
     "scipy==1.11.3", # is a dependency from networkx, should installed automatically
 ]
 
@@ -63,24 +67,24 @@ PluginTEASER = [
     "RWTHColors",
     "scienceplots",
     "ebcpy",
-    "TEASER@git+https://github.com/RWTH-EBC/TEASER#egg=development",
+    "TEASER@git+https://github.com/RWTH-EBC/TEASER@development#egg=TEASER[report]",
     "BuildingsPy@git+https://github.com/DaJansenGit/BuildingsPy.git",
 ]
 PluginEnergyPlus = [
     "shapely",
     "numpy-stl",
     "energyplus-regressions",
     "eppy@git+https://github.com/BIM2SIM/eppy",
-    "geomeppy@git+https://github.com/BIM2SIM/geomeppy#egg=fix_dependencies",
+    "geomeppy@git+https://github.com/BIM2SIM/geomeppy@fix_dependencies#egg=geomeppy",
     "OCCUtils@git+https://github.com/tpaviot/pythonocc-utils",  # from base requiremts.txt
 ]
 PluginAixLib = [
-    "pyvis@git+https://github.com/squidKid-deluxe/pyvis.git#egg=fix-show",
+    "pyvis@git+https://github.com/squidKid-deluxe/pyvis@fix-show#egg=pyvis",
 ]
 PluginCFD = [ # prepared to add dependencies, same installtion routine like other plugins
 ]
 PluginHKESim = [
-    "pyvis@git+https://github.com/squidKid-deluxe/pyvis.git#egg=fix-show",
+    "pyvis@git+https://github.com/squidKid-deluxe/pyvis@fix-show#egg=pyvis",
 ]
 PluginLCA = [ # prepared to add dependencies, same installtion routine like other plugins
 ]