Skip to main content

Python Tool to create IDS (Information delivery specification) files

Project description

idstool

Python Tool to create IDS (Information delivery specification) files for openBIM workflows.

Currently built on IDS version 0.9.6

Example

An example on how to use this library to create an IDS:

import idstool as ids

spec1 = ids.Specification(name='Wall Specifications', ifc_version='IFC4',
                          applicability=ids.Applicability(facets=[ids.EntityFacet(ifc_class='IfcWall')]),
                          requirement=ids.Requirement(facets=[ids.AttributeFacet(name='Name')]))

spec2 = ids.Specification(name='Hackathon Pset', ifc_version='IFC4',
                          applicability=ids.Applicability(facets=[ids.EntityFacet(ifc_class='IfcWall')]),
                          requirement=ids.Requirement(facets=[ids.PropertyFacet(property_set='Hackathon2024', property_name='AEC_Hack', datatype='IFCTEXT')]))

ids_data = ids.InformationDeliverySpecification(
    title="AEC Hackathon Test IDS",
    version="0.1",
    purpose="Testing",
    specifications=[spec1, spec3]
)

ids.IDSSerializer.save_ids(filepath='example_ids', ids=ids_data)

Limitations

  • This README is still under construction =)
  • Currently not all metadata for IDS files are actually written to file. author and date are skipped

Next Steps

The following features will be added next:

  • Utility functions to easily create simple Applicabilities and Requirements

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

idstool-0.1.3.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

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

idstool-0.1.3-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file idstool-0.1.3.tar.gz.

File metadata

  • Download URL: idstool-0.1.3.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.5

File hashes

Hashes for idstool-0.1.3.tar.gz
Algorithm Hash digest
SHA256 6bfdb00012c935b4ccd935a390fadf3f97522a4d6572102c181169a29a5a6101
MD5 f6045812c44b4fd9bd5d43aa4263d16c
BLAKE2b-256 0b9d0a0d329cd31aa0214cd7925caa90a91de8af0e60921f21a58dc95556fafa

See more details on using hashes here.

File details

Details for the file idstool-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: idstool-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.5

File hashes

Hashes for idstool-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 feaa6ec68abdf3424e251652de5f7f84436f798f18769b450bc4b161585d861b
MD5 61b5b84028399c2be0c23dd1b5235089
BLAKE2b-256 2de6c342ff098dcf8cfce48a363b9ce3a0c620e97ac5a66939b1619e880e5b9a

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