Specialization kata · BIM-003

Check a model against IDS requirements

Read a practice IDS file, run it against the sample with IfcTester, and explain the one requirement that fails.

Draft. This recipe is a draft. Its checks may not have been run, and it can change.

Status
Draft
Kata ID
BIM-003
Maintainer
BIM pathway maintainer
Last verified
Not available. Built and checked by the Dojo maintainers and CI; no independent or professional review yet.
Found a problem?
Report it

The outcome

An IDS report for the sample, and a one-paragraph explanation of each failure in plain words.

For: Learners who finished BIM-002.

Done when

  • The IDS file opens with XML schema validation on
  • Your report matches /examples/bim-pathway/generated/original/ids.json
  • You explain why REQ-03 fails even though FireRating exists in the file
  • You state separately what the schema check and the geometry check found, without merging them into one score

You make: Ids report. Outcome: Check information requirements.

Showcase and provenance

The Dojo’s worked example, made by the maintainers rather than by a learner: buildingSMART’s wall-with-opening-and-window sample, a practice IDS, an edited copy and every check result, computed by the site’s CI.

See the showcase

Made by
buildingSMART International (sample model); Developer Dojo maintainers (IDS, edit and checks)
Source
buildingSMART Certification-datasets, pinned commit 80d976a9b193a26a8e928c3e79bff67af1de68a8; checks from /examples/bim-pathway/tools/bim_pathway.py
Licence
Sample model CC BY 4.0 (buildingSMART International); IDS files, script and outputs MIT
Date

Brief, inputs and constraints

Inputs

  • wall-with-opening-and-window.ifc. Source: buildingsmart/ifc-wall-example (copy on /examples/bim-pathway/). Terms: CC BY 4.0, buildingSMART International.
  • practice-requirements.ids. Source: /examples/bim-pathway/practice-requirements.ids. Terms: Dojo content, MIT licence. Invented requirements for practice..

Constraints

  • Licensed sample only
  • No paid tools
  • Offline capable

Capabilities practised

  • Validate information
  • Verify evidence

Stack, permissions and cost

Stack components with version, permissions and cost
PartComponentVersionPermissionsCost
ToolIfcOpenShell0.9.0.post1Reads the IFC copy you open; writes only the file your script savesFree (LGPL-3.0-or-later)
ToolIfcTester0.9.0Reads the IDS file and the IFC copy; writes only the report you ask forFree (LGPL-3.0-or-later)
RuntimePython in a virtual environment3.12Runs on your own machine; network only to install the pinned packagesFree
DatabuildingSMART wall-with-opening-and-window sample (IFC4)Certification-datasets commit 80d976a, SHA-256 73b0e45d…097832Read a copy; the licence allows changes with creditFree (CC BY 4.0)
HarnessAny chat assistant or coding agentNot available. Not fixed; an assistant may draft a script or explain an entity, and every claim it makes is checked against the fileReads what you paste in; if it runs commands, give it only the copy of the modelNot available. Depends on your assistant and plan; not measured

Stack recipes

  • Ifcopenshell and python

Why this stack

IfcOpenShell and IfcTester are open source, run offline once installed and implement the buildingSMART IFC and IDS standards, so every learner can rerun the same checks on the same file and get the same output. CI runs the identical script on every pipeline.

Alternatives

  • A desktop BIM authoring tool (for example Bonsai for Blender, or a commercial tool). Shows the model visually and edits it by hand, but results depend on the tool and its export settings. Not tried for this pathway. Not tested for this recipe.
  • A web IFC viewer. Lets you look at the geometry in a browser without installing anything, but a viewer is not a validator. No viewer was checked for this pathway. Not tested for this recipe.

Agents and review gates

  1. Explaining assistant

    Translates one IDS specification into plain words.

    Review gate: You compare its wording with the XML facet by facet.

  2. Learner as reviewer

    Runs IfcTester and reads the failure.

    Depends on: Explaining assistant

    Review gate: A failure is explained only when you can point to the element and the property in the file.

Setup and smoke test

  1. Create a virtual environment with Python 3.12: python3.12 -m venv .venv
  2. Install the pinned packages: .venv/bin/pip install --require-hashes -r /examples/bim-pathway/tools/requirements.txt, or pip install ifcopenshell==0.9.0.post1 ifctester==0.9.0
  3. Download the sample model and the practice IDS from /katas/bim-pathway into a new, empty folder. Work on copies; keep the original.

Sign-in and access: None. Nothing here needs an account.

Smoke test

Do
Run: .venv/bin/python -I -c "import ifcopenshell; print(ifcopenshell.open('wall-with-opening-and-window.ifc').schema)"
Expect
IFC4
Result
Passed /examples/bim-pathway/generated/original/inspection.json (schema)

Prompts

Copy a prompt into the assistant you use. Replace anything that does not fit your situation, and never paste private or personal data you are not allowed to share.

Read an IDS specification aloud

Check you read applicability and requirements the right way round.

You can also select and copy the text.

Practice exercise

Information Delivery Specification (IDS). From Information Delivery Specification (IDS) (buildingSMART International).

