Skip to main content

IFC model auditing tool with support for IDS

Project description

ifctester

With IfcTester, you can author and read Information Delivery Specification - IDS - files and validate your IFC models against IDS to see if your model is compliant. After the audit, you can generate reports in console, as a web page, JSON or BCF file. It works from the command line, as a web app, or as a library.

How to use it

Command line use

.. code-block:: bash

# run console reporter
python -m ifctester example.ids example.ifc
python -m ifctester example.ids example.ifc -r Html -o report.html

Available flags:

  • -r / --reporter: The reporting method to view audit results. Availabe reporters: Console, Txt, Json, Html, Ods, Bcf
  • --no-color: Disable colour output (supported by Console reporting).
  • --excel-safe: Make sure exported ODS is safely exported for Excel.
  • -o / --output: Output file (supported for all types of reporting except Console).

Code example

import ifcopenshell
from ifctester import ids, reporter


# create new IDS
my_ids = ids.Ids(title="My IDS")

# add specification to it
my_spec = ids.Specification(name="My first specification")
my_spec.applicability.append(ids.Entity(name="IFCWALL"))
property = ids.Property(
    baseName="IsExternal",
    value="TRUE", 
    propertySet="Pset_WallCommon", 
    dataType="IfcBoolean",
    uri="https://identifier.buildingsmart.org/uri/.../prop/LoadBearing", 
    instructions="Walls need to be load bearing.",
    cardinality="required")
my_spec.requirements.append(property)
my_ids.specifications.append(my_spec)

# Save such IDS to file
result = my_ids.to_xml("SampleIDS.xml")

# open  IFC file:
my_ifc = ifcopenshell.open("MyIfcModel.ifc")

# validate IFC model against IDS requirements:
my_ids.validate(my_ifc)

# show results:
reporter.Console(my_ids).report()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ifctester-0.7.10.tar.gz (36.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ifctester-0.7.10-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file ifctester-0.7.10.tar.gz.

File metadata

  • Download URL: ifctester-0.7.10.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for ifctester-0.7.10.tar.gz
Algorithm Hash digest
SHA256 ae65725eb7e0fda29c52711df425ad75302dd3078e33fd4d0e7f02f4c5756e77
MD5 5ac6b9205569cb2143bbff803ab0146c
BLAKE2b-256 f62608ec680eb8300568cabb57c48adfe4db33f68d0b59245f0e7d7ae9a755f3

See more details on using hashes here.

File details

Details for the file ifctester-0.7.10-py3-none-any.whl.

File metadata

  • Download URL: ifctester-0.7.10-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for ifctester-0.7.10-py3-none-any.whl
Algorithm Hash digest
SHA256 2e131f329250abbedc979446f03530339f2ba2474981d616a3889ced5daa4547
MD5 36bf5b7b063c3d7ce1b8bbc0134642ba
BLAKE2b-256 f89233379462983eab2122717ded2c734c2b5aeef35cf3d78d1a91c9baf0201b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page