Editing IfcOpenShell

{{Infobox software
| icon       = Ifcopenshell logo.png
| screenshot = IfcOpenShell_screenshot.png
| website    = http://www.ifcopenshell.org/
| source     = [https://github.com/IfcOpenShell/IfcOpenShell github]
| license    = [https://github.com/IfcOpenShell/IfcOpenShell LGPL-3.0 & GPL-3.0]
| bugs       = [https://github.com/IfcOpenShell/IfcOpenShell/issues Report a bug]
| community  = [https://sourceforge.net/p/ifcopenshell/discussion/ Forum]
| maturity   = Mature
| donation   = [https://opencollective.com/opensourcebim OpenSourceBIM]
}}
{{Template:IfcOpenShell}}
[[IfcOpenShell|IfcOpenShell]] is an open source (LGPL 3) software library that helps developers work with the [http://www.buildingsmart-tech.org/specifications/ifc-overview industry foundation classes]  (IFC) file format. The IFC file format can be used to describe building and construction data. The format is commonly used for [https://en.wikipedia.org/wiki/Building_information_modeling building information modelling] (BIM), for example, mechanical loading analysis, and thermal and energy efficiency studies.

IfcOpenShell is primarily a collection of C++ libraries, however, as it has [[Python|Python]] bindings, it can be integrated with programs like [[FreeCAD]] and [[Blender]]. It has support for Windows, Mac, and Linux. IfcOpenShell can be used as C++ developer libraries, through Python modules, via a number of Unix-style command line applications, or via graphical interfaces. The core libraries have support for IFC2X3, IFC4, IFC4.3, as well as custom IFC schemas defined by the user. Supported serialisations include IFC-SPF, IFC-JSON, IFC-XML, and IFC-HDF5.

IfcOpenShell supports geometry processing using the [[Open_CASCADE|Open CASCADE]] geometry kernel. IFC geometry may be uniformly triangulated regardless of their original definition.

IfcOpenShell is also unique in its extensive Python API, which includes hundreds of functions for common IFC manipulation operations. This API supports many aspects of IFC not usually supported in other tools, including cascading geometric coordinate changes, subgraph purging, appending elements, and extensive support for 4D and 5D BIM operations like cost formulas, critical path analysis, and calendar-based scheduling propagation. It is also unique in its support for HDF5 caching, voxel analysis for dealing with less than precise BIM geometry, and semantic SVG-based drawing generation.

=Tools=

In addition to a developer library, IfcOpenshell can be used through multiple command line tools which can be used independently or together :
==[https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.6.0/src/bcf bcf-python]==
A simple Python implementation of [[BIM_Collaboration_Format_(BCF)]]. The data model is described in data.py. Manipulation of BCF-XML is available via bcfxml.py and manipulation of BCF-API is available via bcfapi.py. See also [[:Category:BIM_Collaboration_Format_(BCF)]]. [[Category:BIM_Collaboration_Format_(BCF)]]

==[http://ifcopenshell.org/ifcconvert IfcConvert]==
A command line tool to convert IFC to different format including :
{| class="wikitable" 
|-
! .obj
! WaveFront OBJ
! (a .mtl file is also created)
|-
| .dae
| Collada
| Digital Assets Exchange
|-
| .glb
| glTF
| Binary glTF v2.0
|-
| .stp
| STEP
| Standard for the Exchange of Product Data
|-
| .igs
| IGES
| Initial Graphics Exchange Specification
|-
| .xml
| XML
| Property definitions and decomposition tree
|-
| .svg
| SVG
| Scalable Vector Graphics (2D floor plan)
|-
| .ifc
| IFC-SPF
| Industry Foundation Classes
|}
You can pass multiple options. Type <code>IfcConvert --help</code> to learn more (considering it is installed on your system).

==[https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.6.0/src/ifcgeomserver IfcGeomServer]==
A command-line tool which allow to process geometry in a crash safe manner using a child process with dynamic linking.

==[http://ifcopenshell.org/python IfcOpenShell-python]==
A python API to manipulate IFC. See [[IfcOpenShell code examples]]. Comes with many utility functions for geolocation, data extraction, IFC query filtering, and more.

==IFC Clash==
IFC Clash detection using the flexible collision library.

==IFC2CA==
Conversion of IFC files into input files for Code_Aster structural simulation software.

==IFC COBie==
Conversion of IFC-SPF data into SpreadsheetML format for the COBie MVD. Includes error logging of invalid data and support for open format alternatives like CSV and ODS.
See also: [[BlenderBIM_and_COBie]]

==IFC CSV==
Import and export support of IFC data to and from CSV files using a custom IFC query language.
See also: [[BlenderBIM_IFCCSV]]

==IFC Diff==
Compares two IFC files with settings to check geometry or particular data relationships. Produces a parseable diff in JSON.

==IFC Patch==
Provides a standard interface for users to easily apply predetermined "recipes" to manipulate IFC data without needing to have any technical knowledge. See forum topic for a example how to run it. https://community.osarch.org/discussion/10/ifcpatch-tool-now-available#latest

==IFC Sverchok==
Provides an extension to the Blender Sverchok add-on for visual programming nodes for IFC within the Blender environment.

==BIMTester==
Provides a way to specify BIM exchange requirements using natural human language and audit IFC files to check if they comply with the requirements.

==[http://ifcopenshell.org/ifcblender IfcBlender]==
Replaced by [[BlenderBIM Add-on]].

==[http://ifcopenshell.org/ifcmax IfcMax]==
This plugin seems to not be developed anymore. It was an Ifc importer for 3ds Max.

=Softwares powered by ifcopenshell=

The following lists of projects, academia, and industry organisations is incomplete. People who use IfcOpenShell are not required to advertise that they do so and IfcOpenShell is a community effort that does not collect or have a list of customers like private companies.

==FOSS projects==
* [[BIMxBEM]] : import IfcRelSpaceBoundary, IfcSpace and related building elements geometry and data
* [[BlenderBIM Add-on]] : ifcopenshell-python - import/export, multi-core geometry processing and more (Winner of 2020 buildingSMART Awards in Technology)
* [[FreeCAD]] : ifcopenshell-python - import/export Parametric 3D modeler allowing you to easily modify your design. 
* [[ifc-pipeline]] : IfcConvert / ifcopenshell - python
* [https://youshengcode.github.io/IfcToolbox.Doc/#/ IFC Toolbox] No-code IFC editing uses IfcOpenShell for model conversions.
* [https://github.com/opensourceBIM/BIMserver BIMServer] enables you to store and manage the information of a construction (or other building related) project. 
* BIMSurfer
* [https://www.openproject.org/ OpenProject] An open source commercial CDE that uses IfcOpenShell for model processing.
* [https://xeokit.io/ xeokit-sdk] An open source 3D graphics SDK from xeolabs for BIM and AEC. Built to view huge models in the browser. Used by industry leaders.

==Proprietary projects==
* [http://areo.io/ Areo] SMART Facilities Management
* [https://augin.app/en/ Augin.app] Publish and view AEC content in augmented reality in the environment on a 1:1 scale.
* [https://bimdata.io/ BIMData.io] Provides an integrated viewer capable of loading several tens of thousands of objects. 
* [https://bimforce.com/en/homepage/ Bimforce] for IFC drawing generation
* [https://www.cove.tools/ Cove.Tool] to integrate into Blender for sustainability analysis
* [https://scai.group/ KeyFrame] to help process IFC models for their viewer
* [https://modulize.io/ Modulize] - Uses IfcOpenShell "quite a lot"
* [https://regola.io/ Regola] - Used for model checking
* [https://rengabim.com/ RengaSoftware] - used in [https://github.com/IfcOpenShell/IfcOpenShell/issues/1028#issuecomment-776085665 various operations] internally
* [https://www.spectar.io/ Spectar] - Used for IFC conversions
* [https://streambim.com/ StreamBIM] (previously known as Rendra.io) (Winner of 2020 buildingSMART Awards in Construction via Project Celsius)
* [https://tridify.com/ Tridify] (Epic Megagrants recipient) Stream large & complex BIMs from the Cloud. A BIM Communication Service for all stakeholders with communication to issue management software.
* [https://www.tridyme.com/ TriDyme] TriDyme helps construction's companies to develop their own cloud-based (online) applications.
* [https://wittym.com/ Wittym] Wittym centralises digital twin data and simply connects experts with non-experts on a web platform. IfcOpenShell is used in the web platform to organize IFC in databases.
* [https://github.com/louistrue/PythonForIFC/tree/main/IfcPropertyRenamer IfcPropertyRenamer] A GUI to bulk rename properties
* [https://ifcdev.baseapps.net/viewer IFC Werkzeug] A web app to view and edit data about IFCs

==Academia==

IfcOpenShell is also used in university courses around the world.

* École Polytechnique Fédérale de Lausanne (EPFL Switzerland)
* Fachhochschule Nordwestschweiz FHNW (University of Applied Sciences and Arts Northwestern Switzerland)
* Federal University of Viçosa in Brazil
* MSc-education of Architecture, Civil Engineering and Construction & Robotics tracks at RWTH Aachen University in Germany
* Technical University of Denmark
* TU Eindhoven in the Netherlands
* Parametric Design with Visual Programming in BIM by the Online Zigurat Global Institute for Technology
* [https://bimfag.no/ BIMfag] Courses for BIM technicians in Norway
* Tallinn University of Technology in Estonia
* [https://ideamechelen.be/masterclass-building-intelligence Masterclass Building Intelligence] Thomas More Mechelen in Belgium

It has also been a primary contributor in a number of research papers.

* [https://cejsh.icm.edu.pl/cejsh/element/bwmeta1.element.desklight-c9a5f07b-03fc-467a-94a3-5aa467cd12cb Malewczyk, Michał. "The usage of the openBIM idea in architectural design on the example of Blender and BlenderBIM add-on." Architectus 2 (66) (2021): 99-104.]
* [https://ec-3.org/publications/conference/paper/?id=EC32023_280 McGinley, Tim, Kristoffer Negendahl, Piotr Smolira, Martyna Jakubowska, Ann-Britt Vejlgaard, and Jan Karlshøj. "Supporting the OpenBIM transition." In EC3 Conference 2023, vol. 4, pp. 0-0. European Council on Computing in Construction, 2023.]
* [https://research.tudelft.nl/files/75450315/EG_ICE_2020_moult_krijnen_p310_319.pdf Moult, Dion, and Thomas Krijnen. "Compliance checking on building models with the Gherkin language and Continuous Integration." In EG-ICE 2020 Workshop on Intelligent Computing in Engineering, Proceedings, pp. 294-303. 2020.]
* [https://publications.ibpsa.org/proceedings/bausim/2022/papers/bausim2022_Loehr_Felix.pdf Löhr, F., A. Gerber, and M. Stobbe. "SEMI-AUTOMATED GENERATION OF MULTI-ZONE THERMAL MODELS FROM BUILDING-INFORMATION-MODELING DATA."]

It has also been incidentally used or mentioned in a number of research papers.

* [https://www.mdpi.com/2075-5309/13/9/2336 Wei, Chialing, Mohit Gupta, and Thomas Czerniawski. 2023. "Interoperability between Deep Neural Networks and 3D Architectural Modeling Software: Affordances of Detection and Segmentation" Buildings 13, no. 9: 2336. https://doi.org/10.3390/buildings13092336]
* [https://joss.theoj.org/papers/10.21105/joss.03061.pdf Jaud, Štefan, Helge Hecht, Jonas Schlenger, and Julian Amann. "TUM Open Infra Platform: an open source package for simultaneous viewing and analysis of digital models in the civil engineering domain." Journal of Open Source Software 7, no. 72 (2022): 3061.]

==Industry==

IfcOpenShell is known to be used in various companies and organisations. Size is roughly based on employee numbers: tiny (1-10), small (<100), medium (<1000), large.

{| class="wikitable"
|-
! Name !! Country !! Company Size !! Sector
|-
| AF Gruppen Norge AS || Norway || Large || Example
|-
| Ai.K Data Labs || India || Tiny || Example
|-
| BAUPUNKTNULL AG || Switzerland || ? || Example
|-
| BCCV || Morocco || Tiny || Example
|-
| bda2bim|| France || Tiny || Example
|-
| Bouygues Construction || Australia || Large || Example
|-
| Brasfield & Gorrie || USA|| Large || General Contractor
|-
| Bylor || UK || Large || Example
|-
| Géo²Concept || France|| Small || Example
|-
| Geosurv || Australia || Small || Example
|-
| John Holland || Australia || Large || Example
|-
| Ingenieursbureau 3BM || Netherlands || Example || Example
|-
| Laing O'Rourke || Australia || Large || Example
|-
| LAB Entreprenør AS || Norway || Medium || Example
|-
| Lendlease || Australia || Large || Example
|-
| Norconsult Norge AS || Norway || Large || Example
|-
| OpeningDesign || USA || Tiny || Example
|-
| Société des Grands Projets || France || Medium || Example
|-
| Spectar || USA || Small || Example
|-
| Tietoa Finland Oy || Finland || Small || Example
|-
| Transport for NSW || Australia || Large || Example
|-
| WSP || Australia || Large || Example
|}

=Installation=

IfcOpenShell may be packaged in different Linux repositories, ready to install and use; or it can be packaged together with some programs that use it, for example, [[FreeCAD]].

In other cases you may get one of the stand-alone, pre-compiled distributions, or you may download and compile the source code yourself.

To learn more about installing IfcOpenShell, visit the page in the FreeCAD wiki: [https://wiki.freecadweb.org/IfcOpenShell IfcOpenShell].

= See also =
* Visit the [[:Category:IfcOpenShell|IfcOpenShell Category]] on this website.

= External Resources =
* Visit the IfcOpenShell Academy: http://academy.ifcopenshell.org/category/ifcopenshell/
* Visit the IfcOpenShell forum: https://sourceforge.net/p/ifcopenshell/discussion/
* learn with Jupyter Notebook coding examples from:
https://github.com/jakob-beetz/IfcOpenShellScriptingTutorial (by Jakob Beetz)

https://github.com/bimfag/intro-python-bim (by Sigve Martin Pettersen and Hans Martin Eikerol)

https://github.com/jakob-beetz/ifcopenshell-notebooks (by Jakob Beetz)

* Tutorial and code examples:

https://github.com/stefkeB/ifcopenshell_examples (by Stefan Boeykens)

[[Category:IfcOpenShell]]
[[Category:Software]]
[[Category:Industry Foundation Classes (IFC)]]