Terms: buildingSMART publishes the standard openly; read the repository's own licence before you reuse its files.

Execution and handoffs

  1. Learner: Read the six specifications in practice-requirements.ids.
  2. Explaining assistant: Restates each one in plain words. Hand-off: You check the restatement against the XML.
  3. Learner: Run IfcTester (python -m ifctester practice-requirements.ids wall-with-opening-and-window.ifc, or the pathway script) and compare with the CI report.

Tests, failures and corrections

Checks with expected and recorded results
CheckExpectedResultEvidence
Validate the sample against the practice IDS with IfcTester 0.9.05 passed, 1 failed. REQ-03 fails on the wall (#45) because Pset_WallCommon.FireRating holds an empty label, which IfcTester reports as a missing propertyPassed on /examples/bim-pathway/generated/original/ids.json and /examples/bim-pathway/generated/original/ids-ifctester.json, recomputed by CI on every pipeline
Check the sample against the IFC4 schema and build its geometry, as separate checksNo schema issues; all three shapes build (wall 1.5 m3 after the opening is cut)Passed on /examples/bim-pathway/generated/original/schema.json and /examples/bim-pathway/generated/original/geometry.json
Your IDS report matches the CI outputSame results per specificationNot runNot run, so there is no evidence. This is not a pass.

Failures and corrections

  • Observed: IfcTester says the property set does not contain FireRating, but the file has it Correction: The property exists with an empty IfcLabel. IfcTester 0.9.0 treats an empty value as missing, which is what REQ-03 needs to catch.

Adapt it

  • Make REQ-03 optional (cardinality optional) The wall then passes while the label stays empty. Decide with the brief's author whether that is what they meant.

Unseen Randori

See the BIM Randori recipe, BIM-R01.

Constraints

  • Report information, schema and geometry separately

How it is judged: Each outcome is reported on its own.

More Randori challenges

Belt evidence

Belt stages are proposed practice stages, not issued credentials. Evidence below is what a reviewer would look for; it is not a record that anyone has shown it.

Evidence a reviewer looks for

  • An IDS report for the sample that matches the Dojo's CI output (5 pass, REQ-03 fails) (Automated check, against Information Delivery Specification (IDS))
  • The learner states, for the failed requirement, which element fails, which property and why (Self-check, against Information Delivery Specification (IDS))

Belt criteria

  • Practice: Runs the practice IDS, gets 5 passed and 1 failed, and explains REQ-03
  • Adapt: Writes one new IDS specification and shows it pass and fail on purpose
  • Demonstrate: Explains to a reviewer what an IDS pass does and does not prove, separately from schema and geometry

See the belt stages

Connections

Used by
No other kata names this one as a foundation yet.
Professional review
Required. Any real use of this outcome needs independent validation and any approval required from a qualified professional. Practice here does not grant a licence.

Standards in scope

  • Industry Foundation Classes (IFC), IFC4 ADD2 TC1 (ISO 16739-1:2018), as declared by the sample file. Applies to: The buildingSMART practice sample and copies of it only. Review scope: What the listed checks test: the schema the file declares, its entities and relationships, and the IDS requirements. No claim about any real building.
  • Information Delivery Specification (IDS), 1.0. Applies to: The practice requirements and Randori cards written for this pathway. Review scope: Whether each requirement in the IDS file holds for each applicable element. The requirements are invented for practice; meeting them says nothing about a real project's requirements.

Sources

  • buildingSMART International

    Information Delivery Specification (IDS) (opens the publisher's site in a new tab)

    • Free
    • Docs
    • Intermediate

    buildingSMART's computer-readable XML standard for stating which information an IFC model must contain: the repository holds the schema (version 1.0 is published at standards.buildingsmart.org/IDS/1.0/ids.xsd), the user manual and the implementers' documentation. An IDS check covers information requirements only; it is not a geometry check, a design review or an approval.

  • IfcOpenShell

    IfcTester (opens the publisher's site in a new tab)

    • Free
    • Docs
    • Intermediate

    Documentation for IfcTester, IfcOpenShell's library and command-line tool that reads IDS files and checks IFC models against them, with console, JSON, HTML, ODS and BCF reports. LGPL-3.0-or-later.

Maintenance and caveats

Review cadence: Every six months, when IfcOpenShell or IfcTester releases a new minor version, or when buildingSMART revises IFC or IDS

  • This recipe is a draft: the example was built and checked by the Dojo maintainers and CI, and no learner has run it yet.
  • The sample is a three-element test file, not a building. Nothing learned from it is evidence about a real project.
  • No model, property value or check result here is professionally reviewed or approved. A real project needs the qualified people its contract and jurisdiction name.
  • Information (IDS), schema and geometry checks are separate outcomes. Passing one says nothing about the others, and there is no combined score.
  • The practice IDS is invented. A real project takes its IDS from its own client or exchange requirements.
  • IfcTester 0.9.0 does not keep the IDS identifier attribute in its reports; the pathway script reads it from the XML.

All kata recipes · Back to katas