Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
IfcOpenShell 0.8.1 documentation
Logo
IfcOpenShell 0.8.1 documentation

Main:

  • Introduction
    • Introduction to BIM
    • Introduction to IFC
    • How to contribute
  • IfcOpenShell
    • Installation
    • Getting Started with IFC parsing
    • Geometry iterator
    • Geometry settings
    • Serialiser settings
    • Boolean process
  • IfcOpenShell-Python
    • Installation
    • Hello, world!
    • Code examples
    • Geometry processing
    • Geometry creation
    • Geometry tree
    • Selector syntax
    • Developer Guide
  • IfcConvert
    • Installation
    • Usage
  • Bonsai

Utilities:

  • BCF
  • BIMServer-Plugin
  • BIMTester
  • bSDD
  • Ifc2CA
  • Ifc4D
  • Ifc5D
  • IfcCityJSON
  • IfcClash
  • IfcCSV
  • IfcDiff
  • IfcFM
  • IfcMax
  • IfcPatch
  • IfcSverchok
    • Installation
  • IfcTester
  • Other utilities

API:

  • C++ API Reference
  • Python API Reference
    • bcf
      • bcf.v2
        • bcf.v2.model
          • bcf.v2.model.extensions
          • bcf.v2.model.markup
          • bcf.v2.model.project
          • bcf.v2.model.version
          • bcf.v2.model.visinfo
        • bcf.v2.bcfxml
        • bcf.v2.topic
        • bcf.v2.visinfo
      • bcf.v3
        • bcf.v3.model
          • bcf.v3.model.documents
          • bcf.v3.model.extensions
          • bcf.v3.model.markup
          • bcf.v3.model.project
          • bcf.v3.model.version
          • bcf.v3.model.visinfo
        • bcf.v3.bcfapi
        • bcf.v3.bcfxml
        • bcf.v3.document
        • bcf.v3.topic
        • bcf.v3.visinfo
      • bcf.bcfxml
      • bcf.extensions
      • bcf.geometry
      • bcf.inmemory_zipfile
      • bcf.xml_parser
    • bsdd
    • test
    • topic
    • model
    • ifccsv
    • visinfo
    • ifcdiff
    • ifcpatch
      • ifcpatch.recipes
        • ifcpatch.recipes.AssignConstituentFractions
        • ifcpatch.recipes.ConvertLengthUnit
        • ifcpatch.recipes.ConvertNestToAggregate
        • ifcpatch.recipes.ConvertPropertiesToQuantities
        • ifcpatch.recipes.DowngradeIndexedPolyCurve
        • ifcpatch.recipes.ExtractElements
        • ifcpatch.recipes.ExtractPropertiesToSQLite
        • ifcpatch.recipes.FixArchiCADToRevitDoorSwings
        • ifcpatch.recipes.FixArchiCADToRevitSpaces
        • ifcpatch.recipes.FixRevitClassificationCodeTypes
        • ifcpatch.recipes.FixRevitTINs
        • ifcpatch.recipes.Ifc2Sql
        • ifcpatch.recipes.MergeDuplicateTypes
        • ifcpatch.recipes.MergeProjects
        • ifcpatch.recipes.Migrate
        • ifcpatch.recipes.OffsetObjectPlacements
        • ifcpatch.recipes.OffsetStoreyElevations
        • ifcpatch.recipes.Optimise
        • ifcpatch.recipes.PurgeData
        • ifcpatch.recipes.RecycleNonRootedElements
        • ifcpatch.recipes.RegenerateGlobalIds
        • ifcpatch.recipes.RemoveRevitUniformatClassification
        • ifcpatch.recipes.RemoveSiteRepresentation
        • ifcpatch.recipes.ResetAbsoluteCoordinates
        • ifcpatch.recipes.ResetSpatialElementLocations
        • ifcpatch.recipes.SetFalseOrigin
        • ifcpatch.recipes.SetRefElevation
        • ifcpatch.recipes.SetWorldCoordinateSystem
        • ifcpatch.recipes.SplitByBuildingStorey
        • ifcpatch.recipes.TessellateElements
        • ifcpatch.recipes.UnsharePsets
    • test_bsdd
    • ifctester
      • ifctester.facet
      • ifctester.ids
      • ifctester.reporter
    • extensions
    • ifcopenshell
      • ifcopenshell.api
        • ifcopenshell.api.aggregate
          • ifcopenshell.api.aggregate.assign_object
          • ifcopenshell.api.aggregate.unassign_object
        • ifcopenshell.api.attribute
          • ifcopenshell.api.attribute.edit_attributes
        • ifcopenshell.api.boundary
          • ifcopenshell.api.boundary.assign_connection_geometry
          • ifcopenshell.api.boundary.copy_boundary
          • ifcopenshell.api.boundary.edit_attributes
          • ifcopenshell.api.boundary.remove_boundary
        • ifcopenshell.api.classification
          • ifcopenshell.api.classification.add_classification
          • ifcopenshell.api.classification.add_reference
          • ifcopenshell.api.classification.edit_classification
          • ifcopenshell.api.classification.edit_reference
          • ifcopenshell.api.classification.remove_classification
          • ifcopenshell.api.classification.remove_reference
        • ifcopenshell.api.constraint
          • ifcopenshell.api.constraint.add_metric
          • ifcopenshell.api.constraint.add_metric_reference
          • ifcopenshell.api.constraint.add_objective
          • ifcopenshell.api.constraint.assign_constraint
          • ifcopenshell.api.constraint.edit_metric
          • ifcopenshell.api.constraint.edit_objective
          • ifcopenshell.api.constraint.remove_constraint
          • ifcopenshell.api.constraint.remove_metric
          • ifcopenshell.api.constraint.unassign_constraint
        • ifcopenshell.api.context
          • ifcopenshell.api.context.add_context
          • ifcopenshell.api.context.edit_context
          • ifcopenshell.api.context.remove_context
        • ifcopenshell.api.control
          • ifcopenshell.api.control.assign_control
          • ifcopenshell.api.control.unassign_control
        • ifcopenshell.api.cost
          • ifcopenshell.api.cost.add_cost_item
          • ifcopenshell.api.cost.add_cost_item_quantity
          • ifcopenshell.api.cost.add_cost_schedule
          • ifcopenshell.api.cost.add_cost_value
          • ifcopenshell.api.cost.assign_cost_item_quantity
          • ifcopenshell.api.cost.assign_cost_value
          • ifcopenshell.api.cost.calculate_cost_item_resource_value
          • ifcopenshell.api.cost.copy_cost_item
          • ifcopenshell.api.cost.copy_cost_item_values
          • ifcopenshell.api.cost.edit_cost_item
          • ifcopenshell.api.cost.edit_cost_item_quantity
          • ifcopenshell.api.cost.edit_cost_schedule
          • ifcopenshell.api.cost.edit_cost_value
          • ifcopenshell.api.cost.edit_cost_value_formula
          • ifcopenshell.api.cost.remove_cost_item
          • ifcopenshell.api.cost.remove_cost_item_quantity
          • ifcopenshell.api.cost.remove_cost_schedule
          • ifcopenshell.api.cost.remove_cost_value
          • ifcopenshell.api.cost.unassign_cost_item_quantity
        • ifcopenshell.api.document
          • ifcopenshell.api.document.add_information
          • ifcopenshell.api.document.add_reference
          • ifcopenshell.api.document.assign_document
          • ifcopenshell.api.document.edit_information
          • ifcopenshell.api.document.edit_reference
          • ifcopenshell.api.document.remove_information
          • ifcopenshell.api.document.remove_reference
          • ifcopenshell.api.document.unassign_document
        • ifcopenshell.api.drawing
          • ifcopenshell.api.drawing.assign_product
          • ifcopenshell.api.drawing.edit_text_literal
          • ifcopenshell.api.drawing.unassign_product
        • ifcopenshell.api.feature
          • ifcopenshell.api.feature.add_feature
          • ifcopenshell.api.feature.add_filling
          • ifcopenshell.api.feature.remove_feature
          • ifcopenshell.api.feature.remove_filling
        • ifcopenshell.api.geometry
          • ifcopenshell.api.geometry.add_axis_representation
          • ifcopenshell.api.geometry.add_boolean
          • ifcopenshell.api.geometry.add_door_representation
          • ifcopenshell.api.geometry.add_footprint_representation
          • ifcopenshell.api.geometry.add_mesh_representation
          • ifcopenshell.api.geometry.add_profile_representation
          • ifcopenshell.api.geometry.add_railing_representation
          • ifcopenshell.api.geometry.add_representation
          • ifcopenshell.api.geometry.add_shape_aspect
          • ifcopenshell.api.geometry.add_slab_representation
          • ifcopenshell.api.geometry.add_wall_representation
          • ifcopenshell.api.geometry.add_window_representation
          • ifcopenshell.api.geometry.assign_representation
          • ifcopenshell.api.geometry.connect_element
          • ifcopenshell.api.geometry.connect_path
          • ifcopenshell.api.geometry.create_2pt_wall
          • ifcopenshell.api.geometry.disconnect_element
          • ifcopenshell.api.geometry.disconnect_path
          • ifcopenshell.api.geometry.edit_object_placement
          • ifcopenshell.api.geometry.map_representation
          • ifcopenshell.api.geometry.remove_boolean
          • ifcopenshell.api.geometry.remove_representation
          • ifcopenshell.api.geometry.unassign_representation
          • ifcopenshell.api.geometry.validate_type
        • ifcopenshell.api.georeference
          • ifcopenshell.api.georeference.add_georeferencing
          • ifcopenshell.api.georeference.edit_georeferencing
          • ifcopenshell.api.georeference.edit_true_north
          • ifcopenshell.api.georeference.edit_wcs
          • ifcopenshell.api.georeference.remove_georeferencing
        • ifcopenshell.api.grid
          • ifcopenshell.api.grid.create_axis_curve
          • ifcopenshell.api.grid.create_grid_axis
          • ifcopenshell.api.grid.remove_grid_axis
        • ifcopenshell.api.group
          • ifcopenshell.api.group.add_group
          • ifcopenshell.api.group.assign_group
          • ifcopenshell.api.group.edit_group
          • ifcopenshell.api.group.remove_group
          • ifcopenshell.api.group.unassign_group
          • ifcopenshell.api.group.update_group_products
        • ifcopenshell.api.layer
          • ifcopenshell.api.layer.add_layer
          • ifcopenshell.api.layer.add_layer_with_style
          • ifcopenshell.api.layer.assign_layer
          • ifcopenshell.api.layer.edit_layer
          • ifcopenshell.api.layer.remove_layer
          • ifcopenshell.api.layer.unassign_layer
        • ifcopenshell.api.library
          • ifcopenshell.api.library.add_library
          • ifcopenshell.api.library.add_reference
          • ifcopenshell.api.library.assign_reference
          • ifcopenshell.api.library.edit_library
          • ifcopenshell.api.library.edit_reference
          • ifcopenshell.api.library.remove_library
          • ifcopenshell.api.library.remove_reference
          • ifcopenshell.api.library.unassign_reference
        • ifcopenshell.api.material
          • ifcopenshell.api.material.add_constituent
          • ifcopenshell.api.material.add_layer
          • ifcopenshell.api.material.add_list_item
          • ifcopenshell.api.material.add_material
          • ifcopenshell.api.material.add_material_set
          • ifcopenshell.api.material.add_profile
          • ifcopenshell.api.material.assign_material
          • ifcopenshell.api.material.assign_profile
          • ifcopenshell.api.material.copy_material
          • ifcopenshell.api.material.edit_assigned_material
          • ifcopenshell.api.material.edit_constituent
          • ifcopenshell.api.material.edit_layer
          • ifcopenshell.api.material.edit_layer_usage
          • ifcopenshell.api.material.edit_material
          • ifcopenshell.api.material.edit_profile
          • ifcopenshell.api.material.edit_profile_usage
          • ifcopenshell.api.material.remove_constituent
          • ifcopenshell.api.material.remove_layer
          • ifcopenshell.api.material.remove_list_item
          • ifcopenshell.api.material.remove_material
          • ifcopenshell.api.material.remove_material_set
          • ifcopenshell.api.material.remove_profile
          • ifcopenshell.api.material.reorder_set_item
          • ifcopenshell.api.material.unassign_material
        • ifcopenshell.api.nest
          • ifcopenshell.api.nest.assign_object
          • ifcopenshell.api.nest.change_nest
          • ifcopenshell.api.nest.reorder_nesting
          • ifcopenshell.api.nest.unassign_object
        • ifcopenshell.api.owner
          • ifcopenshell.api.owner.add_actor
          • ifcopenshell.api.owner.add_address
          • ifcopenshell.api.owner.add_application
          • ifcopenshell.api.owner.add_organisation
          • ifcopenshell.api.owner.add_person
          • ifcopenshell.api.owner.add_person_and_organisation
          • ifcopenshell.api.owner.add_role
          • ifcopenshell.api.owner.assign_actor
          • ifcopenshell.api.owner.create_owner_history
          • ifcopenshell.api.owner.edit_actor
          • ifcopenshell.api.owner.edit_address
          • ifcopenshell.api.owner.edit_organisation
          • ifcopenshell.api.owner.edit_person
          • ifcopenshell.api.owner.edit_role
          • ifcopenshell.api.owner.remove_actor
          • ifcopenshell.api.owner.remove_address
          • ifcopenshell.api.owner.remove_application
          • ifcopenshell.api.owner.remove_organisation
          • ifcopenshell.api.owner.remove_person
          • ifcopenshell.api.owner.remove_person_and_organisation
          • ifcopenshell.api.owner.remove_role
          • ifcopenshell.api.owner.settings
          • ifcopenshell.api.owner.unassign_actor
          • ifcopenshell.api.owner.update_owner_history
        • ifcopenshell.api.profile
          • ifcopenshell.api.profile.add_arbitrary_profile
          • ifcopenshell.api.profile.add_arbitrary_profile_with_voids
          • ifcopenshell.api.profile.add_parameterized_profile
          • ifcopenshell.api.profile.copy_profile
          • ifcopenshell.api.profile.edit_profile
          • ifcopenshell.api.profile.remove_profile
        • ifcopenshell.api.project
          • ifcopenshell.api.project.append_asset
          • ifcopenshell.api.project.assign_declaration
          • ifcopenshell.api.project.create_file
          • ifcopenshell.api.project.unassign_declaration
        • ifcopenshell.api.pset
          • ifcopenshell.api.pset.add_pset
          • ifcopenshell.api.pset.add_qto
          • ifcopenshell.api.pset.assign_pset
          • ifcopenshell.api.pset.edit_pset
          • ifcopenshell.api.pset.edit_qto
          • ifcopenshell.api.pset.remove_pset
          • ifcopenshell.api.pset.unassign_pset
          • ifcopenshell.api.pset.unshare_pset
        • ifcopenshell.api.pset_template
          • ifcopenshell.api.pset_template.add_prop_template
          • ifcopenshell.api.pset_template.add_pset_template
          • ifcopenshell.api.pset_template.edit_prop_template
          • ifcopenshell.api.pset_template.edit_pset_template
          • ifcopenshell.api.pset_template.remove_prop_template
          • ifcopenshell.api.pset_template.remove_pset_template
        • ifcopenshell.api.resource
          • ifcopenshell.api.resource.add_resource
          • ifcopenshell.api.resource.add_resource_quantity
          • ifcopenshell.api.resource.add_resource_time
          • ifcopenshell.api.resource.assign_resource
          • ifcopenshell.api.resource.calculate_resource_usage
          • ifcopenshell.api.resource.calculate_resource_work
          • ifcopenshell.api.resource.edit_resource
          • ifcopenshell.api.resource.edit_resource_quantity
          • ifcopenshell.api.resource.edit_resource_time
          • ifcopenshell.api.resource.remove_resource
          • ifcopenshell.api.resource.remove_resource_quantity
          • ifcopenshell.api.resource.unassign_resource
        • ifcopenshell.api.root
          • ifcopenshell.api.root.copy_class
          • ifcopenshell.api.root.create_entity
          • ifcopenshell.api.root.reassign_class
          • ifcopenshell.api.root.remove_product
        • ifcopenshell.api.sequence
          • ifcopenshell.api.sequence.add_task
          • ifcopenshell.api.sequence.add_task_time
          • ifcopenshell.api.sequence.add_time_period
          • ifcopenshell.api.sequence.add_work_calendar
          • ifcopenshell.api.sequence.add_work_plan
          • ifcopenshell.api.sequence.add_work_schedule
          • ifcopenshell.api.sequence.add_work_time
          • ifcopenshell.api.sequence.assign_lag_time
          • ifcopenshell.api.sequence.assign_process
          • ifcopenshell.api.sequence.assign_product
          • ifcopenshell.api.sequence.assign_recurrence_pattern
          • ifcopenshell.api.sequence.assign_sequence
          • ifcopenshell.api.sequence.assign_work_plan
          • ifcopenshell.api.sequence.calculate_task_duration
          • ifcopenshell.api.sequence.cascade_schedule
          • ifcopenshell.api.sequence.create_baseline
          • ifcopenshell.api.sequence.duplicate_task
          • ifcopenshell.api.sequence.edit_lag_time
          • ifcopenshell.api.sequence.edit_recurrence_pattern
          • ifcopenshell.api.sequence.edit_sequence
          • ifcopenshell.api.sequence.edit_task
          • ifcopenshell.api.sequence.edit_task_time
          • ifcopenshell.api.sequence.edit_work_calendar
          • ifcopenshell.api.sequence.edit_work_plan
          • ifcopenshell.api.sequence.edit_work_schedule
          • ifcopenshell.api.sequence.edit_work_time
          • ifcopenshell.api.sequence.recalculate_schedule
          • ifcopenshell.api.sequence.remove_task
          • ifcopenshell.api.sequence.remove_time_period
          • ifcopenshell.api.sequence.remove_work_calendar
          • ifcopenshell.api.sequence.remove_work_plan
          • ifcopenshell.api.sequence.remove_work_schedule
          • ifcopenshell.api.sequence.remove_work_time
          • ifcopenshell.api.sequence.unassign_lag_time
          • ifcopenshell.api.sequence.unassign_process
          • ifcopenshell.api.sequence.unassign_product
          • ifcopenshell.api.sequence.unassign_recurrence_pattern
          • ifcopenshell.api.sequence.unassign_sequence
        • ifcopenshell.api.spatial
          • ifcopenshell.api.spatial.assign_container
          • ifcopenshell.api.spatial.dereference_structure
          • ifcopenshell.api.spatial.reference_structure
          • ifcopenshell.api.spatial.unassign_container
        • ifcopenshell.api.structural
          • ifcopenshell.api.structural.add_structural_activity
          • ifcopenshell.api.structural.add_structural_analysis_model
          • ifcopenshell.api.structural.add_structural_boundary_condition
          • ifcopenshell.api.structural.add_structural_load
          • ifcopenshell.api.structural.add_structural_load_case
          • ifcopenshell.api.structural.add_structural_load_group
          • ifcopenshell.api.structural.add_structural_member_connection
          • ifcopenshell.api.structural.assign_structural_analysis_model
          • ifcopenshell.api.structural.edit_structural_analysis_model
          • ifcopenshell.api.structural.edit_structural_boundary_condition
          • ifcopenshell.api.structural.edit_structural_connection_cs
          • ifcopenshell.api.structural.edit_structural_item_axis
          • ifcopenshell.api.structural.edit_structural_load
          • ifcopenshell.api.structural.edit_structural_load_case
          • ifcopenshell.api.structural.remove_structural_analysis_model
          • ifcopenshell.api.structural.remove_structural_boundary_condition
          • ifcopenshell.api.structural.remove_structural_connection_condition
          • ifcopenshell.api.structural.remove_structural_load
          • ifcopenshell.api.structural.remove_structural_load_case
          • ifcopenshell.api.structural.remove_structural_load_group
          • ifcopenshell.api.structural.unassign_structural_analysis_model
        • ifcopenshell.api.style
          • ifcopenshell.api.style.add_style
          • ifcopenshell.api.style.add_surface_style
          • ifcopenshell.api.style.add_surface_textures
          • ifcopenshell.api.style.assign_item_style
          • ifcopenshell.api.style.assign_material_style
          • ifcopenshell.api.style.assign_representation_styles
          • ifcopenshell.api.style.edit_presentation_style
          • ifcopenshell.api.style.edit_surface_style
          • ifcopenshell.api.style.remove_style
          • ifcopenshell.api.style.remove_styled_representation
          • ifcopenshell.api.style.remove_surface_style
          • ifcopenshell.api.style.unassign_material_style
          • ifcopenshell.api.style.unassign_representation_styles
        • ifcopenshell.api.system
          • ifcopenshell.api.system.add_port
          • ifcopenshell.api.system.add_system
          • ifcopenshell.api.system.assign_flow_control
          • ifcopenshell.api.system.assign_port
          • ifcopenshell.api.system.assign_system
          • ifcopenshell.api.system.connect_port
          • ifcopenshell.api.system.disconnect_port
          • ifcopenshell.api.system.edit_system
          • ifcopenshell.api.system.remove_system
          • ifcopenshell.api.system.unassign_flow_control
          • ifcopenshell.api.system.unassign_port
          • ifcopenshell.api.system.unassign_system
        • ifcopenshell.api.type
          • ifcopenshell.api.type.assign_type
          • ifcopenshell.api.type.map_type_representations
          • ifcopenshell.api.type.unassign_type
        • ifcopenshell.api.unit
          • ifcopenshell.api.unit.add_context_dependent_unit
          • ifcopenshell.api.unit.add_conversion_based_unit
          • ifcopenshell.api.unit.add_derived_unit
          • ifcopenshell.api.unit.add_monetary_unit
          • ifcopenshell.api.unit.add_si_unit
          • ifcopenshell.api.unit.assign_unit
          • ifcopenshell.api.unit.edit_derived_unit
          • ifcopenshell.api.unit.edit_monetary_unit
          • ifcopenshell.api.unit.edit_named_unit
          • ifcopenshell.api.unit.remove_unit
          • ifcopenshell.api.unit.unassign_unit
      • ifcopenshell.express
        • ifcopenshell.express.bootstrap
        • ifcopenshell.express.codegen
        • ifcopenshell.express.definitions
        • ifcopenshell.express.documentation
        • ifcopenshell.express.express_parser
        • ifcopenshell.express.header
        • ifcopenshell.express.implementation
        • ifcopenshell.express.mapping
        • ifcopenshell.express.nodes
        • ifcopenshell.express.rule_compiler
        • ifcopenshell.express.rule_executor
        • ifcopenshell.express.schema
        • ifcopenshell.express.schema_class
        • ifcopenshell.express.templates
      • ifcopenshell.geom
        • ifcopenshell.geom.app
        • ifcopenshell.geom.code_editor_pane
        • ifcopenshell.geom.main
        • ifcopenshell.geom.occ_utils
      • ifcopenshell.util
        • ifcopenshell.util.attribute
        • ifcopenshell.util.brick
        • ifcopenshell.util.classification
        • ifcopenshell.util.constraint
        • ifcopenshell.util.cost
        • ifcopenshell.util.data
        • ifcopenshell.util.date
        • ifcopenshell.util.doc
        • ifcopenshell.util.element
        • ifcopenshell.util.file
        • ifcopenshell.util.fm
        • ifcopenshell.util.generate_pset_templates
        • ifcopenshell.util.geolocation
        • ifcopenshell.util.ifc4x3dev_scrape_data_for_docs
        • ifcopenshell.util.placement
        • ifcopenshell.util.pset
        • ifcopenshell.util.representation
        • ifcopenshell.util.resource
        • ifcopenshell.util.schema
        • ifcopenshell.util.selector
        • ifcopenshell.util.sequence
        • ifcopenshell.util.shape
        • ifcopenshell.util.shape_builder
        • ifcopenshell.util.system
        • ifcopenshell.util.type
        • ifcopenshell.util.unit
      • ifcopenshell.alignment
      • ifcopenshell.draw
      • ifcopenshell.entity_instance
      • ifcopenshell.file
      • ifcopenshell.guid
      • ifcopenshell.settings
      • ifcopenshell.sql
      • ifcopenshell.stream
      • ifcopenshell.template
      • ifcopenshell.validate
    • yml_to_classes
  • Indices and tables
Back to top
View this page
Edit this page

Python API ReferenceΒΆ

This page contains auto-generated API reference documentation [1].

  • bcf
  • bsdd
  • test
  • topic
  • model
  • ifccsv
  • visinfo
  • ifcdiff
  • ifcpatch
  • test_bsdd
  • ifctester
  • extensions
  • ifcopenshell
  • yml_to_classes
[1]

Created with sphinx-autoapi

Next
bcf
Previous
Other utilities
Copyright © 2011-2024 IfcOpenShell Contributors
Made with Sphinx and @pradyunsg's Furo