Skip to main content

BIMTester

BIMTester lets you specify a set of exchange requirements, and automatically check whether or not BIM data, typically an IFC file, complies with the requirements. You can run it automatically from a server, integrate it to your own application, or use a GUI. It can generate reports in various formats including:

  • HTML
  • JSON
  • XUnit
  • BCF (TODO)
  • Zoom Smart View (Someone needs to check if this works)

Your exchange requirements are written in plain language which you can use to communicate to project teams and include in contracts. Multiple languages are supported. A series of exchange requirement templates are provided to get started, but you can, and are encouraged to, write your own tailored to your project. An example of a requirement looks like this:

Feature: Project setup

In order to view the BIM data
As any interested stakeholder
We need an IFC file

Scenario: Receiving a file
 * IFC data must use the "IFC4" schema

Languages supported include (in alphabetical order):

  • Dutch
  • English
  • French
  • German
  • Italian

If you are not a developer, we highly recommend simply installing an integrated version of BIMTester.

If you are a developer, read on!

Installation

The following packages are required for BIMTester to function:

  • behave
  • pystache
  • ifcopenshell
  • PySide2 (optional: needed for GUI)

The repository does not contain translation files. You can generate them as shown.

cd src/bimtester/locale
pybabel compile -d .

CLI Usage

BIMTester has a command line application. Check it out:

$ python cli.py -h
usage: cli.py [-h] [-a ACTION] [--advanced-arguments ADVANCED_ARGUMENTS] [-c]
              -f FEATURE -i IFC [-p PATH] [-r REPORT] [--lang LANG]

Runs unit tests for BIM data

optional arguments:
  -h, --help            show this help message and exit
  -a ACTION, --action ACTION
                        Action to perform, from run/purge
  --advanced-arguments ADVANCED_ARGUMENTS
                        Specify arguments to Behave
  -c, --console         Show results in the console
  -f FEATURE, --feature FEATURE
                        Specify a feature file to test
  -i IFC, --ifc IFC     Specify a ifc file
  -p PATH, --path PATH  Define a path for use in tests
  -r REPORT, --report REPORT
                        Specify an output file for a HTML report
  --lang LANG           Specify a language

You can turn it into a regular command by symlinking it to your bin folder.

$ ln -s /path/to/bimtester/src/cli.py /usr/local/bin/bimtester
$ bimtester -h

To run a test, we need an IFC to check and a feature file filled with requirements. The feature file is plaintext. Feel free to copy the minimal example above.

# To see output in the console
$ bimtester -i test.ifc -f test.feature -c
# Or, if you want to generate a HTML report
$ bimtester -i test.ifc -f test.feature -r report.html
python ./gui.py

Create a binary out of the Python package

TODO: Check if this works

Unix:

$ pyinstaller --onefile --clean --icon=icon.ico --add-data "features:features" bimtester.py

Windows:

$ pyinstaller --onefile --clean --icon=icon.ico --add-data "features;features" bimtester.py

Metadata

Release files for bimtester 1.0.0

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

Source distribution (sdist)

Source distribution for bimtester 1.0.0
File Size Uploaded Provenance Actions
bimtester-1.0.0.tar.gz 92.0 kB Without provenance Details for bimtester-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bimtester 1.0.0
File Interpreter ABI Platform Actions
bimtester-1.0.0-py3-none-any.whl Python 3 none any Details for bimtester-1.0.0-py3-none-any.whl

Total release size: 223.7 kB

Release files / bimtester-1.0.0.tar.gz

Download URL bimtester-1.0.0.tar.gz
Size 92.0 kB
Tags Source
SHA-256 checksum
How to use checksums
910ee88946e9db18688cab74d5219d90a0516a7a7110dc093fc6d8c592e2573b
BLAKE2b-256 checksum
How to use checksums
960e969969119121dd13118edae6c93bd3ad93575b044c66fa69c18737d9da2c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.11

Release files / bimtester-1.0.0-py3-none-any.whl

Download URL bimtester-1.0.0-py3-none-any.whl
Size 131.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
98f61a18465d74e88f1a2feecb0e551df404067b37942cbd4543af79a8d00383
BLAKE2b-256 checksum
How to use checksums
ea9f7fba72f9a0766d406ece0ac405a30f3161f3758c2cb4efe71cce93e63460
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.11

Security for bimtester 1.0.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

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