View source for BlenderBIM Add-on/Using the Python console with BlenderBIM Add-on

{{Start_coding}}

The Bonsai Add-on (formerly known as BlenderBIM) comes with my useful Python libraries to interrogate BIM data, in addition to the math and geometry libraries that Blender comes with. A short list of these additional libraries is provided:

* '''ifcopenshell''' - used for querying, writing, and manipulating IFC data and files
* '''bcfplugin''' - used for querying, writing, and manipulating BCF data and files
* '''fcl''' - used for writing custom logic for clash detection
* '''OCC''' - used or directly accessing the [[Open_CASCADE|Open CASCADE]] geometry kernel for low-level geometric analysis
* '''svgwrite''' - used for writing SVG for construction documentation
* '''ifcdiff''' - used for comparing IFC files for changes
* '''ifccsv''' - used for exporting and importing BIM data with CSV
* '''ifcclash''' - a frontend of FCL, allowing you to trigger clash sets for collision detection

[[File:Blender-python-console.png|300px|thumb|right|How to switch to Blender Python console mode]]

[[File:Blender-python-ifcopenshell.png|300px|thumb|right|Running IfcOpenShell commands in the Blender console]]

You can launch an interactive Python shell letting you query BIM data in real-time. To do so:

# [https://bonsaibim.org/download.html Install the Bonsai Add-on] and ensure it is enabled
# Switch to the Blender Python console mode.
# There is no step 3.

You can now type in <code>import ifcopenshell</code> and it'll work! Have fun!

[[File:Blender-text-editor.png|300px|thumb|right|How to switch to Blender's built in text editor]]

Alternatively, you can write a full script from a text file and run it. Instead of switching to the Python console mode, just switch to the Blender text editor mode, and press the <code>Run Script</code> button in the top right once you've written or loaded a script. You can also press <code>Alt P</code> as a short cut, but your mouse cursor must be over your code when you press the hotkey.

The Blender text editor has basic line numbers, syntax highlighting, and line wrapping abilities. The output will be to the system console (not to mistake with Blender Python Console). On Mac and Windows, the console may not be visible. 
To make it visible on Windows, go click on <code>Window > Toggle System Console</code>. 
On Mac you need to start Blender from terminal with <code>"/Applications/Blender.app/Contents/MacOS/Blender" -con</code> (path can be different depending on your Blender installation).

If you'd like to access the currently loaded or imported IFC file, there is no need to re-open the file with IfcOpenShell. Instead, you can access it as so:

<syntaxhighlight lang="python">
import bonsai.tool as tool
ifc = tool.Ifc.get()
</syntaxhighlight>

{{BlenderBIM_Add-on_Documentation}}
[[Category:Blender]] [[Category:BlenderBIM Add-on]]