ifc-anywidget 0.5.0

IFC viewer AnyWidget using That Open Company Open BIM Components

IFC viewer anywidget

Display an IFC model in your Jupyter/marimo notebook.

Uses anywidget and IFCLite

• Displays an ifcopenshell.file object using the IFCLite viewer
• returns the list of GlobalIds of the selected elements via selected_guids attribute

install

If you're using marimo in sandbox mode, skip this part. Marimo will detect the import and ask you to install the package.

If you're running JupyterLab, add the library to your environment:

pip install ifc-anywidget

if you're using uv (highly recommended), run

uv add ifc-anywidget

usage

from ifc_anywidget import IfcViewer
import ifcopenshell

model = ifcopenshell.open("my-awesome-model.ifc")
viewer = IfcViewer(ifc_model=model) # for marimo: wrap it with mo.ui.anywidget()
viewer

IfcVewer supports the following attributes:

• ifc_model: the ifcopenshell.file instance to show
• hide_sites: whether to hide IfcSite elements (default: False)
• hide_spaces: whether to hide IfcSpace elements (default: True)
• hide_spatial_zones: whether to hide IfcSpatialZone elements (default: True)
• hide_opening_elements: whether to hide IfcOpeningElement elements (default: True)
• hide_annotations: whether to hide IfcAnnotation elements (default: True)
• hide_grids: whether to hide IfcGrid elements (default: True)

Using marimo, you can set these attributes reactively (for instance, with a toggle widget).
Take a look at the tests/test_marimo.py notebook to see an example.

development

Clone the repo and run uv sync to initialize the environment with all the needed dependencies.

For testing within marimo, just run

uv run marimo edit tests/test_marimo.py

For testing within jupyter lab, run

uv run jupyter lab tests/test_jupyter.ipynb