bim2sim.tasks package

Package containing classes for high level tasks

Subpackages

• bim2sim.tasks.bps package
  • Submodules
  • bim2sim.tasks.bps.combine_tz module
    • CombineThermalZones
      • CombineThermalZones.combine_tzs_based_on_criteria()
      • CombineThermalZones.combine_tzs_to_one_zone()
      • CombineThermalZones.discard_1_element_groups()
      • CombineThermalZones.external_orientation_group()
      • CombineThermalZones.glass_percentage_group()
      • CombineThermalZones.group_by_external_orientation()
      • CombineThermalZones.group_by_glass_percentage()
      • CombineThermalZones.group_by_is_external()
      • CombineThermalZones.group_by_is_neighbor()
      • CombineThermalZones.group_by_usage()
      • CombineThermalZones.group_grouped_tz()
      • CombineThermalZones.group_not_grouped_tz()
      • CombineThermalZones.group_thermal_zones_by_is_external()
      • CombineThermalZones.group_thermal_zones_by_is_external_and_orientation()
      • CombineThermalZones.group_thermal_zones_by_is_external_orientation_and_usage()
      • CombineThermalZones.group_thermal_zones_by_usage()
      • CombineThermalZones.group_thermal_zones_by_use_all_criteria()
      • CombineThermalZones.reads
      • CombineThermalZones.run()
  • bim2sim.tasks.bps.disaggr_creation module
    • DisaggregationCreationAndTypeCheck
      • DisaggregationCreationAndTypeCheck.create_disaggregation_with_type_correction()
      • DisaggregationCreationAndTypeCheck.get_corrected_door_type()
      • DisaggregationCreationAndTypeCheck.get_corrected_slab_type()
      • DisaggregationCreationAndTypeCheck.get_corrected_wall_type()
      • DisaggregationCreationAndTypeCheck.reads
      • DisaggregationCreationAndTypeCheck.run()
      • DisaggregationCreationAndTypeCheck.type_correction_not_disaggregation()
  • bim2sim.tasks.bps.enrich_material module
    • EnrichMaterial
      • EnrichMaterial.create_layer_set_from_template()
      • EnrichMaterial.create_material_from_template()
      • EnrichMaterial.create_new_layer_sets_and_materials()
      • EnrichMaterial.enrich_element_data_from_template()
      • EnrichMaterial.get_material_templates()
      • EnrichMaterial.get_templates()
      • EnrichMaterial.get_templates_for_buildings()
      • EnrichMaterial.mapping_templates_bim2sim
      • EnrichMaterial.reads
      • EnrichMaterial.run()
  • bim2sim.tasks.bps.enrich_use_cond module
    • EnrichUseConditions
      • EnrichUseConditions.enrich_usages()
      • EnrichUseConditions.list_decision_usage()
      • EnrichUseConditions.load_usage()
      • EnrichUseConditions.office_usage()
      • EnrichUseConditions.reads
      • EnrichUseConditions.run()
      • EnrichUseConditions.set_heating_cooling()
      • EnrichUseConditions.value_processing()
  • bim2sim.tasks.bps.plot_results module
    • PlotBEPSResults
      • PlotBEPSResults.create_color_mapping()
      • PlotBEPSResults.final
      • PlotBEPSResults.get_color_for_value()
      • PlotBEPSResults.plot_dataframe()
      • PlotBEPSResults.plot_demands_bar()
      • PlotBEPSResults.plot_demands_time_series()
      • PlotBEPSResults.plot_floor_plan_with_results()
      • PlotBEPSResults.plot_multiple_temperatures()
      • PlotBEPSResults.plot_temperatures()
      • PlotBEPSResults.plot_thermal_discomfort()
      • PlotBEPSResults.plot_total_consumption()
      • PlotBEPSResults.reads
      • PlotBEPSResults.run()
      • PlotBEPSResults.save_or_show_plot()
  • bim2sim.tasks.bps.sb_2b_generation module
    • AddSpaceBoundaries2B
      • AddSpaceBoundaries2B.create_2b_space_boundaries()
      • AddSpaceBoundaries2B.reads
      • AddSpaceBoundaries2B.run()
      • AddSpaceBoundaries2B.touches
  • bim2sim.tasks.bps.sb_correction module
    • CorrectSpaceBoundaries
      • CorrectSpaceBoundaries.add_and_split_bounds_for_shadings()
      • CorrectSpaceBoundaries.create_copy_of_space_boundary()
      • CorrectSpaceBoundaries.create_new_convex_bounds()
      • CorrectSpaceBoundaries.fix_surface_orientation()
      • CorrectSpaceBoundaries.move_children_to_parents()
      • CorrectSpaceBoundaries.reads
      • CorrectSpaceBoundaries.run()
      • CorrectSpaceBoundaries.split_non_convex_bounds()
      • CorrectSpaceBoundaries.split_non_convex_shadings()
  • bim2sim.tasks.bps.sb_creation module
    • CreateSpaceBoundaries
      • CreateSpaceBoundaries.add_bounds_to_elements()
      • CreateSpaceBoundaries.connect_element_to_zone()
      • CreateSpaceBoundaries.connect_space_boundaries()
      • CreateSpaceBoundaries.get_opening_boundary()
      • CreateSpaceBoundaries.get_parents_and_children()
      • CreateSpaceBoundaries.get_related_opening_elems()
      • CreateSpaceBoundaries.instantiate_space_boundaries()
      • CreateSpaceBoundaries.reads
      • CreateSpaceBoundaries.reassign_opening_bounds()
      • CreateSpaceBoundaries.remove_elements_without_sbs()
      • CreateSpaceBoundaries.run()
