Specialization kata · BIM-004

Change the model and check it again

Fix the failed requirement with an IfcOpenShell edit, keep every GlobalId, then rerun the IDS, schema and geometry checks on the edited copy.

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

Status
Draft
Kata ID
BIM-004
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 edited copy of the sample that meets every practice requirement, with a change record and fresh checks.

For: Learners who finished BIM-003.

Done when

  • The edited copy changes Pset_WallCommon.FireRating on the wall and nothing else
  • Every GlobalId in the original is still in the copy
  • The IDS check gives 6 passed, 0 failed
  • The schema check and the geometry check are rerun and reported on their own
  • The change record says the label is a practice placeholder, not a fire assessment

You make: Edited model, Ids report. Outcome: Revise and revalidate model.

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. Your edited copy must credit the source and say it was changed..
  • practice-requirements.ids. Source: /examples/bim-pathway/practice-requirements.ids. Terms: Dojo content, MIT licence.

Constraints

  • Licensed sample only
  • No paid tools
  • Offline capable

Capabilities practised

  • Edit model
  • Validate information

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. Coding agent

    Drafts the edit with ifcopenshell.api and the commands to rerun the checks.

    Review gate: It works on a copy, and you read the diff of properties before you accept it.

  2. Learner as reviewer

    Reruns all three checks and writes the change record.

    Depends on: Coding agent

    Review gate: The record names what changed, the checks and their results, and who would have to approve a real change.

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.

Ask for a scoped edit

Keep an agent's change small and checkable.

You can also select and copy the text.

Practice exercise

IfcTester. From IfcTester (IfcOpenShell).

Terms: Documentation under the IfcOpenShell project's terms; the software is LGPL-3.0-or-later.

Execution and handoffs

  1. Coding agent: Writes the edit script and runs it on a copy. Hand-off: You read the property diff.
  2. Learner: Rerun the IDS, schema and geometry checks on the edited copy and compare with the CI output.
  3. Learner: Write the change record.

Tests, failures and corrections

Checks with expected and recorded results
CheckExpectedResultEvidence
Apply the pathway edit and compare propertiesOne change, Pset_WallCommon.FireRating onPassed on /examples/bim-pathway/generated/change.json and /examples/bim-pathway/generated/wall-with-opening-and-window.edited.ifc, rebuilt byte for byte by CI on every pipeline
Rerun the IDS check on the edited copy6 passed, 0 failedPassed on /examples/bim-pathway/generated/edited/ids.json
Rerun the schema and geometry checks on the edited copyNo schema issues; the three shapes build with the same volumes as beforePassed on /examples/bim-pathway/generated/edited/schema.json and /examples/bim-pathway/generated/edited/geometry.json
Your own edited copy passes the same three checksSame results; your copy may differ in its headerNot runNot run, so there is no evidence. This is not a pass.

Failures and corrections

  • Observed: The edited file differs from the original on almost every line Correction: IfcOpenShell rewrites the file in its own layout and drops comments. Compare entities and properties, not text lines; change.json is that comparison.

Adapt it

  • Fill AcousticRating as well No requirement asks for it, so the IDS result does not change. Say why you changed it, or leave it.

Unseen Randori

See the BIM Randori recipe, BIM-R01.

Constraints

  • One requirement, one scoped change

How it is judged: The property diff shows only the intended change.

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 edited IFC copy with exactly one changed property and every GlobalId kept, matching the Dojo's CI output (Automated check, against Industry Foundation Classes (IFC))
  • The IDS, schema and geometry checks rerun on the edited copy, reported separately (Automated check, against Information Delivery Specification (IDS), Industry Foundation Classes (IFC))

Belt criteria

  • Practice: Reproduces the edit and gets 6 of 6 IDS passes, no schema issues and all shapes built
  • Adapt: Makes a different edit and proves with a diff of properties that nothing else changed
  • Demonstrate: Writes a short change record that a model author could review, naming what was checked and who must still approve it

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

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 label "REI 60" is a placeholder chosen to satisfy a practice pattern. It is not a fire rating; only a qualified fire engineer can set one for a real wall.
  • The edited file is an adaptation of buildingSMART’s CC BY 4.0 sample. Its header says it was changed by the Dojo.

All kata recipes · Back to katas