Quickstart

This is a short introduction to pyifc. To get more detailed description see API Reference

Installation

Run following commands in your bash:

pip install pyifc

pip install install-ifcopenshell-python

python -m install_ifcopenshell_python

Usage

import pyifc like:

import pyifc

or

from pyifc import <module>

Modules

So far, pyifc contains only one module: pyifc.compress.

pyifc.compress

Compress module provides set of functions responsible for compressing data. What is more, one can also pack .ifc file right after compressing with other functions.

Example:

import ifcopenshell
from pyifc import compress

path = "example_file.ifc"
input_filepath = "example_file_archive_zip.ifc"
output_dir = "."
output_filename = "example_file_compressed.ifc"
archive_filename = "example_file_archive.zip"

# Compress .ifc file
compress.compress(path, output_dir, output_filename)

# Compress .ifc file and write to .zip archive
compress.compress_and_zip(input_filepath, output_dir, archive_filename)