• bim2sim.tasks.cfd package
• bim2sim.tasks.common package
  • Submodules
  • bim2sim.tasks.common.base_tasks module
    • Quit
      • Quit.final
      • Quit.run()
      • Quit.single_use
    • Reset
      • Reset.requirements_met()
      • Reset.run()
      • Reset.single_use
      • Reset.touches
  • bim2sim.tasks.common.check_ifc module
    • CheckIfc
      • CheckIfc.apply_validation_function()
      • CheckIfc.check_critical_errors()
      • CheckIfc.check_critical_uniqueness()
      • CheckIfc.check_ifc_version()
      • CheckIfc.check_inst()
      • CheckIfc.get_html_templates()
      • CheckIfc.get_relevant_elements()
      • CheckIfc.reads
      • CheckIfc.run()
      • CheckIfc.validate_elements()
      • CheckIfc.validate_sub_inst()
    • CheckIfcBPS
      • CheckIfcBPS.check_critical_errors()
      • CheckIfcBPS.check_rel_space_exist()
      • CheckIfcBPS.check_sub_inst_exist()
      • CheckIfcBPS.validate_elements()
      • CheckIfcBPS.validate_sub_inst()
    • CheckIfcHVAC
      • CheckIfcHVAC.validate_elements()
      • CheckIfcHVAC.validate_sub_inst()
  • bim2sim.tasks.common.create_elements module
    • CreateElementsOnIfcTypes
      • CreateElementsOnIfcTypes.create_constituent()
      • CreateElementsOnIfcTypes.create_layers_and_materials()
      • CreateElementsOnIfcTypes.create_layersets()
      • CreateElementsOnIfcTypes.create_material()
      • CreateElementsOnIfcTypes.create_with_validation()
      • CreateElementsOnIfcTypes.filter_by_text()
      • CreateElementsOnIfcTypes.get_ifc_types()
      • CreateElementsOnIfcTypes.reads
      • CreateElementsOnIfcTypes.run()
      • CreateElementsOnIfcTypes.set_class_by_user()
      • CreateElementsOnIfcTypes.touches
  • bim2sim.tasks.common.create_relations module
    • CreateRelations
      • CreateRelations.reads
      • CreateRelations.run()
  • bim2sim.tasks.common.deserialize_elements module
    • DeserializeElements
      • DeserializeElements.run()
      • DeserializeElements.single_use
      • DeserializeElements.touches
  • bim2sim.tasks.common.inner_loop_remover module
    • convex_decomposition()
    • convex_decomposition_base()
    • fuse_pieces()
    • is_convex_no_holes()
    • is_convex_slow()
    • is_polygon_convex_no_holes()
    • remove_inner_loops()
  • bim2sim.tasks.common.load_ifc module
    • LoadIFC
      • LoadIFC.load_ifc_files()
      • LoadIFC.run()
      • LoadIFC.touches
  • bim2sim.tasks.common.serialize_elements module
    • SerializeElements
      • SerializeElements.reads
      • SerializeElements.run()
      • SerializeElements.single_use
      • SerializeElements.touches
  • bim2sim.tasks.common.weather module
    • Weather
      • Weather.check_file_ending()
      • Weather.get_location_lat_long_from_ifc()
      • Weather.get_location_name()
      • Weather.get_weatherfile_from_dwd()
      • Weather.reads
      • Weather.run()
      • Weather.touches
