Skip to main content

openbim-ifc (Python)

Read, edit and write IFC STEP files from Python. A thin binding over the openbim-ifc Rust crates: one abi3 wheel for CPython 3.9 and later.

pip install openbim-ifc

Documentation: Python guide · source and issues

from openbim_ifc import IfcModel, Text

with open("model.ifc", "rb") as f:
    model = IfcModel.parse(f.read())

print(model.schema, len(model))
for id in model.ids_of_type_including_subtypes("IfcWall"):
    print(id, model.attribute_by_name(id, "Name"))  # e.g. Text('Wall')

model.set_attribute_by_name(id, "Name", Text("Renamed"))
with open("out.ifc", "wb") as f:
    f.write(model.write())

Names resolve against the release the file's header declares, inherited attributes included; attribute_names(id) lists them in slot order with their optional and derived flags. attribute(id, index) and set_attribute(id, index, value) address a slot by position.

Entities, plain values, property sets

A pure-Python layer over those calls reads like IfcOpenShell:

import openbim_ifc
model = openbim_ifc.open("model.ifc")
for wall in model.by_type("IfcWall"):          # subtypes included
    print(wall.Name, wall.psets["Pset_WallCommon"]["IsExternal"])
wall.Name = "Renamed"                           # coerced: IfcLabel, written 'Renamed'
frame = model.to_dataframe("IfcWall")           # pip install 'openbim-ifc[pandas]'

Reads give plain Python values; a typed wrapper's type name, * and .U. (both None) and the text/enum distinction are lost there, and wall.raw("Name") keeps them. wall.psets and wall.qtos are read-only mappings with type values inherited; write with wall.set_property(...). The package is typed (py.typed) and checked with mypy --strict.

Values

