ifcfast 0.1.0__tar.gz

ifcfast-0.1.0/Cargo.lock

@@ -0,0 +1,239 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "autocfg"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
+
+[[package]]
+name = "earcutr"
+version = "0.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79127ed59a85d7687c409e9978547cffb7dc79675355ed22da6b66fd5f6ead01"
+dependencies = [
+ "itertools",
+ "num-traits",
+]
+
+[[package]]
+name = "either"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719"
+
+[[package]]
+name = "glam"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8babf46d4c1c9d92deac9f7be466f76dfc4482b6452fc5024b5e8daf6ffeb3ee"
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "ifcfast-core"
+version = "0.1.0"
+dependencies = [
+ "earcutr",
+ "glam",
+ "memchr",
+ "memmap2",
+ "pyo3",
+]
+
+[[package]]
+name = "indoc"
+version = "2.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706"
+dependencies = [
+ "rustversion",
+]
+
+[[package]]
+name = "itertools"
+version = "0.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b1c173a5686ce8bfa551b3563d0c2170bf24ca44da99c7ca4bfdab5418c3fe57"
+dependencies = [
+ "either",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.186"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+
+[[package]]
+name = "memchr"
+version = "2.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79"
+
+[[package]]
+name = "memmap2"
+version = "0.9.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "714098028fe011992e1c3962653c96b2d578c4b4bce9036e15ff220319b1e0e3"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "memoffset"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "num-traits"
+version = "0.2.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f402062616ab18202ae8319da13fa4279883a2b8a9d9f83f20dbade813ce1884"
+dependencies = [
+ "cfg-if",
+ "indoc",
+ "libc",
+ "memoffset",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+ "unindent",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b14b5775b5ff446dd1056212d778012cbe8a0fbffd368029fd9e25b514479c38"
+dependencies = [
+ "once_cell",
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ab5bcf04a2cdcbb50c7d6105de943f543f9ed92af55818fd17b660390fc8636"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fd24d897903a9e6d80b968368a34e1525aeb719d568dba8b3d4bfa5dc67d453"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.22.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "36c011a03ba1e50152b4b394b479826cad97e7a21eb52df179cd91ac411cbfbe"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "pyo3-build-config",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.12.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
+
+[[package]]
+name = "unindent"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7264e107f553ccae879d21fbea1d6724ac785e8c3bfc762137959b5802826ef3"

ifcfast-0.1.0/Cargo.toml

@@ -0,0 +1,14 @@
+[workspace]
+members = ["crates/core"]
+resolver = "2"
+
+[workspace.package]
+version = "0.1.0"
+edition = "2021"
+license = "MIT"
+repository = "https://github.com/EdvardGK/ifcfast"
+
+[profile.release]
+lto = "thin"
+codegen-units = 1
+opt-level = 3

ifcfast-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Edvard Granskogen Kjorstad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ifcfast-0.1.0/PKG-INFO

@@ -0,0 +1,292 @@
+Metadata-Version: 2.4
+Name: ifcfast
+Version: 0.1.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Scientific/Engineering
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: pyarrow>=14.0.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: pytest>=7.4.0 ; extra == 'dev'
+Requires-Dist: openpyxl>=3.1.0 ; extra == 'dev'
+Requires-Dist: ifcopenshell>=0.8.0 ; extra == 'dev'
+Provides-Extra: dev
+License-File: LICENSE
+Summary: Fast native IFC parsing, data extraction, and geometric analytics
+Keywords: IFC,BIM,QTO,parser,rust
+Author-email: Edvard Granskogen Kjorstad <ed.subscript@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/EdvardGK/ifcfast
+Project-URL: Issues, https://github.com/EdvardGK/ifcfast/issues
+
+# ifcfast
+
+Fast native IFC parsing, data extraction and geometric analytics. Python
+on top, Rust underneath, no `ifcopenshell.open()` on the hot path.
+
+Aimed at the "open an IFC, get the data out, run QTO / quality
+queries" workflow. Tier-1 parse is byte-identical to `ifcopenshell` and
+~20-27× faster on production files.
+
+> `ifcfast` was extracted on 2026-05-13 from the
+> [`EdvardGK/ifc-workbench`](https://github.com/EdvardGK/ifc-workbench)
+> scratch repo. See [`docs/history/origin.md`](docs/history/origin.md)
+> for the trail back and what was renamed.
+
+## What it gives you
+
+| layer | format | typical latency on 200 MB IFC |
+|---|---|---|
+| Products (GUID, type, name, storey, parent, tag) | dict of parallel lists | tier-1 cold: 0.5–2 s |
+| Property sets | long-format `pandas.DataFrame` | 137 ms |
+| Element quantities | long-format `pandas.DataFrame` | 90 ms |
+| Materials (incl. layer sets) | long-format `pandas.DataFrame` | 27 ms |
+| Classifications | long-format `pandas.DataFrame` | 17 ms |
+| All data layers (shared scan) | bundle | 1.3 s |
+| Triangle meshes (extrusion / mapped / face sets / BREP) | OBJ / glTF / CSV | 2.6 s |
+| Placement-vs-mesh drift report | `pandas.DataFrame` | 322 ms |
+| Parquet cache (all of the above) | parquet | 65 ms hot reload |
+
+End-to-end cold parse of a 200 MB IFC: under 5 s. Hot reload from cache:
+under 100 ms. Memory peak: under 1 GB resident (mmap-based).
+
+Audited at **234,144 products across 5 authoring tools** (Tekla,
+Archicad, Revit IFC4, Revit IFC2X3, MagiCAD, BSProLib) with byte-level
+parity vs `ifcopenshell`. See
+[`docs/history/audit/`](docs/history/audit/).
+
+## Install
+
+Needs Rust 1.95+ and Python 3.10+.
+
+```bash
+pip install maturin
+maturin develop --release      # builds the Rust extension, ~30 s first time
+```
+
+For production: `maturin build --release` produces a wheel.
+
+## Quick start
+
+```python
+import ifcfast
+
+m = ifcfast.open("model.ifc")
+print(len(m), "products,", len(m.storeys), "storeys")
+print(m.authoring_app, "→", m.schema)
+
+walls = list(m.filter(entity="IfcWall"))
+
+# Long-format data layers (pandas DataFrames, loaded lazily).
+m.psets             # 63k+ rows on a 200 MB Archicad file
+m.quantities        # author-supplied Qto_*BaseQuantities
+m.materials         # (guid, role, layer, name, thickness, category)
+m.classifications   # NS 3451 / Uniformat / OmniClass references
+m.drift             # placement-vs-mesh drift report
+
+# Standard QTO query — external walls.
+external_walls = m.psets[
+    (m.psets.pset_name == "Pset_WallCommon")
+    & (m.psets.prop_name == "IsExternal")
+    & (m.psets.value == "True")
+].guid.unique()
+
+# Quality gate — placement bugs.
+suspect = m.drift[m.drift.drift_severity == "error"]
+```
+
+The same model can be re-opened cheaply — the second `ifcfast.open(...)`
+returns from the parquet cache in tens of milliseconds.
+
+## CLI
+
+```bash
+ifcfast index   model.ifc           # tier-1 parse + counts
+ifcfast extract model.ifc           # extract data layers (writes cache)
+ifcfast drift   model.ifc --top 20  # placement / mesh drift report
+ifcfast cache   model.ifc           # inspect cache for a file
+```
+
+The Rust binary `ifcfast-mesh` writes OBJ / glTF / CSV directly:
+
+```bash
+cargo build --release --bin ifcfast-mesh --no-default-features --features mesh
+./target/release/ifcfast-mesh model.ifc model.glb
+```
+
+## Cache
+
+Parquet files live under `~/.cache/ifcfast/<cache_key>/`, where
+`cache_key` is `sha256(file_size + first 4 MB + last 4 MB)` truncated.
+Any edit to the IFC invalidates the entry automatically.
+
+Override with the `IFCFAST_CACHE` environment variable, e.g.
+`IFCFAST_CACHE=/srv/cache ifcfast extract model.ifc`.
+
+Disk footprint on a 200 MB Archicad IFC: **2.4 MB total** zstd-compressed.
+
+## Data schemas
+
+All extractors return long-format (one row per fact, no nested fields).
+Easy to join, easy to filter, easy to flatten to Excel.
+
+**Missing values:** string columns use pandas `StringDtype` with `nan`
+as the NULL sentinel (chosen for memory and pyarrow round-trip).
+Cells corresponding to a STEP `$` field hold `float('nan')`, **not**
+Python `None`. Use `.isna()` to test, not `== None` or `is None`:
+
+```python
+m.classifications[m.classifications.identification.isna()]   # correct
+m.classifications[m.classifications.identification == None]  # always False
+[r for r in m.classifications.itertuples() if r.identification is None]  # always False
+```
+
+If you're cross-checking against `ifcopenshell` (which returns `None`),
+normalise NaN→None on the comparison side.
+
+
+### psets
+
+| column | type | description |
+|---|---|---|
+| `guid` | str | `IfcProduct.GlobalId` |
+| `pset_name` | str | e.g. `Pset_WallCommon` |
+| `prop_name` | str | e.g. `IsExternal` |
+| `value` | str \| None | booleans normalised to `True` / `False` / `UNKNOWN` |
+| `value_type` | str \| None | `IfcBoolean`, `IfcText`, `IfcReal`, … |
+
+### quantities
+
+| column | type | description |
+|---|---|---|
+| `guid` | str | `IfcProduct.GlobalId` |
+| `qto_name` | str | e.g. `Qto_WallBaseQuantities` |
+| `quantity_name` | str | e.g. `NetVolume`, `GrossArea`, `Length` |
+| `value` | str \| None | numeric value as string |
+| `quantity_type` | str | `Area` / `Length` / `Volume` / `Count` / `Weight` / `Time` |
+| `unit_step_id` | int \| None | usually None (project default applies) |
+
+### materials
+
+| column | type | description |
+|---|---|---|
+| `guid` | str | `IfcProduct.GlobalId` |
+| `role` | str | `direct` / `list` / `layer` / `unknown` |
+| `layer_index` | int | 0-based for layered materials, `-1` otherwise |
+| `material_name` | str \| None | material label |
+| `layer_thickness_mm` | float \| None | only set for `role="layer"` |
+| `category` | str \| None | IFC4 only |
+
+### classifications
+
+| column | type | description |
+|---|---|---|
+| `guid` | str | `IfcProduct.GlobalId` |
+| `system_name` | str \| None | `NS 3451`, `Uniformat II`, `OmniClass` |
+| `edition` | str \| None | e.g. `2022` |
+| `identification` | str \| None | the actual code |
+| `name` | str \| None | human label |
+| `location` | str \| None | URI to spec (rarely populated) |
+| `source` | str \| None | publisher |
+
+### drift
+
+| column | type | description |
+|---|---|---|
+| `guid`, `entity`, `source` | str | identification |
+| `triangle_count`, `surface_area`, `volume_abs` | int / float | geometric stats |
+| `placement_x/y/z` | float | what `IfcLocalPlacement` says |
+| `centroid_x/y/z` | float | where the mesh AABB centre actually is |
+| `drift_distance` | float | Euclidean distance, mm |
+| `max_extent` | float | largest AABB dimension |
+| `drift_ratio` | float | `drift_distance / max_extent` |
+| `drift_severity` | str | `ok` / `warn` / `error` |
+
+Severity rule: `ok` when `drift_ratio ≤ 2.0` or `drift_distance < 10
+mm`; `error` when `drift_ratio > 10.0` and `drift_distance > 10 mm`.
+
+A 100 m wall placed at one end has ratio 0.5 (legitimate). A 50 mm sensor
+100 m from its placement has ratio 2000 (clear authoring bug).
+
+## Federated floor synthesis
+
+Multi-discipline projects have the same physical floor named differently
+by ARK / RIB / RIV / RIE authors. `ifcfast.federated_floors` clusters by
+elevation across discipline models and applies a project-supplied YAML
+rule.
+
+```yaml
+# examples/projects/lbk-building-c.yaml
+prefix: "C - "
+overrides:
+  Plan U1: Hav
+  C - U1:  Hav
+idempotent_labels: [Hav]
+apply_drop_leading_zero: true
+```
+
+The module is project-agnostic — project tables live in user config.
+
+## Architecture in two paragraphs
+
+The Rust core (`crates/core`) does one byte-level pass over the IFC's
+DATA section using a string-aware STEP tokenizer (memchr-accelerated).
+That pass builds an `EntityTable` — a `step_id → byte_range` map of
+every entity in the file. Each PyO3 entry point (`index_ifc`,
+`extract_psets`, etc.) walks the table once, dispatching on entity type
+and extracting only the fields that layer needs.
+
+The Python cache (`ifcfast.cache`) writes each extractor's output as
+zstd-compressed parquet, keyed by `sha256(size + 4 MB head + 4 MB tail)`
+so any IFC edit invalidates automatically. Hot reads are pure
+pandas / pyarrow — no Rust call needed. There is no `ifcopenshell.open()`
+anywhere in the data path; `ifcopenshell` is an *optional* dev dep used
+only for cross-checking parity in tests.
+
+## What it doesn't do
+
+- Write or modify IFCs. Read-only by construction.
+- Schema validation. Trusts the file's syntax. Use
+  [bsi-validator](https://github.com/buildingSMART/IFC) for conformance.
+- Tessellate `IfcBooleanClippingResult` (walls with openings render
+  without cutouts — gross volume correct, net volume not).
+- NURBS / advanced BREP geometry. ~0.5% of elements in typical exports.
+- Property variants beyond `IfcPropertySingleValue` —
+  `IfcPropertyEnumeratedValue`, `IfcPropertyListValue`,
+  `IfcPropertyBoundedValue`, `IfcComplexProperty` are skipped. Covers
+  ~90% of psets seen on Revit / Archicad / Tekla / MagiCAD exports.
+
+## Layout
+
+```
+crates/core/         Rust extension (PyO3) — tokenizer, indexer, extractors, mesh
+  src/
+    lib.rs           PyO3 entry points
+    lexer.rs         STEP tokenizer
+    indexer.rs       tier-1 product / storey index
+    entity_table.rs  step_id → byte range lookup
+    extractors/      psets, quantities, materials, classifications
+    mesh/            extrusion, mapped, face sets, BREP, glTF writer
+    bin/             ifcfast-bench, ifcfast-mesh CLIs
+python/ifcfast/      Public Python API
+  __init__.py        ifcfast.open(), Model, header, classify
+  header.py          STEP header reader (tier-0)
+  model.py           Model class + native tier-1 driver
+  cache.py           parquet cache for index + data layers
+  classify.py        element-mode policy (count / measure / linear / skip)
+  federated_floors.py multi-discipline floor synthesiser
+  cli.py             ifcfast CLI
+docs/history/        origin doc + audit issues from ifc-workbench
+examples/projects/   project YAMLs for federated_floors
+tests/               pytest suite
+```
+
+## License
+
+MIT — see [`LICENSE`](LICENSE).
+