• bim2sim.tasks.hvac package
  • Submodules
  • bim2sim.tasks.hvac.check_ifc module
  • bim2sim.tasks.hvac.connect_elements module
    • ConnectElements
      • ConnectElements.check_element_ports()
      • ConnectElements.check_inner_connections()
      • ConnectElements.confirm_connections_position()
      • ConnectElements.connections_by_boundingbox()
      • ConnectElements.connections_by_position()
      • ConnectElements.connections_by_relation()
      • ConnectElements.port_distance()
      • ConnectElements.reads
      • ConnectElements.run()
      • ConnectElements.touches
  • bim2sim.tasks.hvac.dead_ends module
    • DeadEnds
      • DeadEnds.decide_dead_ends()
      • DeadEnds.identify_dead_ends()
      • DeadEnds.reads
      • DeadEnds.run()
      • DeadEnds.touches
  • bim2sim.tasks.hvac.expansiontanks module
    • ExpansionTanks
      • ExpansionTanks.decide_expansion_tanks()
      • ExpansionTanks.identify_expansion_tanks()
      • ExpansionTanks.reads
      • ExpansionTanks.run()
      • ExpansionTanks.touches
  • bim2sim.tasks.hvac.export module
    • Export
      • Export.create_connections()
      • Export.final
      • Export.reads
      • Export.run()
      • Export.touches
  • bim2sim.tasks.hvac.fixports module
    • FixPorts
      • FixPorts.entities_with_unusual_number_of_ports()
      • FixPorts.get_product_position()
      • FixPorts.get_unconnected_ports()
      • FixPorts.ports_with_same_parent_and_same_position()
      • FixPorts.reads
      • FixPorts.run()
      • FixPorts.touches
      • FixPorts.unconnected_ports_on_same_position()
  • bim2sim.tasks.hvac.load_standardlibrary module
    • LoadLibrariesStandardLibrary
      • LoadLibrariesStandardLibrary.run()
      • LoadLibrariesStandardLibrary.touches
  • bim2sim.tasks.hvac.make_graph module
    • MakeGraph
      • MakeGraph.reads
      • MakeGraph.run()
      • MakeGraph.touches
  • bim2sim.tasks.hvac.obsolete module
    • DetectCycles
      • DetectCycles.reads
      • DetectCycles.run()
      • DetectCycles.touches
    • Enrich
      • Enrich.enrich_instance()
      • Enrich.load_element_class()
      • Enrich.load_element_ifc()
      • Enrich.run()
  • bim2sim.tasks.hvac.reduce module
    • Reduce
      • Reduce.reads
      • Reduce.run()
      • Reduce.set_flow_sides()
      • Reduce.touches

Submodules

bim2sim.tasks.base module

Module containing the ITask base class an Playground to execute ITasks.

All Tasks should inherit from ITask

class bim2sim.tasks.base.ITask(playground)

Bases: object

Baseclass for interactive Tasks.

Args:

reads: names of the arguments the run() method requires. The arguments

are outputs from previous tasks

touches: names that are assigned to the return value tuple of method

run()

final: flag that indicates termination of project run after this tasks single_user: flag that indicates if this tasks can be run multiple times

in same Playground

final = False

reads: Tuple[str] = ()

classmethod requirements_met(state, history) → bool

Check if all requirements for this tasks are met.

Args:

state: state of playground history: history of playground

run(**kwargs)

Run tasks.

single_use = True

touches: Tuple[str] = ()

class bim2sim.tasks.base.Playground(project: Project)

Bases: object

Playground for executing ITasks

static all_tasks() → List[Type[ITask]]

Returns list of all tasks

available_tasks() → List[Type[ITask]]

Returns list of available tasks

run_task(task: ITask) → Generator[DecisionBunch, None, None]

Generator executing tasks with arguments specified in tasks.reads.

update_elements(elements)

Updates the elements of the current run.

This only has to be done if you want to update elements manually, if a tasks touches elements, they will be updated automatically after the tasks is finished.

update_graph(graph)

Updates the graph of the current run.

This only has to be done if you want to update graph manually, if a tasks touches graph, they will be updated automatically after the tasks is finished.

exception bim2sim.tasks.base.TaskFailed

Bases: Exception