Attribute values are frozen dataclasses, one per STEP form: Null ($), Derived (*), Bool, Unknown (.U.), Integer, Real, Text, Binary, Enum, Ref (#42), List, and Typed (IFCLENGTHMEASURE(2.5)). They keep every distinction IFC makes, so a file read and written back through Python is unchanged.

The calls that take these values write them exactly. A by-name write of a bare Python value (wall.Name = "x", set_attribute_by_name_plain) is coerced against the attribute's declared type instead: "x" becomes a label or an enumeration item, 3 an Integer or a Real, as the attribute declares; a value the declaration cannot settle, such as a string several SELECT members take, raises ambiguous-value rather than guess.

Errors

Every failure raises IfcError with a stable code (parse, missing-entity, invalid-value, unsupported-schema, ...; the Python guide lists them all). The codes are shared with the JavaScript and C bindings; a code is never renamed or reused.

Threads

parse releases the GIL while it reads. A model can be passed between threads; the GIL serialises calls on it.

Scope

The record model -- entities, attributes, the STEP codec, exact and subtype queries -- plus lenient reads (ParseOptions), the STEP header, validation, ifcXML, the reachability lint and the read-only domain views (property sets and quantities, the spatial tree, classification, materials, systems, cost, georeferencing; #123), each as frozen dataclasses, writing property sets and quantities as one checked transaction (set_properties), the Pythonic layer over them (#332), and creating entities as one checked transaction (author with AuthorOps: entities by type and named attributes, the spatial structure, placed, contained and typed products, removal with relationships; #330), and each product's world placement and Body (product_placements; meshes from a --features mesh wheel, #328; the exact Body as Axiolid's geometry graph, product_geometry, from a --features graph wheel, #367).

Build from source

uv venv && . .venv/bin/activate
uv pip install maturin
maturin develop --release     # or: scripts/check-python.sh to build + test

Faster reading (opt-in)

maturin build --release --features rusty_alloc

Uses the pure-Rust rusty_alloc allocator for the extension's own memory: reading STEP into a model takes 18-35% less CPU time on seven real IFC files, at 1-7% less peak memory (#49). Python's own allocator is not replaced. Off by default because a global allocator is a build-time choice; the version is pinned exactly.

Metadata

Release files for openbim-ifc 0.14.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openbim-ifc 0.14.2
File Size Uploaded Provenance Actions
openbim_ifc-0.14.2.tar.gz 4.9 MB With provenance Details for openbim_ifc-0.14.2.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for openbim-ifc 0.14.2
File Actions
openbim_ifc-0.14.2-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details for openbim_ifc-0.14.2-cp39-abi3-win_amd64.whl
openbim_ifc-0.14.2-cp39-abi3-manylinux_2_28_x86_64.whl CPython 3.9 abi3 Linux glibc 2.28+ x86-64 Details for openbim_ifc-0.14.2-cp39-abi3-manylinux_2_28_x86_64.whl
openbim_ifc-0.14.2-cp39-abi3-manylinux_2_28_aarch64.whl CPython 3.9 abi3 Linux glibc 2.28+ ARM64 Details for openbim_ifc-0.14.2-cp39-abi3-manylinux_2_28_aarch64.whl
openbim_ifc-0.14.2-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl CPython 3.9 abi3 macOS 10.12+ universal2 (ARM64, x86-64), macOS 10.12+ x86-64, macOS 11.0+ ARM64 Details for openbim_ifc-0.14.2-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl

Total release size: 23.9 MB

Release files / openbim_ifc-0.14.2.tar.gz

Download URL openbim_ifc-0.14.2.tar.gz
Size 4.9 MB
Tags Source
SHA-256 checksum
How to use checksums
be535451d719ca9ac52ab7a4f6d480802a2f9971b1f49b03c5192947463e879b
BLAKE2b-256 checksum
How to use checksums
9d8a5a6dbc81b531872e787c97ab0eeacacb2e09093b2abdd437040346c37147
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Release files / openbim_ifc-0.14.2-cp39-abi3-win_amd64.whl

Download URL openbim_ifc-0.14.2-cp39-abi3-win_amd64.whl
Size 3.9 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
7e9d252f7597f885ee6b6ee2b406a886e92d9d1dffe733cfcc0f3b6a9c118a82
BLAKE2b-256 checksum
How to use checksums
c7cd4c80fa734e4419bdb0aee882f271233508a8d76f380145a24ea75fd84f7e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Release files / openbim_ifc-0.14.2-cp39-abi3-manylinux_2_28_x86_64.whl

Download URL openbim_ifc-0.14.2-cp39-abi3-manylinux_2_28_x86_64.whl
Size 3.9 MB
Tags CPython 3.9 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
307c26b3a75ec4176c07b34345909324b4b3bd8ec022cdfcfe0880a60f1d25ed
BLAKE2b-256 checksum
How to use checksums
80118eed2fbcbfc6a2d4a02ea231e53d22f299b4499611a1c73a2d567aa8c31f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Release files / openbim_ifc-0.14.2-cp39-abi3-manylinux_2_28_aarch64.whl

Download URL openbim_ifc-0.14.2-cp39-abi3-manylinux_2_28_aarch64.whl
Size 3.7 MB
Tags CPython 3.9 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
983f18323087ba60b90ef050f0e1f799b941f5cb96df3dae3f28b8ae6b6edd33
BLAKE2b-256 checksum
How to use checksums
910238e101cf417478bdd950b7c1c5bb1c4ed682d534e7ab227306975aa1ffd7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Release files / openbim_ifc-0.14.2-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl

Download URL openbim_ifc-0.14.2-cp39-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Size 7.4 MB
Tags CPython 3.9 abi3 macOS 10.12+ universal2 (ARM64, x86-64) macOS 10.12+ x86-64 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
a05293d912b30654a00b99c66148cd524d5709672bdf9e614c5eec0751b7c910
BLAKE2b-256 checksum
How to use checksums
d544a7a2ae36114a32d5e6e7832805192a1d806d3c9612992178e5b10062eee3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

Security for openbim-ifc 0.14.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 5 files in this release have been uploaded with provenance metadata.

Select from 5 files

Attestation for openbim_ifc-0.14.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 28, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page