Migrating shaders to builtins to support M1 #2897

Migrated all shaders from geometry shaders to builtins (all geometry data now calculated in python before passing to shader) to make them more reliable and support Metal backend on Mac M1 (tested that it works - both annotations and gizmo).

The current downside is that there is no more custom frag shaders too - meaning we do not support dashed lines in the annotations (currently Hidden and Grid just use a bit less bright annotation color).

.github/workflows/cd.yml

@@ -28,8 +28,8 @@ jobs:
         sudo apt update
         sudo apt-get install --no-install-recommends \
         git cmake gcc g++ libboost-all-dev python3-all-dev swig libpcre3-dev libxml2-dev \
-        liboce-foundation-dev liboce-modeling-dev liboce-ocaf-dev liboce-visualization-dev liboce-ocaf-lite-dev \
-        libhdf5-dev libcgal-dev
+        libocct-foundation-dev libocct-modeling-algorithms-dev libocct-modeling-data-dev libocct-ocaf-dev libocct-visualization-dev libocct-data-exchange-dev \
+        libhdf5-dev libcgal-dev nlohmann-json3-dev
 
     -
       name: ccache
@@ -47,7 +47,7 @@ jobs:
          -DCMAKE_PREFIX_PATH=/usr \
          -DCMAKE_SYSTEM_PREFIX_PATH=/usr \
          -DBUILD_PACKAGE=On \
-         -DOCC_INCLUDE_DIR=/usr/include/oce \
+         -DOCC_INCLUDE_DIR=/usr/include/opencascade \
          -DOCC_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
          -DPYTHON_EXECUTABLE:FILEPATH=/usr/bin/python3 \
          -DPYTHON_INCLUDE_DIR:PATH=/usr/include/python3.8 \
@@ -61,6 +61,8 @@ jobs:
          -DGMP_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
          -DMPFR_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
          -DHDF5_INCLUDE_DIR=/usr/include/hdf5/serial \
+         -DGLTF_SUPPORT=On \
+         -DJSON_INCLUDE_DIR=/usr/include \
          ../cmake
         make -j $(nproc)
         make install

.github/workflows/check_repo_ci_jobs.py

@@ -0,0 +1,104 @@
+import pathlib
+import shutil
+
+import requests
+import zipfile
+import os
+
+# To test this locally, set these environment variables
+REPO_OWNER = os.environ.get("REPO_OWNER", "IfcOpenShell/IfcOpenShell")
+MY_WORKFLOW = os.environ.get("MY_WORKFLOW", "ci-ifcopenshell-conda-daily")
+WORKFLOW_RUN_ID = os.environ.get("WORKFLOW_RUN_ID", None)
+TOKEN = os.environ.get("GITHUB_TOKEN", None)
+# To test this locally create a fine-grained personal access token for this repo with permissions "actions:read"
+# See https://github.com/settings/tokens?type=beta
+
+# This is a list of strings that indicate that a job has stopped abruptly.
+SIGNS_OF_STOPPAGE = [
+    "Error: The operation was canceled.",
+    "fatal error C1060: compiler is out of heap space",
+]
+
+
+def start_request_session():
+    s = requests.Session()
+    headers = {
+        "Accept": "application/vnd.github+json",
+        "X-GitHub-Api-Version": "2022-11-28",
+    }
+    if TOKEN:
+        headers["Authorization"] = f"Bearer {TOKEN}"
+
+    s.headers = headers
+    return s
+
+
+def get_ci_run(repo_name, run_id):
+    url = f"https://api.github.com/repos/{repo_name}/actions/runs/{run_id}"
+    s = start_request_session()
+    response = s.get(url)
+    return response.json()
+
+
+def evaluate_log_file_for_abrupt_stop(log_file):
+    with open(log_file) as f:
+        for i, line in enumerate(f):
+            for sign in SIGNS_OF_STOPPAGE:
+                if sign in line:
+                    print(f"Found sign of abrupt stoppage in [line {i}]: '{sign}'")
+                    return True
+    return False
+
+
+def get_ci_specific_run_specific_failure_details(repo_name, run_id):
+    url = f"https://api.github.com/repos/{repo_name}/actions/runs/{run_id}/attempts/1/logs"
+    s = start_request_session()
+    response = s.get(url)
+
+    # SAVE zip file
+    with open("logs.zip", "wb") as f:
+        f.write(response.content)
+
+    # unzip file
+    with zipfile.ZipFile("logs.zip", "r") as zip_ref:
+        zip_ref.extractall("logs")
+
+    failed_logs = []
+    for file in pathlib.Path("logs").iterdir():
+        if file.is_dir():
+            continue
+
+        if evaluate_log_file_for_abrupt_stop(file):
+            failed_logs.append(file)
+
+    return failed_logs
+
+
+def restart_job(repo_name, job_id):
+    url = f"https://api.github.com/repos/{repo_name}/actions/runs/{job_id}/rerun-failed-jobs"
+    s = start_request_session()
+    response = s.post(url)
+    return response.json()
+
+
+def eval_jobs():
+    run = get_ci_run(REPO_OWNER, WORKFLOW_RUN_ID)
+    if run["run_attempt"] > 1:
+        print("This is not the first attempt. Exiting")
+        return
+    failed_logs = get_ci_specific_run_specific_failure_details(REPO_OWNER, WORKFLOW_RUN_ID)
+
+    if len(failed_logs) == 0:
+        print("No runs exhibit signs of abrupt stoppage")
+        return
+
+    print("restarting job", WORKFLOW_RUN_ID)
+    r = restart_job(REPO_OWNER, WORKFLOW_RUN_ID)
+    print(r)
+
+    shutil.rmtree("logs")
+    os.remove("logs.zip")
+
+
+if __name__ == "__main__":
+    eval_jobs()

.github/workflows/ci-bcf.yml

@@ -19,20 +19,19 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: '3.x'
+          python-version: '3.10'
       - name: Build package
         run: |
           cd src/bcf
           pip install build
           python -m build
+      - name: Test
+        run: |
+          cd src/bcf
+          make test
       - name: Publish package
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: __token__
           password: ${{ secrets.PYPI_TOKEN }}
           packages_dir: src/bcf/dist
-
-
-
-
-

.github/workflows/ci-blenderbim-choco.yml

@@ -0,0 +1,92 @@
+name: Publish-blenderbim-chocolatey package
+
+on:
+  schedule:
+    #         ┌───────────── minute (0 - 59)
+    #         │  ┌───────────── hour (0 - 23)
+    #         │  │ ┌───────────── day of the month (1 - 31)
+    #         │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #         │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #         *  * * * *
+    - cron:  "30 0 * * *" # 30min past utc midnight
+
+env:
+  major: 0
+  minor: 0
+  name: blenderbim
+  choco_version: 1.1.0
+  CHOCO_TOKEN:   ${{ secrets.CHOCO_TOKEN }}
+
+jobs:
+  activate:
+    runs-on: ubuntu-latest
+    if: |
+      github.repository == 'IfcOpenShell/IfcOpenShell'
+    steps:
+    - name: Set env
+      run: echo ok go
+
+  build:
+    needs: activate
+    name: ${{ matrix.config.name }}-${{ matrix.pyver }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        pyver: [py310]
+        config:
+          - {
+            name: "Windows Build",
+            short_name: win,
+          }
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2 # https://github.com/actions/setup-python
+        with:
+          python-version: '3.10.9' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+          architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+      - run: echo ${{ env.DATE }}
+
+      - name: Check in published releases if we should do a choco release
+        id: do_choco
+        run: |
+          echo "::set-output name=choco_release::$(python3 /home/runner/work/IfcOpenShell/IfcOpenShell/choco/blenderbim/check_repo_infos.py --do_choco_release?)"
+
+      - name: Fill chocolatey scripts on win with latest blender python
+        if: ${{steps.do_choco.outputs.choco_release}} == 'do_choco_release'
+        run: |
+          yesterday_non_iso="$(date  --date='yesterday' +'%y%m%d' | tr -d '\n')" &&
+          target_os=${{ matrix.config.short_name }} &&
+          latest_blender_python_version_maj_min=$(python3 /home/runner/work/IfcOpenShell/IfcOpenShell/choco/blenderbim/check_repo_infos.py --latest_blender_python_version_maj_min?) &&
+          echo "latest_blender_python_version_maj_min?: $latest_blender_python_version_maj_min" &&
+          pyver=$(python3 /home/runner/work/IfcOpenShell/IfcOpenShell/choco/blenderbim/check_repo_infos.py --pyver?) &&
+          export latest_blender_version_maj_min=$(python3 /home/runner/work/IfcOpenShell/IfcOpenShell/choco/blenderbim/check_repo_infos.py --latest_blender_release_maj_min?) &&
+          export latest_blender_version_maj_min_pat=$(python3 /home/runner/work/IfcOpenShell/IfcOpenShell/choco/blenderbim/check_repo_infos.py --latest_blender_release_maj_min_pat?) &&
+          echo   latest_blender_version_maj_min_pat?: $latest_blender_version_maj_min_pat &&
+          export blenderbim_build_version="${{ env.major }}.${{ env.minor }}.$yesterday_non_iso" &&
+          export url_blenderbim_py310_win_zip="https://github.com/IfcOpenShell/IfcOpenShell/releases/download/blenderbim-$yesterday_non_iso/blenderbim-$yesterday_non_iso-$pyver-$target_os.zip" &&
+          wget $url_blenderbim_py310_win_zip --no-verbose &&
+          export sha256sum_blenderbim_py310_win_zip=$( sha256sum blenderbim-$yesterday_non_iso-$pyver-$target_os.zip  --tag | cut -d ' ' -f 4  | tr -d '\n') &&
+          echo   sha256sum_blenderbim_py310_win_zip: $sha256sum_blenderbim_py310_win_zip &&
+          python3 choco/blenderbim/fill_dynamic_parameters.py &&
+          echo __build choco with mono &&
+          wget "https://github.com/chocolatey/choco/archive/refs/tags/$choco_version.tar.gz" --quiet &&
+          tar -xzf "$choco_version.tar.gz" &&
+          cd choco-$choco_version &&
+          chmod +x build.sh zip.sh &&
+          ./build.sh &&
+          cp -r build_output/chocolatey /opt/chocolatey &&
+          cd /home/runner/work/IfcOpenShell/IfcOpenShell/choco/blenderbim/ &&
+          echo __choco pack &&
+          mono /opt/chocolatey/choco.exe --version &&
+          mono /opt/chocolatey/choco.exe pack --allow-unofficial &&
+          echo __choco set apiKey &&
+          mono /opt/chocolatey/choco.exe setapikey --key="$CHOCO_TOKEN" --source="https://push.chocolatey.org/" --allow-unofficial # &&
+          echo __choco push &&
+          mono /opt/chocolatey/choco.exe push --source="https://push.chocolatey.org/" --key="$CHOCO_TOKEN" --allow-unofficial --verbose
+
+      - name: Inform user about not packaging
+        if: ${{steps.do_choco.outputs.choco_release}} != 'do_choco_release'
+        run: |
+          echo "no releases found today ${{ env.DATE }}, therefore choco packaging is skipped."
+

.github/workflows/ci-blenderbim-matrix.yml

@@ -3,8 +3,18 @@ name: Publish-blenderbim-multiplatform
 on:
   push:
     paths:
-      - 'src/blenderbim/**'
       - '.github/workflows/ci-blenderbim-matrix.yml'
+      - 'src/blenderbim/**'
+      - 'src/ifcopenshell-python/ifcopenshell/**'
+      - 'src/bcf/src/bcf/**'
+      - 'src/ifcclash/ifcclash/**'
+      - 'src/ifccobie/**'
+      - 'src/ifcdiff/**'
+      - 'src/ifccsv/**'
+      - 'src/ifcpatch/ifcpatch/**'
+      - 'src/ifc4d/ifc4d/**'
+      - 'src/ifc5d/ifc5d/**'
+      - 'src/ifccityjson/**'
     branches:
       - v0.7.0
 
@@ -23,12 +33,13 @@ jobs:
       run: echo ok go
 
   build:
+    needs: activate
     name: ${{ matrix.config.name }}-${{ matrix.pyver }}
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        pyver: [py37, py39]
+        pyver: [py37, py39, py310]
         config:
           - {
             name: "Windows Build",
@@ -42,12 +53,16 @@ jobs:
             name: "MacOS Build",
             short_name: macos
           }
+          - {
+            name: "MacOS ARM Build",
+            short_name: macosm1
+          }
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2 # https://github.com/actions/setup-python
         with:
-          python-version: '3.7.7' # Version range or exact version of a Python version to use, using SemVer's version range syntax
           architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+          python-version: '3.10'
       - run: echo ${{ env.DATE }}
       - name: Get current date
         id: date

.github/workflows/ci-ifcopenshell-conda-daily.yml

@@ -0,0 +1,73 @@
+name: ci-ifcopenshell-conda-daily
+
+on:
+  push:
+      paths:
+        - .github/workflows/ci-ifcopenshell-conda-daily.yml
+        - conda/**
+  schedule:
+  #         ┌───────────── minute (0 - 59)
+  #         │  ┌───────────── hour (0 - 23)
+  #         │  │ ┌───────────── day of the month (1 - 31)
+  #         │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+  #         │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+  #         *  * * * *
+  - cron: "49 23 * * *" # 11min before utc midnight every day
+
+jobs:
+  activate:
+    runs-on: ubuntu-latest
+    if: |
+      github.repository == 'IfcOpenShell/IfcOpenShell'
+    steps:
+      - name: Set env
+        run: echo ok go
+
+  test:
+    name: ${{ matrix.platform.distver }}-${{ matrix.pyver.name }}
+    needs: activate
+    runs-on: ${{ matrix.platform.distver }}
+    defaults:
+      run:
+        shell: bash -l {0}
+    strategy:
+      fail-fast: false
+      matrix:
+        pyver: [
+          { name: py310, distver: '3.10'},
+          { name: py311, distver: '3.11'}
+        ]
+        platform: [
+          { name: Windows, distver: windows-2022, upload: 'true' },
+          { name: Linux, distver: ubuntu-22.04,  upload: 'true' },
+          { name: macOS, distver: macos-12, upload: 'true' }
+        ]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Download MacOSX SDK
+        if: ${{ matrix.platform.name == 'macOS' }}
+        run: |
+          curl -o MacOSX10.13.sdk.tar.xz -L https://github.com/phracker/MacOSX-SDKs/releases/download/11.3/MacOSX10.13.sdk.tar.xz && \
+          tar xf MacOSX10.13.sdk.tar.xz && \
+          sudo mv -v MacOSX10.13.sdk /opt/ && \
+          ls /opt/
+      - uses: seanmiddleditch/gha-setup-ninja@master
+      - uses: mamba-org/provision-with-micromamba@main # https://github.com/mamba-org/provision-with-micromamba
+        with:
+          channels: conda-forge
+          channel-priority: strict
+          environment-file: conda/environment.yml
+          extra-specs: |
+            python=${{ matrix.pyver.distver }}
+      - name: build, test and upload ifcopenshell
+        if: ${{ matrix.platform.upload == 'true' }}
+        run: |
+          conda-build . --python ${{ matrix.pyver.distver }} -c conda-forge --token ${{ secrets.ANACONDA_TOKEN }} --user ifcopenshell
+        working-directory: ./conda
+      - name: build & test ifcopenshell
+        if: ${{ matrix.platform.upload == 'false' }}
+        run: |
+          conda-build . --python ${{ matrix.pyver.distver }} -c conda-forge
+        working-directory: ./conda

.github/workflows/ci-ifcopenshell-pypi.yml

@@ -0,0 +1,77 @@
+name: ci-ifcopenshell-pypi
+
+on:
+  schedule:
+    #         ┌───────────── minute (0 - 59)
+    #         │  ┌───────────── hour (0 - 23)
+    #         │  │ ┌───────────── day of the month (1 - 31)
+    #         │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #         │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #         *  * * * *
+    - cron: "0 0 18 * *"
+  push:
+    paths:
+      - '.github/workflows/ci-ifcopenshell-pypi.yml'
+
+
+env:
+  major: 0
+  minor: 0
+  name: ifcopenshell
+
+jobs:
+  activate:
+    runs-on: ubuntu-latest
+    if: |
+      github.repository == 'IfcOpenShell/IfcOpenShell'
+    steps:
+    - name: Set env
+      run: echo ok go
+
+  build:
+    needs: activate
+    name: ${{ matrix.config.name }}-${{ matrix.pyver }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        pyver: [py36, py37, py38, py39, py310, py311]
+        config:
+          - {
+            name: "Windows Build",
+            short_name: win,
+          }
+          - {
+            name: "Linux Build",
+            short_name: linux
+          }
+          - {
+            name: "MacOS Build",
+            short_name: macos
+          }
+          - {
+            name: "MacOS ARM Build",
+            short_name: macosm1
+          }
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2 # https://github.com/actions/setup-python
+        with:
+          python-version: '3.10' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+          architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+      - run: echo ${{ env.DATE }}
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%y%m%d')"
+      - name: Compile
+        run: |
+          pip install build
+          cp -r src/ifcopenshell-python src/ifcopenshell_${{ matrix.config.short_name }}_${{ matrix.pyver }} &&
+          cd src/ifcopenshell_${{ matrix.config.short_name }}_${{ matrix.pyver }} &&
+          make dist PLATFORM=${{ matrix.config.short_name }} PYVERSION=${{ matrix.pyver }}
+      - name: Publish a Python distribution to PyPI
+        uses: ortega2247/pypi-upload-action@master
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages_dir: src/ifcopenshell_${{ matrix.config.short_name }}_${{ matrix.pyver }}/dist

.github/workflows/ci-ifctester-pypi.yml

@@ -0,0 +1,57 @@
+name: ci-ifctester-pypi
+
+on:
+  schedule:
+    #         ┌───────────── minute (0 - 59)
+    #         │  ┌───────────── hour (0 - 23)
+    #         │  │ ┌───────────── day of the month (1 - 31)
+    #         │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #         │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #         *  * * * *
+    - cron: "0 0 18 * *"
+  push:
+    paths:
+      - '.github/workflows/ci-ifctester-pypi.yml'
+
+
+env:
+  major: 0
+  minor: 0
+  name: ifcopenshell
+
+jobs:
+  activate:
+    runs-on: ubuntu-latest
+    if: |
+      github.repository == 'IfcOpenShell/IfcOpenShell'
+    steps:
+    - name: Set env
+      run: echo ok go
+
+  build:
+    needs: activate
+    name: ${{ matrix.config.name }}-${{ matrix.pyver }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2 # https://github.com/actions/setup-python
+        with:
+          python-version: '3.10' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+          architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+      - run: echo ${{ env.DATE }}
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%y%m%d')"
+      - name: Compile
+        run: |
+          pip install build
+          cd src/ifctester &&
+          make dist
+      - name: Publish a Python distribution to PyPI
+        uses: ortega2247/pypi-upload-action@master
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages_dir: src/ifctester/dist

.github/workflows/ci-py-only.yml

@@ -0,0 +1,98 @@
+name: ci_py_only
+
+on:
+  push:
+    paths:
+      - 'src/**'
+      - 'test/**'
+      - 'conda/**'
+      - 'cmake/**'
+      - '.github/workflows/ci-py-only.yml'
+  pull_request:
+
+jobs:
+  activate:
+    runs-on: ubuntu-latest
+    if: |
+      github.repository == 'IfcOpenShell/IfcOpenShell' &&
+      !contains(github.event.head_commit.message, 'skip ci')
+    steps:
+      - run: echo ok go
+
+  build:
+    runs-on: ubuntu-20.04
+    needs: activate
+    steps:
+      - uses: actions/checkout@v2
+        with:
+            submodules: recursive
+      - name: Install C++ dependencies
+        run: |
+          sudo apt update
+          sudo apt-get install --no-install-recommends \
+          git cmake gcc g++ \
+          libboost-date-time-dev \
+          libboost-filesystem-dev \
+          libboost-iostreams-dev \
+          libboost-program-options-dev \
+          libboost-regex-dev \
+          libboost-system-dev \
+          libboost-thread-dev \
+          python3-all-dev python3-pip \
+          swig libpcre3-dev libxml2-dev \
+          libtbb-dev nlohmann-json3-dev \
+          libocct-foundation-dev libocct-modeling-algorithms-dev libocct-modeling-data-dev libocct-ocaf-dev libocct-visualization-dev libocct-data-exchange-dev \
+          libhdf5-dev libcgal-dev
+          
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1
+        with:
+          key: ${GITHUB_WORKFLOW}
+
+      - name: Build ifcopenshell
+        run: |
+          sudo /usr/sbin/update-ccache-symlinks
+          mkdir build && cd build
+          PATH="/usr/lib/ccache:$PATH" cmake \
+               -DCMAKE_BUILD_TYPE=Release \
+               -DCMAKE_PREFIX_PATH=/usr \
+               -DCMAKE_SYSTEM_PREFIX_PATH=/usr \
+               -DOCC_INCLUDE_DIR=/usr/include/opencascade \
+               -DOCC_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
+               -DPYTHON_EXECUTABLE:FILEPATH=/usr/bin/python3 \
+               -DPYTHON_INCLUDE_DIR:PATH=/usr/include/python3.8 \
+               -DPYTHON_LIBRARY:FILEPATH=/usr/lib/x86_64-linux-gnu/libpython3.8.so \
+               -DCOLLADA_SUPPORT=Off \
+               "-DSCHEMA_VERSIONS=2x3;4;4x3_add1" \
+               -DBUILD_CONVERT=Off \
+               -DGLTF_SUPPORT=On \
+               -DJSON_INCLUDE_DIR=/usr/include \
+               -DCGAL_INCLUDE_DIR=/usr/include \
+               -DGMP_INCLUDE_DIR=/usr/include \
+               -DMPFR_INCLUDE_DIR=/usr/include \
+               -DGMP_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
+               -DMPFR_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
+               -DHDF5_INCLUDE_DIR=/usr/include/hdf5/serial \
+             ../cmake
+          sudo make -j $(nproc)
+          sudo make install
+
+      - name: Install Python dependencies
+        run: |
+          sudo /usr/bin/python -m pip install -U pip
+          sudo /usr/bin/python -m pip install xmlschema xsdata numpy lxml
+          sudo /usr/bin/python -m pip install src/bcf --no-deps
+          sudo /usr/bin/python -m pip install pytest
+          sudo /usr/bin/python -m pip install isodate
+          sudo /usr/bin/python -m pip install lark
+          sudo /usr/bin/python -m pip install networkx
+          sudo /usr/bin/python -m pip install tabulate
+          sudo /usr/bin/python -m pip install python-dateutil
+
+      - name: Test
+        run: |
+          cd test
+          sudo /usr/bin/python tests.py
+          cd ../src/ifcopenshell-python
+          mv ifcopenshell ifcopenshell-local # Force testing on installed module
+          make test

.github/workflows/ci-restart-failed-daily-conda-builds.yml

@@ -0,0 +1,34 @@
+name: Restart failed daily conda builds
+
+on:
+  workflow_run:
+    workflows: [ ci-ifcopenshell-conda-daily ]
+    types:
+      - completed
+
+env:
+  REPO_OWNER: IfcOpenShell/IfcOpenShell
+  MY_WORKFLOW: ci-ifcopenshell-conda-daily
+
+jobs:
+  restart-failed-runs:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+      - name: Use python 3.11
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests
+      - name: Check for failed runs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          WORKFLOW_RUN_ID: ${{ github.event.workflow_run.id }}
+        run: |
+          python check_repo_ci_jobs.py
+        working-directory: .github/workflows

.github/workflows/ci.yml

@@ -3,8 +3,19 @@ name: ci
 on:
   push:
     paths:
-      - 'src/**'
-      - 'test/**'
+      - 'src/ifcblender/**'
+      - 'src/ifcconvert/**'
+      - 'src/ifcgeom/**'
+      - 'src/ifcgeom_schema_agnostic/**'
+      - 'src/ifcgeomserver/**'
+      - 'src/ifcjni/**'
+      - 'src/ifcmax/**'
+      - 'src/ifcopenshell-python/**'
+      - '!src/ifcopenshell-python/docs/**'
+      - 'src/ifcparse/**'
+      - 'src/ifcwrap/**'
+      - 'src/qtviewer/**'
+      - 'src/serializers/**'
       - 'conda/**'
       - 'cmake/**'
       - '.github/workflows/ci.yml'
@@ -41,11 +52,13 @@ jobs:
           python3-all-dev python3-pip \
           swig libpcre3-dev libxml2-dev \
           libtbb-dev nlohmann-json3-dev \
-          liboce-foundation-dev liboce-modeling-dev liboce-ocaf-dev liboce-visualization-dev liboce-ocaf-lite-dev \
+          libocct-foundation-dev libocct-modeling-algorithms-dev libocct-modeling-data-dev libocct-ocaf-dev libocct-visualization-dev libocct-data-exchange-dev \
           libhdf5-dev libcgal-dev
           
       - name: ccache
         uses: hendrikmuhs/ccache-action@v1
+        with:
+          key: ${GITHUB_WORKFLOW}
 
       - name: Build ifcopenshell
         run: |
@@ -53,17 +66,16 @@ jobs:
           cmake \
                -DCMAKE_C_COMPILER_LAUNCHER=ccache \
                -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
-               -DCMAKE_INSTALL_PREFIX=$PWD/install/ \
                -DCMAKE_BUILD_TYPE=Release \
                -DCMAKE_PREFIX_PATH=/usr \
                -DCMAKE_SYSTEM_PREFIX_PATH=/usr \
-               -DOCC_INCLUDE_DIR=/usr/include/oce \
+               -DOCC_INCLUDE_DIR=/usr/include/opencascade \
                -DOCC_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
                -DPYTHON_EXECUTABLE:FILEPATH=/usr/bin/python3 \
                -DPYTHON_INCLUDE_DIR:PATH=/usr/include/python3.8 \
                -DPYTHON_LIBRARY:FILEPATH=/usr/lib/x86_64-linux-gnu/libpython3.8.so \
                -DCOLLADA_SUPPORT=Off \
-               "-DSCHEMA_VERSIONS=2x3;4" \
+               "-DSCHEMA_VERSIONS=2x3;4;4x3_add1" \
                -DGLTF_SUPPORT=On \
                -DJSON_INCLUDE_DIR=/usr/include \
                -DCGAL_INCLUDE_DIR=/usr/include \
@@ -76,13 +88,32 @@ jobs:
           sudo make -j $(nproc)
           sudo make install
 
+      - name: Run IfcConvert on Sample files
+        run: |
+          (find test/input src/blenderbim/test/files -name '*.ifc' | while read i; do \
+            echo $i | tee -a log; \
+            timeout 1m "$(which IfcConvert)" -yv "$i" "$i.obj" --validate >> log 2>&1; \
+            echo $i $? >> statuses; \
+          done) || true
+          echo Failed 
+          grep -v 0$ statuses
+          grep -v 0$ statuses | wc -l
+          echo Succeeded
+          grep 0$ statuses
+          grep 0$ statuses | wc -l
+
       - name: Install Python dependencies
         run: |
           sudo /usr/bin/python -m pip install -U pip
-          sudo /usr/bin/python -m pip install xmlschema numpy lxml
-          sudo /usr/bin/python -m pip install src/bcf
+          sudo /usr/bin/python -m pip install xmlschema xsdata numpy lxml
+          sudo /usr/bin/python -m pip install src/bcf --no-deps
           sudo /usr/bin/python -m pip install pytest
           sudo /usr/bin/python -m pip install isodate
+          sudo /usr/bin/python -m pip install lark
+          sudo /usr/bin/python -m pip install networkx
+          sudo /usr/bin/python -m pip install https://github.com/Andrej730/aud/archive/refs/heads/master-reduced-size.zip
+          sudo /usr/bin/python -m pip install tabulate
+          sudo /usr/bin/python -m pip install python-dateutil
 
       - name: Test
         run: |

.github/workflows/release.yml

@@ -18,14 +18,24 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
         with:
-          lfs: true
-      - 
-        name: Update ubuntu
+          submodules: recursive
+      - name: Install C++ dependencies
         run: |
           sudo apt update
-          sudo apt-get install git cmake gcc g++ libboost1.67-all-dev python3-all-dev swig libpcre3-dev libxml2-dev
-          sudo apt-get install liboce-foundation-dev liboce-modeling-dev liboce-ocaf-dev liboce-visualization-dev liboce-ocaf-lite-dev \
-          libhdf5-dev
+          sudo apt-get install --no-install-recommends \
+          git cmake gcc g++ \
+          libboost-date-time-dev \
+          libboost-filesystem-dev \
+          libboost-iostreams-dev \
+          libboost-program-options-dev \
+          libboost-regex-dev \
+          libboost-system-dev \
+          libboost-thread-dev \
+          python3-all-dev python3-pip \
+          swig libpcre3-dev libxml2-dev \
+          libtbb-dev nlohmann-json3-dev \
+          libocct-foundation-dev libocct-modeling-algorithms-dev libocct-modeling-data-dev libocct-ocaf-dev libocct-visualization-dev libocct-data-exchange-dev \
+          libhdf5-dev libcgal-dev opencollada-dev
           
       - name: Build
         env:
@@ -39,15 +49,23 @@ jobs:
            -DCMAKE_PREFIX_PATH=/usr \
            -DCMAKE_SYSTEM_PREFIX_PATH=/usr \
            -DBUILD_PACKAGE=On \
-           -DOCC_INCLUDE_DIR=/usr/include/oce \
+           -DOCC_INCLUDE_DIR=/usr/include/opencascade \
            -DOCC_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
            -DPYTHON_EXECUTABLE:FILEPATH=/usr/bin/python3 \
            -DPYTHON_INCLUDE_DIR:PATH=/usr/include/python3.8 \
            -DPYTHON_LIBRARY:FILEPATH=/usr/lib/x86_64-linux-gnu/libpython3.8.so \
-           -DCOLLADA_SUPPORT=Off \
            -DLIBXML2_INCLUDE_DIR=/usr/include/libxml2 \
            -DLIBXML2_LIBRARIES=/usr/lib/x86_64-linux-gnu/libxml2.so \
+           -DGLTF_SUPPORT=On \
+           -DJSON_INCLUDE_DIR=/usr/include \
+           -DCGAL_INCLUDE_DIR=/usr/include \
+           -DGMP_INCLUDE_DIR=/usr/include \
+           -DMPFR_INCLUDE_DIR=/usr/include \
+           -DGMP_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
+           -DMPFR_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
            -DHDF5_INCLUDE_DIR=/usr/include/hdf5/serial \
+           -DOPENCOLLADA_INCLUDE_DIR=/usr/include/opencollada \
+           -DOPENCOLLADA_LIBRARY_DIR=/usr/lib/opencollada/ \
            ../cmake
           make -j $(nproc)
           make install

.gitignore

@@ -5,6 +5,15 @@
 /_installed-vs*-x*/
 /build/
 
+# output directories
+/cmake/out/
+/docs/out/
+/src/examples/out/
+/src/ifcmax/out/
+/src/ifcwrap/out/
+/src/qtviewer/out/
+
+
 /win/BuildDepsCache*.txt
 # IfcExpressParser residue
 /src/ifcexpressparser/express_parser.py
@@ -13,6 +22,7 @@ __pycache__
 *.py.bak
 # Visual Studio Code files
 .vscode
+.vs
 # PyCharm files
 .idea
 
@@ -57,3 +67,26 @@ htmlcov
 
 # Blender
 *.blend1
+
+# Sphinx
+_build/
+
+# IDS Docs
+src/ifcopenshell-python/test/build
+
+# tox cache
+.tox/
+*.egg-info/
+
+# mypy cache
+.mypy_cache
+
+# blenderbim libs
+src/blenderbim/blenderbim/libs
+
+# blenderbim test temp files
+src/blenderbim/test/files/temp
+
+# ifcopenshell swig and compiled files
+src/ifcopenshell-python/ifcopenshell/_ifcopenshell_wrapper.so
+src/ifcopenshell-python/ifcopenshell/ifcopenshell_wrapper.py

.gitmodules

@@ -8,3 +8,6 @@
 [submodule "src/svgfill"]
 	path = src/svgfill
 	url = https://github.com/IfcOpenShell/svgfill
+[submodule "src/ifcopenshell-python/test/Sample-BIM-Files"]
+	path = src/ifcopenshell-python/test/Sample-BIM-Files
+	url = https://github.com/IfcOpenShell/ids-test-files

.travis.yml

@@ -1,81 +0,0 @@
-language: cpp
-compiler: gcc
-cache: ccache
-os: linux
-dist: focal
-addons:
-  apt:
-    update: true
-    packages:
-    - libboost-date-time-dev
-    - libboost-filesystem-dev
-    - libboost-iostreams-dev
-    - libboost-program-options-dev
-    - libboost-regex-dev
-    - libboost-system-dev
-    - libboost-thread-dev
-    - libocct-data-exchange-dev
-    - libocct-foundation-dev
-    - libocct-modeling-algorithms-dev
-    - libocct-modeling-data-dev
-    - libxml2-dev
-    - nlohmann-json3-dev
-    - opencollada-dev
-    - python3-all-dev
-    - python3-pip
-    - swig
-    - libhdf5-dev
-
-before_script:
-  - if [ $TRAVIS_OS_NAME == "linux" ]; then ccache -z; fi
-  
-install:
-  # for IDS
-  - python3 -m pip install xmlschema
-
-script:
-  - pwd
-  - mkdir build && cd build
-  - |
-    cmake \
-    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
-    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
-    -DOCC_INCLUDE_DIR=/usr/include/opencascade \
-    -DOCC_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu \
-    -DPYTHON_EXECUTABLE:FILEPATH=/usr/bin/python3 \
-    -DPYTHON_INCLUDE_DIR:PATH=/usr/include/python3.8 \
-    -DPYTHON_LIBRARY:FILEPATH=/usr/lib/x86_64-linux-gnu/libpython3.8.so \
-    "-DSCHEMA_VERSIONS=2x3;4" \
-    -DGLTF_SUPPORT=On \
-    -DJSON_INCLUDE_DIR=/usr/include \
-    -DHDF5_INCLUDE_DIR=/usr/include/hdf5/serial \
-    ../cmake
-
-  # TODO: Drop sudo
-  - sudo make -j $(nproc) install
-
-  - cd ../test
-  - /usr/bin/python tests.py
-  - /usr/bin/python ../src/ifcopenshell-python/ifcopenshell/test_ids.py
-
-  - cd input
-
-  - /usr/local/bin/IfcConvert -yv acad2010_walls.ifc acad2010_walls.glb
-
-  - /usr/bin/python -c "from io import open; import ifcopenshell; f = ifcopenshell.open('encoding.ifc'); assert list(map(ord, f[1][0])) == [39, 97, 39, 32, 49, 109, 179, 32, 8804, 32, 53, 109, 179, 32, 8805, 32, 49, 48, 109, 179]"
-
-  - |
-    (for i in *.ifc; do \
-    echo $i | tee -a log; \
-    timeout 1m /usr/local/bin/IfcConvert -yv "$i" "$i.dae" --validate >> log 2>&1; \
-    echo $i $? >> statuses; \
-    done) || true
-  - echo Failed
-  - grep -v 0$ statuses
-  - grep -v 0$ statuses | wc -l
-  - echo Succeeded
-  - grep 0$ statuses
-  - grep 0$ statuses | wc -l
-
-after_script:
-  - if [ $TRAVIS_OS_NAME == "linux" ]; then ccache -s; fi

Dockerfile

@@ -23,9 +23,11 @@ RUN echo "deb http://archive.ubuntu.com/ubuntu focal-proposed main restricted" |
     echo "deb http://archive.ubuntu.com/ubuntu focal-proposed multiverse" |  tee -a /etc/apt/sources.list; \
     apt-get -qq update; \
     apt-get -y install tzdata dos2unix rsync; \
-    apt-get -y install python3 libxml2 liboce-foundation11 liboce-modeling11 liboce-ocaf11 liboce-visualization11 \
-                     liboce-ocaf-lite11 libpython3.8 libboost-system1.67.0 libboost-program-options1.67.0 \
-                    libboost-regex1.67.0 libboost-thread1.67.0 libboost-date-time1.67.0; \
+    apt-get -y install python3 libxml2 libpython3.8 \
+                    libboost-all-dev \
+                    libocct-foundation-dev libocct-modeling-algorithms-dev libocct-modeling-data-dev \
+                    libocct-ocaf-dev libocct-visualization-dev libocct-data-exchange-dev \
+                    libhdf5-serial-dev python3-pytest ; \
     rm -rf /var/lib/apt/lists/* ; 
 
 COPY . /home/IfcOpenShell/

README.md

@@ -1,286 +1,74 @@
+
 IfcOpenShell 
 ============
-IfcOpenShell is an open source ([LGPL]) software library for working with the Industry Foundation Classes ([IFC]) 
-file format. Currently supported IFC releases are [IFC2x3 TC1] and [IFC4 Add2 TC1].
 
-For more information, see
-* [http://ifcopenshell.org](http://ifcopenshell.org)  
-* [http://academy.ifcopenshell.org](http://academy.ifcopenshell.org)
+IfcOpenShell is an open source ([LGPL]) software library for working with Industry Foundation Classes ([IFC]). Complete
+parsing support is provided for [IFC2x3 TC1], [IFC4 Add2 TC1], IFC4x1, IFC4x3, and IFC4x3. Extensive geometric support
+is implemented for the IFC releases [IFC2x3 TC1] and [IFC4 Add2 TC1]. Extending with support for arbitrary IFC schemas
+is possible at compile-time when using C++ and at run-time when using Python.
 
-[![Build Status](https://travis-ci.org/IfcOpenShell/IfcOpenShell.svg?branch=v0.6.0)](https://travis-ci.org/IfcOpenShell/IfcOpenShell)
+In addition to a C++ and Python API, IfcOpenShell comes with an ecosystem of tools, notably including IfcConvert (an application to convert IFC models to
+other formats), the BlenderBIM Add-on (an add-on to Blender providing a graphical IFC authoring platform), and many
+other libraries, CLI apps, and more. Support is also provided for auxiliary standards such as BCF and IDS.
 
-Prerequisites
--------------
-* Git
-* CMake (2.6 or newer)
-* Windows: [Visual Studio] 2008 or newer with C++ toolset (or [Visual C++ Build Tools]) or [MSYS2] + MinGW
-* *nix: GCC 4.7 or newer, or Clang (any version)
+For more information, see:
 
-Dependencies
--------------
-* [Boost](http://www.boost.org/)
-* [Open Cascade](https://dev.opencascade.org/) - *optional*, but required for building IfcGeom
-  ([official](https://dev.opencascade.org/release), "OCCT", or [community edition](https://github.com/tpaviot/oce), "OCE")  
-  For converting IFC representation items into BRep solids and tesselated meshes
-* [OpenCOLLADA](https://github.com/khronosGroup/OpenCOLLADA/) - *optional*  
-  For IfcConvert to be able to write tessellated Collada (.dae) files
-* [SWIG](http://www.swig.org/) and [Python](https://www.python.org/) - *optional*  
-  For building the IfcOpenShell Python interface and the Blender add-on
-* [3ds Max SDK](http://www.autodesk.com/products/3ds-max/free-trial) - *optional*  
-  For building the 3ds Max plug-in.
-  All recent versions of 3ds Max (2014 and newer) are 64-bit only, so a 64-bit installation is assumed.
+* [IfcOpenShell Website](http://ifcopenshell.org)
+* [IfcOpenShell Documentation](http://blenderbim.org/docs-python)
+  * [IfcOpenShell C++ Installation](https://blenderbim.org/docs-python/ifcopenshell/installation.html)
+  * [IfcOpenShell Python Installation](https://blenderbim.org/docs-python/ifcopenshell-python/installation.html)
+  * [IfcOpenShell Python Hello World Tutorial](https://blenderbim.org/docs-python/ifcopenshell-python/hello_world.html)
+* [BlenderBIM Add-on Website](https://blenderbim.org)
+* [BlenderBIM Add-on Documentation](http://blenderbim.org/docs)
+  * [Add-on Installation](https://blenderbim.org/docs/users/installation.html)
+  * [Exploring an IFC model](https://blenderbim.org/docs/users/exploring_an_ifc_model.html)
 
-Building IfcOpenShell
----------------------
+| Service                                         | Status                                                                                                                                       |
+| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| Anaconda Daily Build                            | [![Anaconda-Server Badge](https://img.shields.io/conda/vn/ifcopenshell/ifcopenshell)](https://anaconda.org/ifcopenshell/ifcopenshell)        |
+| Anaconda v0.7.0 Stable                          | [![Anaconda-Server Badge](https://img.shields.io/conda/vn/conda-forge/ifcopenshell)](https://anaconda.org/conda-forge/ifcopenshell)          |
+| PyPi Daily Build                                | [![PyPi Badge](https://img.shields.io/pypi/v/ifcopenshell)](https://pypi.org/project/ifcopenshell/)                                          |
+| ArchLinux AUR Package Stable                           | [![AUR Badge](https://img.shields.io/aur/version/ifcopenshell)](https://aur.archlinux.org/packages/ifcopenshell)                     |
+| ArchLinux AUR Package git                           | [![AUR Badge](https://img.shields.io/aur/version/ifcopenshell-git)](https://aur.archlinux.org/packages/ifcopenshell-git)                     |
+| BlenderBIM Add-on Chocolatey (under moderation) | [![Chocolatey Badge](https://img.shields.io/chocolatey/v/blenderbim-nightly)](https://community.chocolatey.org/packages/blenderbim-nightly/) |
+| Sponsor development on OpenCollective           | [![Financial Contributors](https://opencollective.com/opensourcebim/tiers/badge.svg)](https://opencollective.com/opensourcebim/)             |
+| Docker hub                                      | [![Docker Pulls](https://img.shields.io/docker/pulls/aecgeeks/ifcopenshell)](https://hub.docker.com/r/aecgeeks/ifcopenshell)                 |
 
-**Note:** The path where the source code is cloned to can contain spaces but non-ASCII characters are very likely to cause problems with the build.
-
-### Compiling on Windows
-The preferred way to fetch and build this project's dependencies is to use the build scripts
-in win/ folder. **See [win/readme.md] for more information**.
-
-#### Using Visual Studio
-Instructions in a nutshell (**assuming Visual Studio 2015 x64 environment variables set**):
-
-    > cd IfcOpenShell\win
-    > build-deps.cmd
-    > run-cmake.bat
-
-NB: `build-deps.cmd` need to be ran from the directory containing it, i.e. the `./win` folder.
-
-You can now open and build the solution file in Visual Studio:
-
-    > ..\build-vs2015-x64\IfcOpenShell.sln
-
-As the scripts default to using the `RelWithDebInfo` configuration, and a freshly created solution by CMake defaults
-to `Debug`, make sure to switch the used build configuration. Build the `INSTALL` project (right-click -> Project
-Only) to deploy the headers and binaries into a single location if wanted/needed.
-
-Alternatively, one can use the utility batch file(s) to build and install the project easily from the command-line
-(installing a project will build it also, if required):
-
-    > install-ifcopenshell.bat
-
-#### Using MSYS2 + MinGW
-
-Start the MSYS2 Shell and then:
-
-    $ cd IfcOpenShell/win
-    $ ./build-deps.sh
-    $ ./run-cmake.sh
-    $ ./install-ifcopenshell.sh
-
-#### Using Bash on Ubuntu on Windows
-
-Start Bash on Ubuntu on Windows and follow the instructions below. Compiling on Ubuntu 14.04.4 LTS using GCC 4.8.4
-or Clang 3.5 has been confirmed to work.
-
-### Compiling on *nix
-
-The following instructions are for Ubuntu, modify as required for other operating systems. [nix/build-all.py] script
-can be experimented with and studied for pointers for other operating systems, but note that this script is not currently
-meant to be used for a typical IfcOpenShell workspace setup.
-
-Note: where `make -j` is written, add a number roughly equal to the amount of CPU cores + 1.
-
-**1)** Install most of the prerequisites and dependencies:
-
-    $ sudo apt-get install git cmake gcc g++ libboost-all-dev
-
-**2a)** Either use an OCE package from your operating system's software repository
-
-    $ sudo apt-get install liboce-foundation-dev liboce-modeling-dev liboce-ocaf-dev liboce-visualization-dev liboce-ocaf-lite-dev
-
-**2b)** or (if not available, or the latest code is wanted) compile OCE yourself (note that the build takes a long time):
-
-    $ sudo apt-get install libftgl-dev libtbb2 libtbb-dev libgl1-mesa-dev libfreetype6-dev
-    $ git clone https://github.com/tpaviot/oce.git
-    $ cd oce
-    $ mkdir build && cd build
-    $ cmake ..
-    $ make -j
-    $ sudo make install
-
-**2c)** or obtain and compile OCCT from https://dev.opencascade.org/release
-
-**3)** For building IfcConvert with COLLADA (.dae) support (on by default), OpenCOLLADA is needed:
-
-    $ sudo apt-get install libpcre3-dev libxml2-dev
-    $ git clone https://github.com/KhronosGroup/OpenCOLLADA.git
-    $ cd OpenCOLLADA
-    Using a known good revision, but HEAD should work too:
-    $ git checkout 064a60b65c2c31b94f013820856bc84fb1937cc6
-    $ mkdir build && cd build
-    $ cmake ..
-    $ make -j
-    $ sudo make install
-
-**4)** For building the IfcPython wrapper (on by default), SWIG and Python development are needed, if not already available:
-
-    $ sudo apt-get install python-all-dev swig
-
-**5)** To build IfcOpenShell please take the following steps. Alternatively use environment variables for setting the
-dependencies' paths. `OCC_INCLUDE_DIR` might be needed to set also. `OPENCOLLADA_INCLUDE_DIR` and `OPENCOLLADA_LIBRARY_DIR`
-(and potentially `PCRE_LIBRARY_DIR`) are needed if building with COLLADA support. (`-DCOLLADA_SUPPORT=0` disables it).
-
-    $ cd /path/to/IfcOpenShell
-    $ mkdir build && cd build
-    $ cmake ../cmake -DOCC_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu/ \
-          -DOPENCOLLADA_INCLUDE_DIR="/usr/local/include/opencollada" \
-          -DOPENCOLLADA_LIBRARY_DIR="/usr/local/lib/opencollada"  \
-          -DPCRE_LIBRARY_DIR=/usr/lib/x86_64-linux-gnu/
-    $ make -j
-
-If all worked out correctly you can now use IfcOpenShell. See the examples below.
-
-**6)** Install the project if wanted:
-
-    $ sudo make install
-    
-### Installing on MacOS Using Homebrew
-
-**1)** Install all dependencies using [Homebrew](https://brew.sh/)
-
-```{shell}
-$ brew install boost swig cmake ftgl cgal gmp libaec opencascade
-```
-
-**2)** Clone the git repo and its submodules
-```{shell}
-$ git clone --recurse-submodules https://github.com/IfcOpenShell/IfcOpenShell.git 
-```
-**3)** Build IfcOpenShell with flags for Homebrew dependencies (```/usr/local/```)
-```{shell}
-$ cd /path/to/IfcOpenShell
-$ mkdir build && cd build
-$ cmake ../cmake -DOCC_LIBRARY_DIR=/usr/local/lib/ \
-      -DOCC_INCLUDE_DIR=/usr/local/include/opencascade/ \
-      -DCOLLADA_SUPPORT=0 \
-      -DCGAL_INCLUDE_DIR=/usr/local/include/ \
-      -DGMP_LIBRARY_DIR=/usr/local/lib/ \
-      -DMPFR_LIBRARY_DIR=/usr/local/lib/
-      
-$ make -j -lboost_options
-```
-
-Note: Make sure to compile using XCode, rather than a ```brew``` installed C/C++ compiler.
-
-Installing IfcOpenShell with Conda
-----------------------------------
-Another option for building and installing IfcOpenShell is to use the popular
-[Anaconda Python Distribution](https://www.anaconda.com/download).
-The requirements are spread across a number of channels.
-You can add these channels to your configuration, or specify them all on the command line:
-
-    $ conda install -c conda-forge -c oce -c dlr-sc -c ifcopenshell ifcopenshell
-
-Usage examples
---------------
-
-**Invoking IfcConvert from the command line**
-
-    $ wget -O duplex.zip https://portal.nibs.org/files/wl/\?id=4DsTgHFQAcOXzFetxbpRCECPbbfUqpgo
-    $ unzip duplex.zip
-    $ ./IfcConvert Duplex_A_20110907_optimized.ifc
-    $ less Duplex_A_20110907_optimized.obj
-
-**Using the IfcOpenShell Python interface**
-
-    $ wget -O duplex.zip https://portal.nibs.org/files/wl/\?id=4DsTgHFQAcOXzFetxbpRCECPbbfUqpgo
-    $ unzip duplex.zip
-    $ python
-    >>> import ifcopenshell
-    >>> f = ifcopenshell.open("Duplex_A_20110907_optimized.ifc")
-    >>>
-    >>> # Accessing entity instances by type:
-    >>> f.by_type("ifcwall")[:2]
-    [#91=IfcWallStandardCase('2O2Fr$t4X7Zf8NOew3FL9r',#1,'Basic Wall:Interior - Partition (92mm Stud):144586',$,'Basic Wall:Interior - Partition (92mm Stud):128360',#5198,#18806,'144586'), #92=IfcWallStandardCase('2O2Fr$t4X7Zf8NOew3FLIE',#1,'Basic Wall:Interior - Partition (92mm Stud):143921',$,'Basic Wall:Interior - Partition (92mm Stud):128360',#5206,#18805,'143921')]
-    >>> wall = _[0]
-    >>> len(wall) # number of EXPRESS attributes
-    8
-    >>>
-    >>> # Accessing EXPRESS attributes by name:
-    >>> wall.GlobalId 
-    '2O2Fr$t4X7Zf8NOew3FL9r'
-    >>> wall.Name = "My wall"
-    >>> wall.NonExistingAttr
-    Traceback (most recent call last):
-      File "<stdin>", line 1, in <module>
-      File ".\ifcopenshell.py", line 14, in __getattr__
-        except: raise AttributeError("entity instance of type '%s' has no attribute'%s'"%(self.wrapped_data.is_a(), name)) from None
-    AttributeError: entity instance of type 'IfcWallStandardCase' has no attribute 'NonExistingAttr'
-    >>> wall.GlobalId = 3
-    Traceback (most recent call last):
-      File "<stdin>", line 1, in <module>
-      File ".\ifcopenshell.py", line 26, in __setattr__
-        self[self.wrapped_data.get_argument_index(key)] = value
-      File ".\ifcopenshell.py", line 30, in __setitem__
-        self.wrapped_data.set_argument(idx, entity_instance.map_value(value))
-      File ".\ifc_wrapper.py", line 118, in <lambda>
-        set_argument = lambda self,x,y: self._set_argument(x) if y is None else self
-    ._set_argument(x,y)
-      File ".\ifc_wrapper.py", line 114, in _set_argument
-        def _set_argument(self, *args): return _ifc_wrapper.entity_instance__set_argument(self, *args)
-    RuntimeError: INT is not a valid type for 'GlobalId'
-    >>> # Creating new entity instances
-    >>> f.createIfcCartesianPoint(Coordinates=(1.0,1.5,2.0))
-    #27530=IfcCartesianPoint((1.,1.5,2.))
-    >>> 
-    >>> # Working with GlobalId attributes:
-    >>> import uuid
-    >>> ifcopenshell.guid.compress(uuid.uuid1().hex)
-    '3x4C8Q_6qHuv$P$FYkANRX'
-    >>> new_guid = _
-    >>> owner_hist = f.by_type("IfcOwnerHistory")[0]
-    >>> new_wall = f.createIfcWallStandardCase(new_guid, owner_hist, None, None, Tag='my_tag')
-    >>> new_wall.ObjectType = ''
-    >>> new_wall.ObjectPlacement = new_wall.Representation = None
-    >>>
-    >>> # Accessing entity instances by instance id or GlobalId:
-    >>> f[92]
-    #92=IfcWallStandardCase('2O2Fr$t4X7Zf8NOew3FLIE',#1,'Basic Wall:Interior - Partition (92mm Stud):143921',$,'Basic Wall:Interior - Partition (92mm Stud):128360',#5206,#18805,'143921')
-    >>> f['2O2Fr$t4X7Zf8NOew3FLIE']
-    #92=IfcWallStandardCase('2O2Fr$t4X7Zf8NOew3FLIE',#1,'Basic Wall:Interior - Partition (92mm Stud):143921',$,'Basic Wall:Interior - Partition (92mm Stud):128360',#5206,#18805,'143921')
-    >>>
-    >>> # Writing IFC-SPF files to disk:
-    >>> f.write("out.ifc")
-
-Extra tools
------------
-
-Also available are a series of utilities that are based on or related to IfcOpenShell.
+Contents
+--------
 
 Those marked with an asterisk are part of IfcOpenShell.
 
-Name | License
---- | ---
-bcf | LGPL-3.0-or-later
-blenderbim | GPL-3.0-or-later
-bsdd | LGPL-3.0-or-later
-ifc2ca | LGPL-3.0-or-later
-ifc4d | LGPL-3.0-or-later
-ifc5d | LGPL-3.0-or-later
-ifcbimtester | LGPL-3.0-or-later
-ifcblender | LGPL-3.0-or-later\*
-ifccityjson | LGPL-3.0-or-later
-ifcclash | LGPL-3.0-or-later
-ifccobie | LGPL-3.0-or-later
-ifcconvert | LGPL-3.0-or-later\*
-ifccsv | LGPL-3.0-or-later
-ifcdiff | LGPL-3.0-or-later
-ifcfm | LGPL-3.0-or-later
-ifcgeom | LGPL-3.0-or-later\*
-ifcgeom\_schema\_agnostic | LGPL-3.0-or-later\*
-ifcgeomserver | LGPL-3.0-or-later\*
-ifcjni | LGPL-3.0-or-later\*
-ifcmax | LGPL-3.0-or-later\*
-ifcopenshell-python | LGPL-3.0-or-later\*
-ifcparse | LGPL-3.0-or-later\*
-ifcpatch | LGPL-3.0-or-later
-ifcsverchok | GPL-3.0-or-later
-ifcwrap | LGPL-3.0-or-later\*
-qtviewer | LGPL-3.0-or-later\*
-serializers | LGPL-3.0-or-later\*
+| Name                      | Description                                                           | License             |
+| ------------------------- | ----------------------------------------------------------------------| ------------------- |
+| bcf                       | Library to read and write BCF-XML and query OpenCDE BCF-API modules   | LGPL-3.0-or-later   |
+| blenderbim                | Add-on to Blender providing a graphical native IFC authoring platform | GPL-3.0-or-later    |
+| bsdd                      | Library to query the bSDD API                                         | LGPL-3.0-or-later   |
+| ifc2ca                    | Utility to convert IFC structural analysis models to Code_Aster       | LGPL-3.0-or-later   |
+| ifc4d                     | Convert to and from IFC and project management software               | LGPL-3.0-or-later   |
+| ifc5d                     | Report and optimise cost information from IFC                         | LGPL-3.0-or-later   |
+| ifcbimtester              | Wrapper for Gherkin based unit testing for IFC models                 | LGPL-3.0-or-later   |
+| ifcblender                | Historic Blender IFC import add-on                                    | LGPL-3.0-or-later\* |
+| ifccityjson               | Convert CityJSON to IFC                                               | LGPL-3.0-or-later   |
+| ifcclash                  | Clash detection library and CLI app                                   | LGPL-3.0-or-later   |
+| ifccobie                  | Extract IFC data for COBie handover requirements                      | LGPL-3.0-or-later   |
+| ifcconvert                | CLI app to convert IFC to many other formats                          | LGPL-3.0-or-later\* |
+| ifccsv                    | Library and CLI app to export and import schedules from IFC           | LGPL-3.0-or-later   |
+| ifcdiff                   | Compare changes between IFC models                                    | LGPL-3.0-or-later   |
+| ifcfm                     | Extract IFC data for FM handover requirements                         | LGPL-3.0-or-later   |
+| ifcgeom                   | Internal library for IfcOpenShell                                     | LGPL-3.0-or-later\* |
+| ifcgeom\_schema\_agnostic | Internal library for IfcOpenShell                                     | LGPL-3.0-or-later\* |
+| ifcgeomserver             | Internal library for IfcOpenShell                                     | LGPL-3.0-or-later\* |
+| ifcjni                    | Internal library for IfcOpenShell                                     | LGPL-3.0-or-later\* |
+| ifcmax                    | Historic extension for IFC support in 3DS Max                         | LGPL-3.0-or-later\* |
+| ifcopenshell-python       | Python library for IFC manipulation                                   | LGPL-3.0-or-later\* |
+| ifcparse                  | Internal library for IfcOpenShell                                     | LGPL-3.0-or-later\* |
+| ifcpatch                  | Utility to run pre-packaged scripts to manipulate IFCs                | LGPL-3.0-or-later   |
+| ifcsverchok               | Blender Add-on for visual node programming with IFC                   | GPL-3.0-or-later    |
+| ifctester                 | Library, CLI and webapp for IDS model auditing                        | LGPL-3.0-or-later   |
+| ifcwrap                   | Internal library for IfcOpenShell                                     | LGPL-3.0-or-later\* |
+| qtviewer                  | Internal library for IfcOpenShell                                     | LGPL-3.0-or-later\* |
+| serializers               | Internal library for IfcOpenShell                                     | LGPL-3.0-or-later\* |
 
 [LGPL]: https://github.com/IfcOpenShell/IfcOpenShell/tree/master/COPYING.LESSER "LGPL-3.0-or-later"
 [IFC]: https://technical.buildingsmart.org/standards/ifc/ "IFC"

choco/blenderbim/blenderbim.nuspec

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. -->
+<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
+  <metadata>
+    <id>blenderbim-nightly</id>
+    <version>blenderbim_build_version-alpha</version>
+    <packageSourceUrl>https://github.com/IfcOpenShell/IfcOpenShell</packageSourceUrl>
+    <owners>fbpyr</owners>
+    <!-- == SOFTWARE SPECIFIC SECTION == -->
+    <title>BlenderBIM install nightly</title>
+    <authors>Dion Moult and many more, see: https://github.com/IfcOpenShell/IfcOpenShell/graphs/contributors</authors>
+    <projectUrl>https://github.com/IfcOpenShell/IfcOpenShell</projectUrl>
+    <iconUrl>https://rawcdn.githack.com/IfcOpenShell/IfcOpenShell/c6ee1d1679d1298de0d7447ff108c22709c68e54/choco/blenderbim/blenderbim.png</iconUrl>
+    <!-- <copyright>Year Software Vendor</copyright> -->
+    <licenseUrl>https://github.com/IfcOpenShell/IfcOpenShell/blob/v0.7.0/COPYING</licenseUrl>
+    <requireLicenseAcceptance>true</requireLicenseAcceptance>
+    <projectSourceUrl>https://github.com/IfcOpenShell/IfcOpenShell</projectSourceUrl>
+    <docsUrl>https://blenderbim.org/docs/</docsUrl>
+    <!--<mailingListUrl></mailingListUrl>-->
+    <bugTrackerUrl>https://github.com/IfcOpenShell/IfcOpenShell/issues</bugTrackerUrl>
+    <tags>blender bim blenderbim ifc python opensource foss</tags>
+    <summary>opensource bim</summary>
+    <description>opensource bim addon for blender - source code at: https://github.com/IfcOpenShell/IfcOpenShell</description>
+    <!-- <releaseNotes>__REPLACE_OR_REMOVE__MarkDown_Okay</releaseNotes> -->
+
+    <dependencies>
+      <dependency id="blender" version="latest_blender_version_maj_min_pat" />
+      <dependency id="7zip"    version="22.1"/>
+    </dependencies>
+  </metadata>
+  <files>
+    <file src="tools\**" target="tools" />
+  </files>
+</package>

choco/blenderbim/check_repo_infos.py

@@ -0,0 +1,80 @@
+import datetime
+import re
+import sys
+from urllib import request
+
+
+def request_repo_info(url: str):
+    req  = request.Request(url)
+    resp = request.urlopen(req)
+    if not resp.status == 200:
+        print(f"[ERROR] could not contact server: {url}")
+        quit(1)
+    return resp
+
+
+if sys.argv[1] == "--do_choco_release?":
+    now = datetime.datetime.now()
+    blenderbim_date = (now - datetime.timedelta(days=1)).strftime("%y%m%d")
+    url = "https://github.com/IfcOpenShell/IfcOpenShell/releases"
+    resp = request_repo_info(url)
+    text = str(resp.read())
+    if blenderbim_date in text:
+        print("do_choco_release", end="")
+
+
+elif sys.argv[1] == "--latest_blender_release_maj_min_pat?":
+    re_blender_version_min_maj_pat = r"Latest Version.+<span>Blender (\d+\.\d+\.\d+)</span>"
+    url = "https://community.chocolatey.org/packages/blender"
+    resp = request_repo_info(url)
+    html_txt = str(resp.read())
+    found = re.findall(re_blender_version_min_maj_pat, html_txt)
+    if found:
+        print(found[0], end="")
+
+
+elif sys.argv[1] == "--latest_blender_release_maj_min?":
+    re_blender_version_min_maj = r"Latest Version.+<span>Blender (\d+\.\d+)\..+</span>"
+    url = "https://community.chocolatey.org/packages/blender"
+    resp = request_repo_info(url)
+    html_txt = str(resp.read())
+    found = re.findall(re_blender_version_min_maj, html_txt)
+    if found:
+        print(found[0], end="")
+
+
+elif sys.argv[1] == "--latest_blender_python_version_maj_min?":
+    # get latest blender version first
+    re_blender_version_min_maj_pat = r"Latest Version.+<span>Blender (\d+\.\d+\.\d+)</span>"
+    url = "https://community.chocolatey.org/packages/blender"
+    resp = request_repo_info(url)
+    html_txt = str(resp.read())
+    found = re.findall(re_blender_version_min_maj_pat, html_txt)
+    if found:
+        latest_blender_version_tag = f"v{found[0]}"
+        re_blender_python_version_maj_min = r"SET\(PYTHON_VERSION (\d+.\d+) "
+        url = f"https://raw.githubusercontent.com/blender/blender/{latest_blender_version_tag}/build_files/cmake/Modules/FindPythonLibsUnix.cmake"
+        resp = request_repo_info(url)
+        html_txt = str(resp.read())
+        found = re.findall(re_blender_python_version_maj_min, html_txt)
+        if found:
+            print(found[0], end="")
+
+
+elif sys.argv[1] == "--pyver?":
+    # get latest blender version first
+    re_blender_version_min_maj_pat = r"Latest Version.+<span>Blender (\d+\.\d+\.\d+)</span>"
+    url = "https://community.chocolatey.org/packages/blender"
+    resp = request_repo_info(url)
+    html_txt = str(resp.read())
+    found = re.findall(re_blender_version_min_maj_pat, html_txt)
+    if found:
+        latest_blender_version_tag = f"v{found[0]}"
+        re_blender_python_version_maj_min = r"SET\(PYTHON_VERSION (\d+.\d+) "
+        url = f"https://raw.githubusercontent.com/blender/blender/{latest_blender_version_tag}/build_files/cmake/Modules/FindPythonLibsUnix.cmake"
+        resp = request_repo_info(url)
+        html_txt = str(resp.read())
+        found = re.findall(re_blender_python_version_maj_min, html_txt)
+        if found:
+            print(f"py{found[0].replace('.', '')}", end="")
+

choco/blenderbim/fill_dynamic_parameters.py

@@ -0,0 +1,49 @@
+import os
+from pathlib import Path
+
+
+print("[INFO] inserting dynamic chocolatey package parameters")
+HERE_DIR = Path(__file__).parent.absolute()
+# print(f"[INFO] HERE_DIR: {HERE_DIR}")
+
+topics = {
+    "spec": {
+        "path": HERE_DIR / "blenderbim.nuspec",
+        "env_vars": {
+            "latest_blender_version_maj_min_pat",
+            "blenderbim_build_version",
+        },
+    },
+    "install": {
+        "path": HERE_DIR / "tools" / "chocolateyinstall.ps1",
+        "env_vars": {
+            "url_blenderbim_py310_win_zip",
+            "sha256sum_blenderbim_py310_win_zip",
+            "latest_blender_version_maj_min",
+        },
+    },
+    "uninstall": {
+        "path": HERE_DIR / "tools" / "chocolateyuninstall.ps1",
+        "env_vars": {
+            "latest_blender_version_maj_min",
+        },
+    },
+}
+
+for topic, info in topics.items():
+    print(f"[INFO] {topic}:")
+    for env_var_name in info["env_vars"]:
+        print(f"[INFO] {env_var_name} exists?: {os.environ[env_var_name]}")
+
+    with open(info["path"], encoding="utf-8") as txt:
+        content = txt.read()
+
+    for env_var_name in info["env_vars"]:
+        # print(f"[INFO] replace: {env_var_name}")
+        content = content.replace(env_var_name, os.environ[env_var_name])
+
+    with open(info["path"], "w", encoding="utf-8") as txt:
+        txt.write(content)
+        print(f"[INFO] written: {info['path']}")
+
+print("[INFO] inserting dynamic chocolatey package parameters successful")

choco/blenderbim/tools/chocolateybeforemodify.ps1

@@ -0,0 +1,11 @@
+$processName      = "blender"
+$blenderIsRunning = Get-Process -Name $processName -ErrorAction SilentlyContinue
+
+if($blenderIsRunning -eq $null) {
+    echo "Blender is not running ready for next action."
+}
+else {
+    Write-Warning "$processName is still running - installer cannot safely proceed to next action."
+    Write-Warning "Please retry after closing all running blender applications."
+    exit 1
+}

choco/blenderbim/tools/chocolateyinstall.ps1

@@ -0,0 +1,29 @@
+$ErrorActionPreference = 'Stop'
+
+$url64          = 'url_blenderbim_py310_win_zip'
+$checksum64     = 'sha256sum_blenderbim_py310_win_zip'
+$checksumType64 = 'sha256'
+
+$appDataUserDir  = [System.Environment]::GetEnvironmentVariable('appdata')
+$unzipTargetDir  = "$appDataUserDir\Blender Foundation\Blender\latest_blender_version_maj_min\scripts\addons"
+
+$chocoBaseDir    = [System.Environment]::GetEnvironmentVariable('ChocolateyInstall')
+$addonEnable     = "$chocoBaseDir\lib\blenderbim-nightly\tools\enable_blenderbim_addon.py"
+
+$programFilesDir = [System.Environment]::GetEnvironmentVariable('ProgramFiles')
+$blenderExePath  = "$env:ProgramFiles\Blender Foundation\Blender latest_blender_version_maj_min\blender.exe"
+
+$processName      = "blender"
+$blenderIsRunning = Get-Process -Name $processName -ErrorAction SilentlyContinue
+
+
+if($blenderIsRunning -eq $null) {
+    echo "attempting to install blenderbim."
+    Install-ChocolateyZipPackage -PackageName $env:ChocolateyPackageName -Url64 $url64 -Checksum64 $checksum64 -checksumType $checksumType64 -UnzipLocation $unzipTargetDir
+    Start-Process -FilePath  $blenderExePath -ArgumentList "-b", "-y", "--python", "$addonEnable"
+}
+else {
+    Write-Warning "$processName is still running - blenderbim cannot be safely installed."
+    Write-Warning "Please retry after closing all running blender applications."
+    exit 1
+}

choco/blenderbim/tools/chocolateyuninstall.ps1

@@ -0,0 +1,22 @@
+$appDataUserDir = [System.Environment]::GetEnvironmentVariable('appdata')
+$unzippedDir = "$appDataUserDir\Blender Foundation\Blender\latest_blender_version_maj_min\scripts\addons\blenderbim"
+
+$chocoBaseDir    = [System.Environment]::GetEnvironmentVariable('ChocolateyInstall')
+$addonDisable     = "$chocoBaseDir\lib\blenderbim-nightly\tools\disable_blenderbim_addon.py"
+
+$programFilesDir = [System.Environment]::GetEnvironmentVariable('ProgramFiles')
+$blenderExePath  = "$env:ProgramFiles\Blender Foundation\Blender latest_blender_version_maj_min\blender.exe"
+
+$processName      = "blender"
+$blenderIsRunning = Get-Process -Name $processName -ErrorAction SilentlyContinue
+
+if($blenderIsRunning -eq $null) {
+    echo "attempting to uninstall blenderbim."
+    Start-Process -FilePath $blenderExePath -ArgumentList "-b", "-y", "--python", "$addonDisable"
+    Remove-Item -LiteralPath $unzippedDir -Force -Recurse
+}
+else {
+    Write-Warning "$processName is still running - blenderbim cannot be safely uninstalled."
+    Write-Warning "Please retry after closing all running blender applications."
+    exit 1
+}

choco/blenderbim/tools/disable_blenderbim_addon.py

@@ -0,0 +1,8 @@
+import bpy
+
+
+bpy.ops.preferences.addon_disable(module='blenderbim')
+bpy.ops.wm.save_userpref()
+
+print("disabled blenderbim addon successfully.")
+

choco/blenderbim/tools/enable_blenderbim_addon.py

@@ -0,0 +1,8 @@
+import bpy
+
+
+bpy.ops.preferences.addon_enable(module='blenderbim')
+bpy.ops.wm.save_userpref()
+
+print("enabled blenderbim addon successfully.")
+

cmake/CMakeLists.txt

@@ -38,7 +38,7 @@ MESSAGE(STATUS "Autodesk 3ds Max SDK found at ${max_sdk}")
 set(HAS_MAX TRUE)
 endif()
 endforeach()
-
+OPTION(MINIMAL_BUILD "The build is to make a minimal version of IFC converter from OCCT into IFC." OFF)
 OPTION(COLLADA_SUPPORT "Build IfcConvert with COLLADA support (requires OpenCOLLADA)." ON)
 OPTION(IFCXML_SUPPORT "Build IfcParse with ifcXML support (requires libxml2)." ON)
 OPTION(ENABLE_BUILD_OPTIMIZATIONS "Enable certain compiler and linker optimizations on RelWithDebInfo and Release builds." OFF)
@@ -53,6 +53,8 @@ OPTION(HDF5_SUPPORT "Enable HDF5 support (requires HDF5, zlib)" ON)
 OPTION(USE_VLD "Use Visual Leak Detector for debugging memory leaks, MSVC-only." OFF)
 OPTION(USE_MMAP "Adds a command line options to parse IFC files from memory mapped files using Boost.Iostreams" OFF)
 OPTION(BUILD_SHARED_LIBS "Build IfcParse and IfcGeom as shared libs (SO/DLL)." OFF)
+OPTION(MSVC_PARALLEL_BUILD "Multi-threaded compilation in Microsoft Visual Studio (/MP)" OFF)
+OPTION(WASM_BUILD OFF)
 if (${HAS_MAX})
 OPTION(BUILD_IFCMAX "Build IfcMax, a 3ds Max plug-in, Windows-only." OFF)
 endif()
@@ -60,9 +62,18 @@ if (${BUILD_CONVERT})
 OPTION(GLTF_SUPPORT "Build IfcConvert with glTF support (requires json.hpp)." OFF)
 endif()
 OPTION(USERSPACE_PYTHON_PREFIX "Installs IfcPython for the current user only instead of system-wide." OFF)
+OPTION(ADD_COMMIT_SHA "Add commit sha and branch in version number, warning results in many rebuilds, requires git" OFF)
 
-# TODO QtViewer is deprecated ATM as it uses the 0.4 API
-# OPTION(BUILD_QTVIEWER "Build IfcOpenShell Qt GUI Viewer (requires Qt 4 framework)." OFF)
+IF(NOT CMAKE_BUILD_TYPE)
+	SET(CMAKE_BUILD_TYPE "Release")
+ENDIF()
+
+if(MSVC AND MSVC_PARALLEL_BUILD)
+	add_definitions("/MP")
+endif()
+
+# QtViewer requires Qt5
+OPTION(BUILD_QTVIEWER "Build IfcOpenShell Qt GUI Viewer" OFF)
 include(GNUInstallDirs)
 if((BUILD_CONVERT OR BUILD_GEOMSERVER OR BUILD_IFCPYTHON) AND (NOT BUILD_IFCGEOM))
     message(STATUS "'IfcGeom' is required with current outputs")
@@ -116,6 +127,7 @@ ENDMACRO()
 
 UNIFY_ENVVARS_AND_CACHE(OCC_INCLUDE_DIR)
 UNIFY_ENVVARS_AND_CACHE(OCC_LIBRARY_DIR)
+if (NOT MINIMAL_BUILD)
 UNIFY_ENVVARS_AND_CACHE(OPENCOLLADA_INCLUDE_DIR)
 UNIFY_ENVVARS_AND_CACHE(OPENCOLLADA_LIBRARY_DIR)
 UNIFY_ENVVARS_AND_CACHE(LIBXML2_INCLUDE_DIR)
@@ -125,17 +137,28 @@ UNIFY_ENVVARS_AND_CACHE(PYTHON_EXECUTABLE)
 UNIFY_ENVVARS_AND_CACHE(HDF5_INCLUDE_DIR)
 UNIFY_ENVVARS_AND_CACHE(HDF5_LIBRARY_DIR)
 UNIFY_ENVVARS_AND_CACHE(HDF5_LIBRARIES)
+endif()
 UNIFY_ENVVARS_AND_CACHE(BOOST_ROOT)
 UNIFY_ENVVARS_AND_CACHE(BOOST_LIBRARYDIR)
 
+if (NOT MINIMAL_BUILD)
 UNIFY_ENVVARS_AND_CACHE(CGAL_INCLUDE_DIR)
 UNIFY_ENVVARS_AND_CACHE(CGAL_LIBRARY_DIR)
 UNIFY_ENVVARS_AND_CACHE(GMP_INCLUDE_DIR)
 UNIFY_ENVVARS_AND_CACHE(GMP_LIBRARY_DIR)
 UNIFY_ENVVARS_AND_CACHE(MPFR_INCLUDE_DIR)
 UNIFY_ENVVARS_AND_CACHE(MPFR_LIBRARY_DIR)
+endif()
 
-if (GLTF_SUPPORT AND BUILD_CONVERT)
+if(WASM_BUILD)
+    # when using the nix/build-all.py build script we should not
+    # look into the sysroot for most of the dependencies but rather
+    # in the designated build/ folder created by the script.
+    set(CMAKE_FIND_ROOT_PATH_BACKUP "${CMAKE_FIND_ROOT_PATH}")
+    set(CMAKE_FIND_ROOT_PATH "")
+endif()
+
+if (NOT MINIMAL_BUILD AND GLTF_SUPPORT AND BUILD_CONVERT)
 UNIFY_ENVVARS_AND_CACHE(JSON_INCLUDE_DIR)
 FIND_FILE(json_hpp "json.hpp" ${JSON_INCLUDE_DIR}/nlohmann)
 IF(json_hpp)
@@ -144,6 +167,7 @@ ELSE()
 	MESSAGE(FATAL_ERROR "Unable to find JSON for Modern C++ header file, aborting")
 ENDIF()
 add_definitions(-DWITH_GLTF)
+set(SWIG_DEFINES ${SWIG_DEFINES} -DWITH_GLTF)
 endif()
 
 # Set INSTALL_RPATH for target
@@ -184,7 +208,14 @@ ELSE()
     ENDIF()
 ENDIF()
 
-set(BOOST_COMPONENTS system program_options regex thread date_time)
+if (WASM_BUILD)
+    set(BOOST_COMPONENTS)
+else()
+    # @todo review this, shouldn't this be all possible header-only now?
+    # ... or rewritten using C++17 features?
+    set(BOOST_COMPONENTS system program_options regex thread date_time)
+endif()
+
 if(USE_MMAP)
     if(MSVC)
         # filesystem is necessary for the utf-16 wpath
@@ -195,17 +226,19 @@ if(USE_MMAP)
     add_definitions(-DUSE_MMAP)
 endif()
 
-# libxml2 is required for IFCXML (optional) and SVGFILL (mandatory)
-find_package(LibXml2 REQUIRED)
-
-if (IFCXML_SUPPORT)
-    add_definitions(-DWITH_IFCXML)
-endif()
-
 FIND_PACKAGE(Boost REQUIRED COMPONENTS ${BOOST_COMPONENTS})
 MESSAGE(STATUS "Boost include files found in ${Boost_INCLUDE_DIRS}")
 MESSAGE(STATUS "Boost libraries found in ${Boost_LIBRARY_DIRS}")
 
+if (NOT MINIMAL_BUILD)
+# libxml2 is required for IFCXML (optional) and SVGFILL (mandatory)
+  find_package(LibXml2 REQUIRED)
+endif()
+
+if (NOT MINIMAL_BUILD AND IFCXML_SUPPORT)
+    add_definitions(-DWITH_IFCXML)
+	set(SWIG_DEFINES ${SWIG_DEFINES} -DWITH_IFCXML)
+endif()
 
 # Usage:
 # set(SOME_LIRARIES foo bar)
@@ -270,6 +303,9 @@ ENDIF()
 SET(OPENCASCADE_LIBRARY_NAMES
     TKernel TKMath TKBRep TKGeomBase TKGeomAlgo TKG3d TKG2d TKShHealing TKTopAlgo TKMesh TKPrim TKBool TKBO
     TKFillet TKSTEP TKSTEPBase TKSTEPAttr TKXSBase TKSTEP209 TKIGES TKOffset TKHLR
+    
+    # @todo investigate the exact conditions when this is necessary
+    TKBin
 )
 
 IF("${OCC_LIBRARY_DIR}" STREQUAL "")
@@ -322,10 +358,21 @@ if("${libTKernelExt}" STREQUAL ".a")
     set(OCCT_STATIC ON)
 endif()
 
+if(WASM_BUILD)
+    set(CMAKE_FIND_ROOT_PATH "${CMAKE_FIND_ROOT_PATH_BACKUP}")
+endif()
+
 if(OCCT_STATIC)
     find_package(Threads)
-    # OPENCASCADE_LIBRARIES repeated three times below in order to fix cyclic dependencies - use --start-group ... --end-group instead?
-    set(OPENCASCADE_LIBRARIES ${OPENCASCADE_LIBRARIES} ${OPENCASCADE_LIBRARIES} ${OPENCASCADE_LIBRARIES} ${OPENCASCADE_LIBRARIES} ${OPENCASCADE_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+    
+    if(WASM_BUILD)
+        set(OPENCASCADE_LIBRARIES ${OPENCASCADE_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+    else()
+        # OPENCASCADE_LIBRARIES repeated N times below in order to fix cyclic dependencies - use --start-group ... --end-group instead?
+        # tfk: --start-group ... --end-group didn't work on the apple linker when last tested
+        set(OPENCASCADE_LIBRARIES ${OPENCASCADE_LIBRARIES} ${OPENCASCADE_LIBRARIES} ${OPENCASCADE_LIBRARIES} ${OPENCASCADE_LIBRARIES} ${OPENCASCADE_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+    endif()
+    
     if (NOT APPLE AND NOT WIN32)
         set(OPENCASCADE_LIBRARIES ${OPENCASCADE_LIBRARIES} "rt")
     endif()
@@ -336,7 +383,7 @@ endif()
 
 endif(BUILD_IFCGEOM)
 
-IF(COLLADA_SUPPORT)
+IF(NOT MINIMAL_BUILD AND COLLADA_SUPPORT)
 	# Find OpenCOLLADA
 	IF("${OPENCOLLADA_INCLUDE_DIR}" STREQUAL "")
 		MESSAGE(STATUS "No OpenCOLLADA include directory specified")
@@ -368,6 +415,8 @@ IF(COLLADA_SUPPORT)
 	IF(COLLADASWStreamWriter_h)
 		MESSAGE(STATUS "OpenCOLLADA header files found")
 		ADD_DEFINITIONS(-DWITH_OPENCOLLADA)
+		set(SWIG_DEFINES ${SWIG_DEFINES} -DWITH_OPENCOLLADA)
+
 		SET(OPENCOLLADA_LIBRARY_NAMES
 			GeneratedSaxParser MathMLSolver OpenCOLLADABaseUtils OpenCOLLADAFramework OpenCOLLADASaxFrameworkLoader
 			OpenCOLLADAStreamWriter UTF buffer ftoa
@@ -414,7 +463,7 @@ IF(COLLADA_SUPPORT)
 	ENDIF()
 ENDIF()
 
-if(HDF5_SUPPORT)
+if(NOT MINIMAL_BUILD AND HDF5_SUPPORT)
     IF("${HDF5_INCLUDE_DIR}" STREQUAL "")
 		MESSAGE(STATUS "No HDF5 include directory specified")
 	ElSE()
@@ -429,42 +478,73 @@ if(HDF5_SUPPORT)
 
     if (HDF5_LIBRARY_DIR)
     	# result of the HDF5 ctest package
-    	
-        if (WIN32)
-        	set(zlib_post lib)
-        	set(lib_ext lib)
-        else()
-        	set(lib_ext a)
+        # Find zlib using cmake find_library. How should this be implemented?
+        # FIND_LIBRARY(NAMES z libz libz_debug PATHS ... NO_DEFAULT_PATH)
+
+
+        if ("$ENV{CONDA_BUILD}" STREQUAL "")
+            # result of the HDF5 ctest package
+
+            if (WIN32)
+                set(zlib_post lib)
+                set(lib_ext lib)
+            else()
+                set(lib_ext a)
+            endif()
+
+            if ("${CMAKE_BUILD_TYPE}" STREQUAL "Debug")
+                set(debug_postfix "_debug")
+            endif()
+
+            SET(HDF5_LIBRARIES
+                    "${HDF5_LIBRARY_DIR}/libhdf5_cpp${debug_postfix}.${lib_ext}"
+                    "${HDF5_LIBRARY_DIR}/libhdf5${debug_postfix}.${lib_ext}"
+                    "${HDF5_LIBRARY_DIR}/libz${zlib_post}${debug_postfix}.${lib_ext}"
+                    "${HDF5_LIBRARY_DIR}/libsz${debug_postfix}.${lib_ext}"
+                    "${HDF5_LIBRARY_DIR}/libaec${debug_postfix}.${lib_ext}"
+                    )
+
+        ELSE()
+            MESSAGE(STATUS "Packaging hdf5 and zlib for conda distribution")
+            if (WIN32)
+                # Windows
+                set(zlib_post zlib)
+                set(lib_ext lib)
+            elseif(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
+                # macOS
+                set(zlib_post libz)
+                set(lib_ext dylib)
+            else()
+                # linux
+                set(zlib_post libz)
+                set(lib_ext so)
+            endif()
+
+            SET(HDF5_LIBRARIES
+                    "${HDF5_LIBRARY_DIR}/libhdf5_cpp.${lib_ext}"
+                    "${HDF5_LIBRARY_DIR}/libhdf5.${lib_ext}"
+                    "${HDF5_LIBRARY_DIR}/${zlib_post}.${lib_ext}"
+                    )
         endif()
-        
-        SET(HDF5_LIBRARIES 
-            "${HDF5_LIBRARY_DIR}/libhdf5_cpp.${lib_ext}"
-            "${HDF5_LIBRARY_DIR}/libhdf5.${lib_ext}"
-            "${HDF5_LIBRARY_DIR}/libz${zlib_post}.${lib_ext}"
-            "${HDF5_LIBRARY_DIR}/libsz.${lib_ext}"
-            "${HDF5_LIBRARY_DIR}/libaec.${lib_ext}"
-        )
+
     endif()
-    
+
     if (NOT HDF5_LIBRARIES)
     	# debian default
-    	
+
         SET(HDF5_LIBRARIES
-            /usr/lib/x86_64-linux-gnu/hdf5/serial/libhdf5_cpp.a
-            /usr/lib/x86_64-linux-gnu/hdf5/serial/libhdf5.a
-            /usr/lib/x86_64-linux-gnu/libsz.a
-            /usr/lib/x86_64-linux-gnu/libaec.a
+            /usr/lib/x86_64-linux-gnu/hdf5/serial/libhdf5_cpp.so
+            /usr/lib/x86_64-linux-gnu/hdf5/serial/libhdf5.so
+            /usr/lib/x86_64-linux-gnu/libsz.so
+            /usr/lib/x86_64-linux-gnu/libaec.so
             z dl
         )
     endif()
     
     add_definitions(-DWITH_HDF5)
+	set(SWIG_DEFINES ${SWIG_DEFINES} -DWITH_HDF5)
 endif()
 
-IF(NOT CMAKE_BUILD_TYPE)
-	SET(CMAKE_BUILD_TYPE "Release")
-ENDIF()
-
 if(ENABLE_BUILD_OPTIMIZATIONS)
 	if(MSVC)
         # NOTE: RelWithDebInfo and Release use O2 (= /Ox /Gl /Gy/ = Og /Oi /Ot /Oy /Ob2 /Gs /GF /Gy) by default,
@@ -566,13 +646,21 @@ function(files_for_ifc_version IFC_VERSION RESULT_NAME)
 endfunction()
 
 if(NOT SCHEMA_VERSIONS)
-    set(SCHEMA_VERSIONS "2x3" "4" "4x1" "4x2" "4x3_rc1" "4x3_rc2" "4x3_rc3" "4x3_rc4")
+    if(WASM_BUILD)
+        # super arbitrarily try to keep size down at least a little bit
+        set(SCHEMA_VERSIONS "2x3" "4")
+    else()
+        set(SCHEMA_VERSIONS "2x3" "4" "4x1" "4x2" "4x3_rc1" "4x3_rc2" "4x3_rc3" "4x3_rc4" "4x3" "4x3_tc1" "4x3_add1")
+    endif()
 endif()
 
 foreach(s ${SCHEMA_VERSIONS})
 	add_definitions(-DHAS_SCHEMA_${s})
 endforeach()
 
+string(REPLACE ";" ")(" schema_version_seq "(${SCHEMA_VERSIONS})")
+ADD_DEFINITIONS(-DSCHEMA_SEQ=${schema_version_seq})
+
 if(COMPILE_SCHEMA)
 	# @todo, this appears to be untested at the moment
 
@@ -640,9 +728,13 @@ if (BUILD_IFCGEOM)
 	foreach(s ${SCHEMA_VERSIONS})
 		set(IFCGEOM_SCHEMA_LIBRARIES ${IFCGEOM_SCHEMA_LIBRARIES} IfcGeom_ifc${s})
 	endforeach()
-	set(IFCOPENSHELL_LIBRARIES ${IFCOPENSHELL_LIBRARIES} IfcGeom ${IFCGEOM_SCHEMA_LIBRARIES} IfcGeom ${IFCGEOM_SCHEMA_LIBRARIES})
+	if (WASM_BUILD)
+	    set(IFCOPENSHELL_LIBRARIES ${IFCOPENSHELL_LIBRARIES} IfcGeom ${IFCGEOM_SCHEMA_LIBRARIES})
+	else()
+	    set(IFCOPENSHELL_LIBRARIES ${IFCOPENSHELL_LIBRARIES} IfcGeom ${IFCGEOM_SCHEMA_LIBRARIES} IfcGeom ${IFCGEOM_SCHEMA_LIBRARIES})	
+	endif()
 endif()
-if (BUILD_CONVERT)
+if (BUILD_CONVERT OR BUILD_IFCPYTHON)
 	foreach(s ${SCHEMA_VERSIONS})
 		set(SERIALIZER_SCHEMA_LIBRARIES ${SERIALIZER_SCHEMA_LIBRARIES} Serializers_ifc${s})
 	endforeach()
@@ -684,19 +776,25 @@ set(IFCPARSE_FILES ${IFCPARSE_CPP_FILES} ${IFCPARSE_H_FILES})
 add_library(IfcParse ${IFCPARSE_FILES})
 set_target_properties(IfcParse PROPERTIES COMPILE_FLAGS -DIFC_PARSE_EXPORTS VERSION "0.6.0" SOVERSION "0.6")
 
-TARGET_LINK_LIBRARIES(IfcParse ${Boost_LIBRARIES} ${BCRYPT_LIBRARIES} ${LIBXML2_LIBRARIES})
+if (WASM_BUILD)
+    TARGET_LINK_LIBRARIES(IfcParse ${BCRYPT_LIBRARIES} ${LIBXML2_LIBRARIES})
+else()
+    TARGET_LINK_LIBRARIES(IfcParse ${Boost_LIBRARIES} ${BCRYPT_LIBRARIES} ${LIBXML2_LIBRARIES})
+endif()
 
 if (BUILD_IFCGEOM)
 
 # IfcGeom
-file(GLOB IFCGEOM_H_FILES ../src/ifcgeom/*.h)
+file(GLOB IFCGEOM_H_FILES ../src/ifcgeom/*.h ../src/ifcgeom/*.i)
 file(GLOB IFCGEOM_CPP_FILES ../src/ifcgeom/*.cpp)
 set(IFCGEOM_FILES ${IFCGEOM_CPP_FILES} ${IFCGEOM_H_FILES})
 
 foreach(s ${SCHEMA_VERSIONS})
 	add_library(IfcGeom_ifc${s} STATIC ${IFCGEOM_FILES})
 	set_target_properties(IfcGeom_ifc${s} PROPERTIES COMPILE_FLAGS "-DIFC_GEOM_EXPORTS -DIfcSchema=Ifc${s}")
-	TARGET_LINK_LIBRARIES(IfcGeom_ifc${s} IfcParse ${OPENCASCADE_LIBRARIES})
+	if (NOT WASM_BUILD)
+	    TARGET_LINK_LIBRARIES(IfcGeom_ifc${s} IfcParse ${OPENCASCADE_LIBRARIES})	    
+	endif()
 endforeach()
 
 # IfcGeom (schema agnostic)
@@ -711,11 +809,15 @@ if (UNIX)
 find_package(Threads)
 endif()
 
-TARGET_LINK_LIBRARIES(IfcGeom IfcParse ${IFCGEOM_SCHEMA_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+if (WASM_BUILD)
+    TARGET_LINK_LIBRARIES(IfcGeom ${IFCGEOM_SCHEMA_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+else()
+    TARGET_LINK_LIBRARIES(IfcGeom IfcParse ${IFCGEOM_SCHEMA_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+endif()
 
 endif(BUILD_IFCGEOM)
 
-if (BUILD_CONVERT)
+if (BUILD_CONVERT OR BUILD_IFCPYTHON)
 
 # Serializers
 file(GLOB SERIALIZERS_H_FILES ../src/serializers/*.h)
@@ -728,7 +830,12 @@ set(SERIALIZERS_S_FILES ${SERIALIZERS_S_H_FILES} ${SERIALIZERS_S_CPP_FILES})
 foreach(s ${SCHEMA_VERSIONS})
 	add_library(Serializers_ifc${s} STATIC ${SERIALIZERS_S_FILES})
 	set_target_properties(Serializers_ifc${s} PROPERTIES COMPILE_FLAGS "-DIFC_GEOM_EXPORTS -DIfcSchema=Ifc${s} ${CONVERT_PRECISION}")
-	TARGET_LINK_LIBRARIES(Serializers_ifc${s} IfcGeom ${OPENCASCADE_LIBRARIES} ${HDF5_LIBRARIES})
+	
+	if (WASM_BUILD)
+	    TARGET_LINK_LIBRARIES(Serializers_ifc${s} ${HDF5_LIBRARIES})
+	else()
+	    TARGET_LINK_LIBRARIES(Serializers_ifc${s} IfcGeom ${OPENCASCADE_LIBRARIES} ${HDF5_LIBRARIES})
+	endif()
 endforeach()
 
 add_library(Serializers ${SERIALIZERS_FILES})
@@ -736,6 +843,10 @@ set_target_properties(Serializers PROPERTIES COMPILE_FLAGS "-DIFC_GEOM_EXPORTS $
 
 TARGET_LINK_LIBRARIES(Serializers ${SERIALIZER_SCHEMA_LIBRARIES} ${OPENCOLLADA_LIBRARIES})
 
+endif(BUILD_CONVERT or BUILD_IFCPYTHON)
+
+if (BUILD_CONVERT)
+
 # IfcConvert
 file(GLOB IFCCONVERT_CPP_FILES ../src/ifcconvert/*.cpp)
 file(GLOB IFCCONVERT_H_FILES ../src/ifcconvert/*.h)
@@ -761,7 +872,7 @@ INSTALL(TARGETS IfcConvert
 endif(BUILD_CONVERT)
 
 # IfcGeomServer
-if(BUILD_GEOMSERVER)
+if(NOT MINIMAL_BUILD AND BUILD_GEOMSERVER)
 
 file(GLOB CPP_FILES ../src/ifcgeomserver/*.cpp)
 file(GLOB H_FILES ../src/ifcgeomserver/*.h)
@@ -781,21 +892,21 @@ INSTALL(TARGETS IfcGeomServer
 
 endif()
 
+if (ADD_COMMIT_SHA)
 find_package (Git)
 if (GIT_FOUND)
 	message("git found: ${GIT_EXECUTABLE} with version ${GIT_VERSION_STRING}")
 	execute_process(
-		COMMAND ${GIT_EXECUTABLE} show -s --pretty=%D HEAD
+		COMMAND ${GIT_EXECUTABLE} branch --contains HEAD
 		OUTPUT_VARIABLE git_branches
 		OUTPUT_STRIP_TRAILING_WHITESPACE
 	)
-	string(REPLACE ", " ";" git_branch_list "${git_branches}")
-	string(REPLACE " -> " ";" git_branch_list "${git_branch_list}")
+	string(REPLACE "\n" ";" git_branch_list "${git_branches}")
 	foreach(git_branch_candidate IN ITEMS ${git_branch_list})
-		if (NOT git_branch_candidate MATCHES "/")
-			if (NOT git_branch_candidate MATCHES "^HEAD$")
-				set(git_branch ${git_branch_candidate})
-			endif()
+		string(REPLACE "*" "" git_branch_candidate_temp "${git_branch_candidate}")
+		string(STRIP "${git_branch_candidate_temp}" git_branch_candidate_2)
+		if (NOT git_branch_candidate_2 MATCHES "^HEAD$")
+			set(git_branch ${git_branch_candidate_2})
 		endif()
 	endforeach()
 	execute_process(
@@ -803,11 +914,12 @@ if (GIT_FOUND)
 		OUTPUT_VARIABLE git_sha
 		OUTPUT_STRIP_TRAILING_WHITESPACE
 	)
-	message(STATUS "IfcOpenShell branch ${git_branch}")
-	message(STATUS "IfcOpenShell commit ${git_sha}")
+	message(STATUS "IfcOpenShell branch: \"${git_branch}\"")
+	message(STATUS "IfcOpenShell commit: \"${git_sha}\"")
 	add_definitions(-DIFCOPENSHELL_BRANCH=${git_branch})
 	add_definitions(-DIFCOPENSHELL_COMMIT=${git_sha})
 endif()
+endif()
 
 # Documentation
 IF(BUILD_DOCUMENTATION)
@@ -815,7 +927,7 @@ IF(BUILD_DOCUMENTATION)
 	ADD_SUBDIRECTORY(../docs docs)
 ENDIF()
 
-IF(BUILD_IFCPYTHON)
+IF(NOT MINIMAL_BUILD AND BUILD_IFCPYTHON)
 	ADD_SUBDIRECTORY(../src/ifcwrap ifcwrap)
 ENDIF()
 
@@ -823,11 +935,12 @@ IF(BUILD_EXAMPLES)
 	ADD_SUBDIRECTORY(../src/examples examples)
 ENDIF()
 
-IF(BUILD_IFCMAX)
+IF(NOT MINIMAL_BUILD AND BUILD_IFCMAX)
 	ADD_SUBDIRECTORY(../src/ifcmax ifcmax)
 ENDIF()
-
+if (NOT MINIMAL_BUILD)
 ADD_SUBDIRECTORY(../src/svgfill svgfill)
+endif()
 
 # CMake installation targets
 INSTALL(FILES ${IFCPARSE_H_FILES}
@@ -872,6 +985,9 @@ INSTALL(FILES  ${SERIALIZERS_S_FILES}
 )
 endif()
 
+IF(BUILD_QTVIEWER)
+    ADD_SUBDIRECTORY(../src/qtviewer qtviewer)
+endif()
 
 list(APPEND CPACK_SOURCE_IGNORE_FILES
   .git
@@ -896,12 +1012,12 @@ set(CPACK_SOURCE_GENERATOR "TGZ")
 
 FOREACH(COMPONENT IN ITEMS ${BOOST_COMPONENTS})
     string(REPLACE "_" "-" COMP ${COMPONENT})
-    set(BOOST_DEPS "${BOOST_DEPS}, libboost-${COMP}1.67.0")
+    set(BOOST_DEPS "${BOOST_DEPS}, libboost-${COMP}-dev")
 endforeach(COMPONENT)
 
 set(CPACK_DEBIAN_PACKAGE_NAME "${PROJECT_NAME}")
 set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${CPACK_PACKAGE_CONTACT}")
-set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3, libxml2, liboce-foundation11, liboce-modeling11, liboce-ocaf11, liboce-visualization11, liboce-ocaf-lite11, libpython3.8 ${BOOST_DEPS}")
+set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3, libxml2, libocct-foundation-dev, libocct-modeling-algorithms-dev, libocct-modeling-data-dev, libocct-ocaf-dev, libocct-visualization-dev, libocct-data-exchange-dev, libhdf5-serial-dev, libpython3.8, python3-pytest ${BOOST_DEPS}")
 set(CPACK_DEBIAN_PACKAGE_DESCRIPTION_SUMMARY "${CPACK_PACKAGE_DESCRIPTION_SUMMARY}")
 set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "${CPACK_PACKAGE_DESCRIPTION}")
 set(CPACK_DEBIAN_PACKAGE_PRIORITY "optional")

conda/Makefile

@@ -0,0 +1,8 @@
+compile:
+	conda activate conda-build && conda-build -c conda-forge . --keep-old-work --python 3.10.5
+
+debug:
+	conda activate conda-build && conda-debug -c conda-forge . --python 3.10.4
+
+env:
+	conda env update --f environment.yml --prune

conda/bld.bat

@@ -1,29 +1,44 @@
 mkdir build && cd build
 
-REM Remove dot from PY_VER for use in library name
-REM From https://github.com/tpaviot/pythonocc-core/blob/master/ci/conda/bld.bat
 set MY_PY_VER=%PY_VER:.=%
+set LIBXML2="%LIBRARY_PREFIX%/lib/libxml2.lib"
 
-cmake -G "NMake Makefiles" ^
- -DCMAKE_INSTALL_PREFIX="%LIBRARY_PREFIX%" ^
- -DCMAKE_BUILD_TYPE=Release ^
- -DCMAKE_PREFIX_PATH="%LIBRARY_PREFIX%" ^
- -DCMAKE_SYSTEM_PREFIX_PATH="%LIBRARY_PREFIX%" ^
- -DPYTHON_EXECUTABLE="%PYTHON%" ^
- -DPYTHON_INCLUDE_DIR="%PREFIX%"/include ^
- -DPYTHON_LIBRARY="%PREFIX%"/libs/python%MY_PY_VER%.lib ^
- -DBOOST_LIBRARYDIR="%LIBRARY_PREFIX%\lib" ^
- -DBOOST_INCLUDEDIR="%LIBRARY_PREFIX%\include" ^
- -DOCC_INCLUDE_DIR="%LIBRARY_PREFIX%\include\oce" ^
- -DOCC_LIBRARY_DIR="%LIBRARY_PREFIX%\lib" ^
- -DCOLLADA_SUPPORT=Off ^
- -DBUILD_EXAMPLES=Off ^
- -DBUILD_GEOMSERVER=Off ^
- -DBUILD_CONVERT=Off ^
- ../cmake
- 
-if errorlevel 1 exit 1
-
-cmake --build . --target INSTALL --config Release
+cmake -G "Ninja" ^
+ -D CMAKE_BUILD_TYPE:STRING=Release ^
+ -D CMAKE_INSTALL_PREFIX:FILEPATH="%LIBRARY_PREFIX%" ^
+ -D CMAKE_PREFIX_PATH:FILEPATH="%LIBRARY_PREFIX%" ^
+ -D CMAKE_SYSTEM_PREFIX_PATH:FILEPATH="%LIBRARY_PREFIX%" ^
+ -D OCC_INCLUDE_DIR:FILEPATH="%LIBRARY_PREFIX%\include\opencascade" ^
+ -D OCC_LIBRARY_DIR:FILEPATH="%LIBRARY_PREFIX%\lib" ^
+ -D CGAL_INCLUDE_DIR:FILEPATH="%LIBRARY_PREFIX%\include" ^
+ -D GMP_INCLUDE_DIR:FILEPATH="%LIBRARY_PREFIX%\include" ^
+ -D GMP_LIBRARY_DIR:FILEPATH="%LIBRARY_PREFIX%\lib" ^
+ -D MPFR_LIBRARY_DIR:FILEPATH="%LIBRARY_PREFIX%\lib" ^
+ -D COLLADA_SUPPORT=OFF ^
+ -D HDF5_SUPPORT=ON ^
+ -D HDF5_INCLUDE_DIR="%LIBRARY_PREFIX%\include" ^
+ -D HDF5_LIBRARY_DIR="%LIBRARY_PREFIX%\lib" ^
+ -D JSON_INCLUDE_DIR="%LIBRARY_PREFIX%\include" ^
+ -D PYTHON_INCLUDE_DIR=%PREFIX%\include ^
+ -D PYTHON_EXECUTABLE:FILEPATH=%PREFIX%\python.exe ^
+ -D PYTHON_LIBRARY:FILEPATH="%PREFIX%"\libs/python%MY_PY_VER%.lib ^
+ -D BUILD_IFCPYTHON=ON ^
+ -D BUILD_IFCGEOM=ON ^
+ -D COLLADA_SUPPORT:BOOL=OFF ^
+ -D BUILD_EXAMPLES:BOOL=OFF ^
+ -D BUILD_GEOMSERVER:BOOL=OFF ^
+ -D GLTF_SUPPORT:BOOL=ON ^
+ -D BUILD_CONVERT:BOOL=ON ^
+ -D BUILD_IFCMAX:BOOL=OFF ^
+ -D IFCXML_SUPPORT:BOOL=ON ^
+ -D Boost_LIBRARYDIR:FILEPATH="%LIBRARY_PREFIX%\lib" ^
+ -D Boost_INCLUDEDIR:FILEPATH="%LIBRARY_PREFIX%\include" ^
+ -D Boost_USE_STATIC_LIBS:BOOL=OFF ^
+ %SRC_DIR%/cmake
+
+if errorlevel 1 exit 1
+
+:: Build and install
+cmake --build . -- install
 
 if errorlevel 1 exit 1

conda/build.sh

@@ -1,34 +1,44 @@
-# From https://github.com/tpaviot/pythonocc-core/blob/master/ci/conda/build.sh
-if [ "$PY3K" == "1" ]; then
-    MY_PY_VER="${PY_VER}m"
-else
-    MY_PY_VER="${PY_VER}"
+#!/bin/bash
+
+declare -a CMAKE_PLATFORM_FLAGS
+
+if [[ ${HOST} =~ .*linux.* ]]; then
+    CMAKE_PLATFORM_FLAGS+=(-DCMAKE_TOOLCHAIN_FILE=$RECIPE_DIR/cross-linux.cmake)
 fi
 
 if [ `uname` == Darwin ]; then
-    PY_LIB="libpython${MY_PY_VER}.dylib"
-    export   CFLAGS="$CFLAGS   -Wl,-flat_namespace,-undefined,suppress"
-    export CXXFLAGS="$CXXFLAGS -Wl,-flat_namespace,-undefined,suppress"
-    export  LDFLAGS="$LDFLAGS  -Wl,-flat_namespace,-undefined,suppress"
-else
-    PY_LIB="libpython${MY_PY_VER}.so"
+  export CFLAGS="$CFLAGS   -Wl,-flat_namespace,-undefined,suppress"
+  export CXXFLAGS="$CXXFLAGS -Wl,-flat_namespace,-undefined,suppress"
+  export LDFLAGS="$LDFLAGS  -Wl,-flat_namespace,-undefined,suppress"
 fi
 
-mkdir build && cd build
-
-cmake \
- -DCMAKE_INSTALL_PREFIX=$PREFIX \
+cmake -G Ninja \
  -DCMAKE_BUILD_TYPE=Release \
+ -DCMAKE_INSTALL_PREFIX=$PREFIX \
+  ${CMAKE_PLATFORM_FLAGS[@]} \
  -DCMAKE_PREFIX_PATH=$PREFIX \
  -DCMAKE_SYSTEM_PREFIX_PATH=$PREFIX \
- -DOCC_INCLUDE_DIR=$PREFIX/include/oce \
- -DOCC_LIBRARY_DIR=$PREFIX/lib \
  -DPYTHON_EXECUTABLE:FILEPATH=$PYTHON \
- -DPYTHON_INCLUDE_DIR:PATH=$PREFIX/include/python$MY_PY_VER \
- -DPYTHON_LIBRARY:FILEPATH=$PREFIX/lib/${PY_LIB} \
- -DCOLLADA_SUPPORT=Off \
- ../cmake
+ -DGMP_LIBRARY_DIR=$PREFIX/lib \
+ -DMPFR_LIBRARY_DIR=$PREFIX/lib \
+ -DOCC_INCLUDE_DIR=$PREFIX/include/opencascade \
+ -DOCC_LIBRARY_DIR=$PREFIX/lib \
+ -DHDF5_SUPPORT:BOOL=ON \
+ -DHDF5_INCLUDE_DIR=$PREFIX/include \
+ -DHDF5_LIBRARY_DIR=$PREFIX/lib \
+ -DJSON_INCLUDE_DIR=$PREFIX/include \
+ -DCGAL_INCLUDE_DIR=$PREFIX/include \
+ -DCOLLADA_SUPPORT=0 \
+ -DBUILD_EXAMPLES:BOOL=OFF \
+ -DIFCXML_SUPPORT:BOOL=ON \
+ -DGLTF_SUPPORT:BOOL=ON \
+ -DBUILD_CONVERT:BOOL=ON \
+ -DBUILD_IFCPYTHON:BOOL=ON \
+ -DBUILD_IFCGEOM:BOOL=ON \
+ -DBUILD_GEOMSERVER:BOOL=OFF \
+ -DBOOST_USE_STATIC_LIBS:BOOL=OFF \
+ ./cmake
 
-make -j$CPU_COUNT _ifcopenshell_wrapper
-cd ifcwrap
-make install/local
+ninja
+
+ninja install -j 2

conda/conda_build_config.yaml

@@ -0,0 +1,2 @@
+CONDA_BUILD_SYSROOT:
+  - /opt/MacOSX10.13.sdk       # [osx]

conda/cross-linux.cmake

@@ -0,0 +1,16 @@
+# this one is important
+set(CMAKE_SYSTEM_NAME Linux)
+set(CMAKE_PLATFORM Linux)
+
+# specify the cross compiler
+set(CMAKE_C_COMPILER $ENV{CC})
+set(CMAKE_CXX_COMPILER $ENV{CXX})
+
+# where is the target environment
+set(CMAKE_FIND_ROOT_PATH $ENV{PREFIX} $ENV{BUILD_PREFIX}/$ENV{HOST}/sysroot)
+
+# search for programs in the build host directories
+set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
+# for libraries and headers in the target directories
+set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)

conda/environment.yml

@@ -0,0 +1,13 @@
+name: conda-build
+channels:
+  - conda-forge
+dependencies:
+  - conda-build
+  - conda-verify
+  - anaconda-client
+  - ninja
+  - doxygen
+  - ripgrep
+  - pip
+  - pip:
+      - lief==0.13

conda/meta.yaml

@@ -1,36 +1,63 @@
+{% set name = "ifcopenshell" %}
+{% set version = "0.7.0" %}
+
+
 package:
-  name: ifcopenshell
-  version: "0.6.0a1"
+  name: {{ name }}
+  version: {{ version }}
 
 source:
-  git_rev: "v0.6.0a1"
-  git_url: https://github.com/IfcOpenShell/IfcOpenShell
+  path: ..
 
 build:
-  number: 0
-  features:
-    - vc9     # [win and py27]
-    - vc10    # [win and py34]
-    - vc14    # [win and py35]
-    - vc14    # [win and py36]
+  binary_relocation: false [osx]
+  number: 1
 
 requirements:
   build:
-    - gcc     # [osx]
-    - make
-    - python
-    - oce ==0.18.3
+    - {{ compiler('c') }}
+    - {{ compiler('cxx') }}
+    - ninja >=1.10.2
     - cmake
-    - swig >=3.0.9
-    - libboost
-    - icu
-  run:
-    - libgcc  # [osx]
+    - swig >=4.0.2
+
+  host:
     - python
-    - oce ==0.18.3
-    - libboost
-    - icu
+    - boost-cpp
+    - occt
+    - libxml2
+    - cgal-cpp
+    - hdf5
+    - mpfr
+    - gmp  # [unix]
+    - mpir  # [win]
+    - nlohmann_json
+    - zlib
+
+  run:
+    - python
+    - boost-cpp
+    - {{ pin_compatible('occt', max_pin='x.x.x') }}
+    - libxml2
+    - cgal-cpp
+    - hdf5
+    - mpfr
+    - gmp  # [unix]
+    - mpir  # [win]
+    - nlohmann_json
+    - zlib
+
+test:
+  imports:
+    - ifcopenshell
 
 about:
   home: http://ifcopenshell.org
-  license: LGPL
+  license: LGPL-3.0-or-later
+  license_file: COPYING
+  summary: 'IfcOpenShell is a library to support the IFC file format'
+  description: |
+    IfcOpenShell is an open source (LGPL) software library for 
+    working with the Industry Foundation Classes (IFC) file format.
+  doc_url: http://ifcopenshell.org/
+  dev_url: https://github.com/IfcOpenShell/IfcOpenShell

nix/patches/boost/boostorg_regex_62.patch

@@ -0,0 +1,20 @@
+--- a/tools/build/src/tools/emscripten.jam
++++ b/tools/build/src/tools/emscripten.jam
+@@ -6,6 +6,7 @@
+ import feature ;
+ import os ;
+ import toolset ;
++import generators ;
+ import common ;
+ import gcc ;
+ import type ;
+@@ -52,6 +53,8 @@
+         <debug-symbols>off <debug-symbols>on
+         <rtti>off <rtti>on
+         ;
++generators.override builtin.lib-generator : emscripten.prebuilt ;
++generators.override emscripten.searched-lib-generator : searched-lib-generator ;
+ 
+ type.set-generated-target-suffix EXE : <toolset>emscripten : "js" ;
+ type.set-generated-target-suffix OBJ : <toolset>emscripten : "bc" ;
+ 

nix/patches/occt/no_em_js.patch

@@ -0,0 +1,99 @@
+diff --git a/src/Message/Message_PrinterSystemLog.cxx b/src/Message/Message_PrinterSystemLog.cxx
+index 0c82c2167..a2e9e6d68 100644
+--- a/src/Message/Message_PrinterSystemLog.cxx
++++ b/src/Message/Message_PrinterSystemLog.cxx
+@@ -55,27 +55,6 @@
+     return ANDROID_LOG_DEBUG;
+   }
+ #elif defined(__EMSCRIPTEN__)
+-  #include <emscripten/emscripten.h>
+-
+-  //! Print message to console.debug().
+-  EM_JS(void, occJSConsoleDebug, (const char* theStr), {
+-    console.debug(UTF8ToString(theStr));
+-  });
+-
+-  //! Print message to console.info().
+-  EM_JS(void, occJSConsoleInfo, (const char* theStr), {
+-    console.info(UTF8ToString(theStr));
+-  });
+-
+-  //! Print message to console.warn().
+-  EM_JS(void, occJSConsoleWarn, (const char* theStr), {
+-    console.warn(UTF8ToString(theStr));
+-  });
+-
+-  //! Print message to console.error().
+-  EM_JS(void, occJSConsoleError, (const char* theStr), {
+-    console.error(UTF8ToString(theStr));
+-  });
+ #else
+   #include <syslog.h>
+ 
+@@ -169,16 +148,6 @@ void Message_PrinterSystemLog::send (const TCollection_AsciiString& theString,
+ #elif defined(__ANDROID__)
+   __android_log_write (getAndroidLogPriority (theGravity), myEventSourceName.ToCString(), theString.ToCString());
+ #elif defined(__EMSCRIPTEN__)
+-  // don't use bogus emscripten_log() corrupting UNICODE strings
+-  switch (theGravity)
+-  {
+-    case Message_Trace:   occJSConsoleDebug(theString.ToCString()); return;
+-    case Message_Info:    occJSConsoleInfo (theString.ToCString()); return;
+-    case Message_Warning: occJSConsoleWarn (theString.ToCString()); return;
+-    case Message_Alarm:   occJSConsoleError(theString.ToCString()); return;
+-    case Message_Fail:    occJSConsoleError(theString.ToCString()); return;
+-  }
+-  occJSConsoleWarn (theString.ToCString());
+ #else
+   syslog (getSysLogPriority (theGravity), "%s", theString.ToCString());
+ #endif
+diff --git a/src/OSD/OSD_MemInfo.cxx b/src/OSD/OSD_MemInfo.cxx
+index 08a939beb..7c1fc79b3 100644
+--- a/src/OSD/OSD_MemInfo.cxx
++++ b/src/OSD/OSD_MemInfo.cxx
+@@ -37,15 +37,6 @@
+ 
+ #include <OSD_MemInfo.hxx>
+ 
+-#if defined(__EMSCRIPTEN__)
+-  #include <emscripten.h>
+-
+-  //! Return WebAssembly heap size in bytes.
+-  EM_JS(size_t, OSD_MemInfo_getModuleHeapLength, (), {
+-    return Module.HEAP8.length;
+-  });
+-#endif
+-
+ // =======================================================================
+ // function : OSD_MemInfo
+ // purpose  :
+@@ -156,29 +147,6 @@ void OSD_MemInfo::Update()
+   }
+ 
+ #elif defined(__EMSCRIPTEN__)
+-  if (IsActive (MemHeapUsage)
+-   || IsActive (MemWorkingSet)
+-   || IsActive (MemWorkingSetPeak))
+-  {
+-    // /proc/%d/status is not emulated - get more info from mallinfo()
+-    const struct mallinfo aMI = mallinfo();
+-    if (IsActive (MemHeapUsage))
+-    {
+-      myCounters[MemHeapUsage] = aMI.uordblks;
+-    }
+-    if (IsActive (MemWorkingSet))
+-    {
+-      myCounters[MemWorkingSet] = aMI.uordblks;
+-    }
+-    if (IsActive (MemWorkingSetPeak))
+-    {
+-      myCounters[MemWorkingSetPeak] = aMI.usmblks;
+-    }
+-  }
+-  if (IsActive (MemVirtual))
+-  {
+-    myCounters[MemVirtual] = OSD_MemInfo_getModuleHeapLength();
+-  }
+ #elif (defined(__linux__) || defined(__linux))
+   if (IsActive (MemHeapUsage))
+   {

nix/patches/opencollada/remove_tr1.patch

@@ -0,0 +1,81 @@
+diff --git a/COLLADABaseUtils/include/COLLADABUhash_map.h b/COLLADABaseUtils/include/COLLADABUhash_map.h
+index 8ab0fb9b..12503bfb 100644
+--- a/COLLADABaseUtils/include/COLLADABUhash_map.h
++++ b/COLLADABaseUtils/include/COLLADABUhash_map.h
+@@ -32,9 +32,9 @@
+             #include <unordered_map>
+             #include <unordered_set>
+ 
+-            #define COLLADABU_HASH_MAP std::tr1::unordered_map
+-			#define COLLADABU_HASH_MULTIMAP std::tr1::unordered_multimap
+-            #define COLLADABU_HASH_SET std::tr1::unordered_set
++            #define COLLADABU_HASH_MAP std::unordered_map
++			#define COLLADABU_HASH_MULTIMAP std::unordered_multimap
++            #define COLLADABU_HASH_SET std::unordered_set
+             #define COLLADABU_HASH_NAMESPACE_OPEN std { namespace tr1
+             #define COLLADABU_HASH_NAMESPACE_CLOSE }
+             #define COLLADABU_HASH_FUN hash
+@@ -50,12 +50,12 @@
+             #define COLLADABU_HASH_FUN hash
+         #endif
+     #elif defined(__MINGW32__) || defined(__MINGW64__)
+-        #include <tr1/unordered_map>
+-        #include <tr1/unordered_set>
++        #include <unordered_map>
++        #include <unordered_set>
+ 
+-        #define COLLADABU_HASH_MAP std::tr1::unordered_map
+-        #define COLLADABU_HASH_MULTIMAP std::tr1::unordered_multimap
+-        #define COLLADABU_HASH_SET std::tr1::unordered_set
++        #define COLLADABU_HASH_MAP std::unordered_map
++        #define COLLADABU_HASH_MULTIMAP std::unordered_multimap
++        #define COLLADABU_HASH_SET std::unordered_set
+         #define COLLADABU_HASH_NAMESPACE_OPEN std { namespace tr1
+         #define COLLADABU_HASH_NAMESPACE_CLOSE }
+         #define COLLADABU_HASH_FUN hash
+@@ -107,12 +107,12 @@
+         #define COLLADABU_HASH_NAMESPACE_CLOSE
+         #define COLLADABU_HASH_FUN hash
+     #else
+-        #include <tr1/unordered_map>
+-        #include <tr1/unordered_set>
++        #include <unordered_map>
++        #include <unordered_set>
+ 
+-		#define COLLADABU_HASH_MAP std::tr1::unordered_map
+-		#define COLLADABU_HASH_MULTIMAP std::tr1::unordered_multimap
+-        #define COLLADABU_HASH_SET std::tr1::unordered_set
++		#define COLLADABU_HASH_MAP std::unordered_map
++		#define COLLADABU_HASH_MULTIMAP std::unordered_multimap
++        #define COLLADABU_HASH_SET std::unordered_set
+         #define COLLADABU_HASH_NAMESPACE_OPEN std { namespace tr1
+         #define COLLADABU_HASH_NAMESPACE_CLOSE }
+         #define COLLADABU_HASH_FUN hash
+diff --git a/common/libBuffer/include/CommonFWriteBufferFlusher.h b/common/libBuffer/include/CommonFWriteBufferFlusher.h
+index c7af45b2..fac4f133 100644
+--- a/common/libBuffer/include/CommonFWriteBufferFlusher.h
++++ b/common/libBuffer/include/CommonFWriteBufferFlusher.h
+@@ -15,12 +15,12 @@
+ 
+ #if (defined(WIN64) || defined(_WIN64) || defined(__WIN64__)) || (defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(__NT__) || defined(__APPLE__))
+ #if defined(__GNUC__) && !defined(_LIBCPP_VERSION)
+-#	include <tr1/unordered_map>
++#	include <unordered_map>
+ #else
+ #	include <unordered_map>
+ #endif
+ #else
+-#	include <tr1/unordered_map>
++#	include <unordered_map>
+ #endif
+ 
+ #ifdef _LIBCPP_VERSION
+@@ -58,7 +58,7 @@ namespace Common
+ #else
+ 		typedef __int64 FilePosType;
+ #endif
+-	typedef std::tr1::unordered_map<MarkId, FilePosType > MarkIdToFilePos;
++	typedef std::unordered_map<MarkId, FilePosType > MarkIdToFilePos;
+ 
+ 	public:
+ 		static const size_t DEFAUL_BUFFER_SIZE = 64*1024;

pyodide/meta.yaml

@@ -0,0 +1,18 @@
+package:
+  name: ifcopenshell
+  version: 0.7.0
+
+source:
+  path: IfcOpenShell
+
+build:
+  script: |
+    python nix/build-all.py --without-hdf5 --without-opencollada --without-swig --without-pcre -v --wasm --py310 IfcOpenShell-Python
+    cp pyodide/setup.py .
+
+about:
+  home: http://ifcopenshell.org
+  license: LGPL-3.0-or-later
+  summary: |
+    IfcOpenShell is an open source (LGPL) software library for 
+    working with the Industry Foundation Classes (IFC) file format.

pyodide/setup.py

@@ -0,0 +1,11 @@
+from setuptools import setup, find_packages
+
+setup(name='IfcOpenShell',
+      version='0.7.0',
+      description='IfcOpenShell is an open source (LGPL) software library for working with the Industry Foundation Classes (IFC) file format.',
+      author='Thomas Krijnen',
+      author_email='thomas@aecgeeks.com',
+      url='http://ifcopenshell.org',
+      packages=find_packages(),
+      package_data={'': ['*.so']},
+)

src/bcf/.gitignore

@@ -0,0 +1 @@
+.tox

src/bcf/Makefile

@@ -0,0 +1,17 @@
+.PHONY: ci
+ci:
+	tox
+
+.PHONY: license
+license:
+	copyright-header --license LGPL3 --copyright-holder "Andrea Ghensi <andrea.ghensi@gmail.com>" --copyright-year "2022" --copyright-software "IfcOpenShell" --copyright-software-description "BCF XML file handling" -a ./ -o ./
+
+# TODO: make this based on xsd file presence
+.PHONY: models
+models:
+	cd src && xsdata generate -p bcf.v2.model --unnest-classes --kw-only --slots -ds Google bcf/v2/xsd
+	cd src && xsdata generate -p bcf.v3.model --unnest-classes --kw-only --slots -ds Google bcf/v3/xsd
+
+# .PHONY
+# api:
+#     openapi-python-client generate --url https://api.swaggerhub.com/apis/buildingSMART/BCF/3.0

src/bcf/README.md

@@ -1,64 +1,54 @@
 # bcf
 
-A simple Python implementation of BCF. The data model is described in `data.py`.
+A simple Python implementation of BCF.
 Manipulation of BCF-XML is available via `bcfxml.py` and manipulation of BCF-API
 is available via `bcfapi.py`.
 
-- BCF-XML version 2.1: Fully supported
-- BCF-API version 2.1: Not supported, will probably tackle this after BCF-API v3.0
-- BCF-XML version 3.0: Almost fully supported, except for the documents module
-- BCF-API version 3.0: Almost fully supported, except for two requests.
+It tries to support BCF-XML version 2.1 and 3.0, and BCF-API 3.0.
 
 ## bcfxml
 
-The `bcfxml` module lets you interact with the BCF-XML standard.
+The `bcfxml.load` function lets you read a BCF-XML file.
+It takes care of using the right version based on the "bcf.version" file contained in the BCF package.
+
+The BCF files are extracted and parsed on-demand, and edits are stored in memory until you call the `save` method.
 
 ```python
-from bcf import bcfxml
-
+from bcf.bcfxml import load
 
 # Load a project
-bcfxml = bcfxml.load("/path/to/file.bcf")
+with load("/path/to/file.bcf") as bcfxml:
+    project = bcfxml.project
+    print(project.name)
 
+    # To edit a project, just modify the object directly
+    bcfxml.project.name = "New name"
 
-# The project is also stored in the module
-# project == bcfxml.project
-project=bcfxml.get_project()
-print(project.name)
+    # Get a dictionary of topics
+    topics = bcfxml.topics
 
-# To edit a project, just modify the object directly
-bcfxml.project.name = "New name"
-bcfxml.edit_project()
+    for topic_guid, topic_handler in bcfxml.topics.items():
+        topic = topic_handler.topic
+        print("Topic guid is", topic.guid)
+        print("Topic title is", topic.title)
 
-# The BCF file is extracted to this temporary directory
-print(bcfxml.filepath)
+        # Fetch extra data about a topic
+        header = topic_handler.header
+        comments = topic_handler.comments
+        viewpoints = topic_handler.viewpoints
 
-# Get a dictionary of topics
-topics = bcfxml.get_topics()
+        for comment in comments:
+            print(comment.guid)
+            print(comment.comment)
+            print(comment.author)
 
-# Note: topics == bcfxml.topics
-for guid, topic in bcfxml.topics.items():
-    print("Topic guid is", guid)
-    print("Topic guid is", topic.guid)
-    print("Topic title is", topic.title)
+    # Get a particular topic
+    topic = bcfxml.get_topic(guid)
 
-    # Fetch extra data about a topic
-    header = bcfxml.get_header(guid)
-    comments = bcfxml.get_comments(guid)
-    viewpoints = bcfxml.get_viewpoints(guid)
+    # Modify a topic
+    topic.title = "New title"
 
-    # Note: comments == topic.comments, and so on
-    for comment_guid, comment in comments.items():
-        print(comment_guid)
-        print(comment.comment)
-        print(comment.author)
-
-# Get a particular topic
-topic = bcfxml.get_topic(guid)
-
-# Modify a topic
-topic.title = "New title"
-bcfxml.edit_topic(topic)
+    bcfxml.save()
 ```
 
 ## bcfapi
@@ -92,10 +82,3 @@ print(data)
 data = bcf_client.get_extensions(project_id)
 print(data)
 ```
-
-## Todo List
-
-The remaining work that needs to be completed in `bcfxml.py` and `bcfapi.py`.
-
-- For `bcfxml.py` two xsds support is remaining namely 'documents.xsd`and`extensions.xsd`.
-- For `bcfapi.py` two requests that are `get_topics` and `get_comments` are remaining.

src/bcf/pyproject.toml

@@ -1,12 +1,141 @@
 [build-system]
 requires = [
-    "setuptools>=42",
+    "setuptools>=61",
     "wheel"
 ]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "bcf-client"
+# author = "IfcOpenShell"
+description = "BCF-XML file handler."
+readme = "README.md"
+requires-python = ">=3.8"
+keywords = ["IFC", "BCF", "BIM", "eingineering"]
+dependencies = [
+    "xsdata",
+    "numpy",
+    "ifcopenshell",
+]
+version = "0.0.1"
+classifiers = [
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Utilities",
+]
+
+[project.urls]
+Source = "https://github.com/IfcOpenShell/IfcOpenShell"
+Issues = "https://github.com/IfcOpenShell/IfcOpenShell/issues"
+
 [tool.black]
 line-length = 120
+extend-exclude = "model"
 
 [tool.isort]
-profile = "black"
+profile = "black"
+extend_skip_glob = ["src/bcf/*/model/*"]
+
+[tool.coverage.paths]
+source = ["src"]
+
+[tool.coverage.run]
+branch = true
+source = ["bcf"]
+omit = ["*/model/*"]
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 65
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING",
+    "if __name__ == .__main__.:",
+    "Protocol",
+]
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+env_list = lint, type, py3{10,11}
+skip_missing_interpreters = true
+
+[testenv]
+deps =
+    pytest
+    pytest-cov
+    coverage
+commands = pytest --cov --cov-report=term tests
+
+[testenv:lint]
+description = run linters
+skip_install = true
+deps =
+    black
+    isort
+    pylint
+commands = 
+    black {posargs:.}
+    isort {posargs:.}
+    pylint {posargs:.} --output-format=colorized
+
+[testenv:type]
+description = run type checks
+deps =
+    mypy>=0.991
+commands =
+    - mypy {posargs:src}
+"""
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+#no_implicit_reexport = true
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+strict_equality = true
+strict_optional = true
+warn_redundant_casts = true
+#warn_return_any = true
+warn_unreachable = true
+warn_unused_configs = true
+warn_unused_ignores = true
+exclude= "src/bcf/v(2|3)/model"
+plugins = "numpy.typing.mypy_plugin"
+
+[[tool.mypy.overrides]]
+module = "tests"
+disallow_untyped_decorators = false
+disallow_untyped_defs = false
+
+[[tool.mypy.overrides]]
+module = [
+    "pytest",
+    "pytest_mock",
+    "ifcopenshell",
+    "ifcopenshell.*",
+]
+ignore_missing_imports = true
+
+[tool.pylint.main]
+ignore = ["model"]
+ignored-modules = ["bcf.v2.model", "bcf.v3.model", "xsdata"]
+jobs = 0
+disable="all"
+enable="E" # B,B9,BLK,C,D,E,F,I,N,S,W
+
+[tool.pylint.design]
+max-args = 10
+max-attributes = 10
+
+[tool.pylint.format]
+expected-line-ending-format = "LF"
+max-line-length = 120

src/bcf/requirements-dev.txt

@@ -0,0 +1,6 @@
+black
+mypy
+pylint
+isort
+xsdata
+tox==3.27.1

src/bcf/requirements.txt

@@ -1 +0,0 @@
-xmlschema

src/bcf/setup.cfg

@@ -1,37 +0,0 @@
-[metadata]
-name=bcf-client
-version=0.0.1
-author = Ifcopenshell
-description = A simple Python implementation of BCF
-url = https://github.com/IfcOpenShell/IfcOpenShell
-project_urls =
-    Code=https://github.com/IfcOpenShell/IfcOpenShell
-    Issues=https://github.com/IfcOpenShell/IfcOpenShell/issues
-long_description = file: README.md
-long_description_content_type = text/markdown
-classifiers =
-    License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-    Operating System :: OS Independent
-    Programming Language :: Python :: 3
-    Topic :: Scientific/Engineering
-    Topic :: Utilities
-keywords =
-    Python
-    file formats
-    engineering
-
-[options]
-package_dir =
-    = src
-packages = find:
-python_requires = >=3
-install_requires=
-    xmlschema
-include_package_data = True
-
-[options.packages.find]
-where = src
-
-[flake8]
-max-line-length = 120
-ignore = E24, E121, E123, E126, E203, E226, E704, E741, W503, W504

src/bcf/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

src/bcf/src/bcf/bcfxml.py

@@ -1,61 +1,73 @@
-# BCF - BCF Python library
-# Copyright (C) 2021 Prabhat Singh <singh01prabhat@gmail.com>
-#
-# This file is part of BCF.
-#
-# BCF is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# BCF is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with BCF.  If not, see <http://www.gnu.org/licenses/>.
+"""
+BCF - BCF Python library
+Copyright (C) 2021 Prabhat Singh <singh01prabhat@gmail.com>
+Copyright (C) 2022 Andrea Ghensi <andrea.ghensi@gmail.com>
 
+This file is part of BCF.
 
-import os.path
+BCF is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+BCF is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with BCF.  If not, see <http://www.gnu.org/licenses/>.
+"""
 import zipfile
-import tempfile
-from xml.dom import minidom
+from pathlib import Path
+from typing import Optional, Union
+
+from bcf.v2.bcfxml import BcfXml as BcfXml2
+from bcf.v2.model import Version as Version2
+from bcf.v3.bcfxml import BcfXml as BcfXml3
+from bcf.v3.model import Version as Version3
+from bcf.xml_parser import AbstractXmlParserSerializer, XmlParserSerializer
 
 
-def load(filepath):
-    filepath = extract_project(filepath)
-    if os.path.isfile(os.path.join(filepath, "bcf.version")):
-        version_path = os.path.join(filepath, "bcf.version")
-        version_id = get_version(version_path)
-        # TODO: we actually coded it for 2.1, let's check the difference between 2.0 and 2.1
-        if version_id == "2.1" or version_id == "2.0":
-            from bcf.v2.bcfxml import BcfXml
+def load(
+    filepath: Path, xml_handler: Optional[AbstractXmlParserSerializer] = None
+) -> Optional[Union[BcfXml2, BcfXml3]]:
+    """
+    Load a BCF file.
 
-            bcfxml = BcfXml()
-            bcfxml.filepath = filepath
-            return bcfxml
-        elif version_id == "3.0":
-            from bcf.v3.bcfxml import BcfXml
+    Args:
+        filepath: The path to the BCF file.
 
-            bcfxml = BcfXml()
-            bcfxml.filepath = filepath
-            return bcfxml
-        else:
-            raise Exception(f"Version {version_id} not supported.")
+    Returns:
+        The loaded BCF file.
+
+    Raises:
+        ValueError: If the BCF version is not supported.
+    """
+    xml_handler = xml_handler or XmlParserSerializer()
+    version_id = _get_version(filepath, xml_handler)
+    if version_id in {"2.1", "2.0"}:
+        return BcfXml2.load(filepath, xml_handler)
+    if version_id == "3.0":
+        return BcfXml3.load(filepath, xml_handler)
+    raise ValueError(f"Version {version_id} not supported.")
 
 
-def get_version(version_path):
-    xmlparse = minidom.parse(version_path)
-    version_el = xmlparse.getElementsByTagName("Version")[0]
-    version = version_el.getAttribute("VersionId")
-    return version
+def _get_version(filepath: Union[str, Path], xml_handler: Optional[AbstractXmlParserSerializer] = None) -> str:
+    """
+    Returns the version of the BCF file.
 
+    Args:
+        filepath: The path to the BCF file.
+        xml_handler: The XML handler. If none is given, XmlParserSerializer is used.
 
-def extract_project(filepath):
-    if not filepath:
-        return
-    zip_file = zipfile.ZipFile(filepath)
-    filepath = tempfile.mkdtemp()
-    zip_file.extractall(filepath)
-    return filepath
+    Returns:
+        The version of the BCF file.
+    """
+    xml_handler = xml_handler or XmlParserSerializer()
+    with zipfile.ZipFile(filepath) as bcf_zip:
+        try:
+            version = xml_handler.parse(bcf_zip.read("bcf.version"), Version3)
+        except:
+            version = xml_handler.parse(bcf_zip.read("bcf.version"), Version2)
+        return version.version_id

src/bcf/src/bcf/geometry.py

@@ -0,0 +1,64 @@
+from typing import Optional
+
+import numpy as np
+from numpy.typing import NDArray
+
+
+def camera_vectors_from_element_placement(
+    elem_placement: NDArray[np.float_],
+) -> tuple[NDArray[np.float_], NDArray[np.float_], NDArray[np.float_]]:
+    """
+    Calculate the vectors of a camera pointing to an element.
+
+    Args:
+        elem_placement: Placement matrix of an element.
+
+    Returns:
+        Camera position, direction and up vectors
+    """
+    target_position = elem_placement[:3, 3]
+    return camera_vectors_from_target_position(target_position)
+
+
+def camera_vectors_from_target_position(
+    target_position: NDArray[np.float_], offset: Optional[NDArray[np.float_]] = None
+) -> tuple[NDArray[np.float_], NDArray[np.float_], NDArray[np.float_]]:
+    """
+    Calculate the vectors of a camera pointing to a target point.
+
+    Args:
+        target_position: point the camera is pointing to.
+        camera_offset: offset of the camera from the target point.
+
+    Returns:
+        Camera position, direction and up vectors
+    """
+    camera_offset = np.array((5, 5, 5)) if offset is None else offset
+    camera_position = target_position + camera_offset
+    camera_direction = unit_vector(-camera_offset)  # pylint: disable=invalid-unary-operand-type
+    camera_right = unit_vector(np.cross(np.array([0.0, 0.0, 1.0]), camera_direction))
+    camera_up = unit_vector(np.cross(camera_direction, camera_right))
+    return camera_position, camera_direction, camera_up
+    # rotation_transform = np.eye(4)
+    # rotation_transform[0, :3] = camera_right
+    # rotation_transform[1, :3] = camera_up
+    # rotation_transform[2, :3] = camera_direction
+    # translation_transform = np.eye(4)
+    # translation_transform[:3, -1] = -camera_position
+    # look_at_transform = np.matmul(rotation_transform, translation_transform)
+    # mat = np.linalg.inv(look_at_transform)
+    # return camera_position, -mat[:3, 2], mat[:3, 1]
+
+
+def unit_vector(v: NDArray[np.float_]) -> NDArray[np.float_]:
+    """
+    Return the unit vector of a vector.
+
+    Args:
+        v: vector
+
+    Returns:
+        unit vector.
+    """
+    norm = np.linalg.norm(v)
+    return v if norm == 0 else v / norm

src/bcf/src/bcf/inmemory_zipfile.py

@@ -0,0 +1,55 @@
+"""
+In Memory Zip File management, taken from ruamel.std.zipfile
+
+Copyright (c) 2017-2020 Anthon van der Neut, Ruamel bvba
+
+original idea from https://stackoverflow.com/a/19722365/1307905
+"""
+import zipfile
+from io import BytesIO
+from os import PathLike
+from pathlib import Path
+from typing import Any, Optional, Protocol
+
+
+class ZipFileInterface(Protocol):
+    def writestr(self, filename_in_zip: str | zipfile.ZipInfo, file_contents: bytes | str) -> None:
+        ...
+
+
+class InMemoryZipFile:
+    def __init__(
+        self, file_name: Optional[str | Path] = None, compression: int = zipfile.ZIP_DEFLATED, debug: int = 0
+    ) -> None:
+        # Create the in-memory file-like object
+        self._file_name: Optional[str | Path] = str(file_name) if hasattr(file_name, "_from_parts") else file_name
+        self.in_memory_data = BytesIO()
+        # Create the in-memory zipfile
+        self.in_memory_zip = zipfile.ZipFile(self.in_memory_data, "w", compression, False)
+        self.in_memory_zip.debug = debug
+
+    def writestr(self, filename_in_zip: str | zipfile.ZipInfo, file_contents: bytes | str) -> None:
+        """Appends a file with name filename_in_zip and contents of
+        file_contents to the in-memory zip."""
+        self.in_memory_zip.writestr(filename_in_zip, file_contents)
+
+    def write_to_file(self, filename: str | bytes | PathLike[str] | PathLike[bytes] | int) -> None:
+        """Writes the in-memory zip to a file."""
+        # Mark the files as having been created on Windows so that
+        # Unix permissions are not inferred as 0000
+        for zfile in self.in_memory_zip.filelist:
+            zfile.create_system = 0
+        self.in_memory_zip.close()
+        with open(filename, "wb") as f:
+            f.write(self.data)
+
+    @property
+    def data(self) -> bytes:
+        return self.in_memory_data.getvalue()
+
+    def __enter__(self) -> "InMemoryZipFile":
+        return self
+
+    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
+        if self._file_name:
+            self.write_to_file(self._file_name)

src/bcf/src/bcf/v2/__init__.py

@@ -1,4 +1,3 @@
-
 # BCF - BCF Python library
 # Copyright (C) 2020, 2021 Dion Moult <dion@thinkmoult.com>
 #
@@ -16,4 +15,3 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with BCF.  If not, see <http://www.gnu.org/licenses/>.
-

src/bcf/src/bcf/v2/data.py

@@ -1,198 +0,0 @@
-
-# BCF - BCF Python library
-# Copyright (C) 2020, 2021 Dion Moult <dion@thinkmoult.com>
-#
-# This file is part of BCF.
-#
-# BCF is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# BCF is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with BCF.  If not, see <http://www.gnu.org/licenses/>.
-
-class Project:
-    def __init__(self):
-        self.project_id = ""
-        self.name = ""
-        self.extension_schema = ""
-
-
-class BimSnippet:
-    def __init__(self):
-        self.snippet_type = None
-        self.is_external = False
-        self.reference = None
-        self.reference_schema = None
-
-
-class DocumentReference:
-    def __init__(self):
-        self.referenced_document = None
-        self.description = None
-        self.guid = None
-        self.is_external = False
-
-
-class RelatedTopic:
-    def __init__(self):
-        self.guid = None
-
-
-class HeaderFile:
-    def __init__(self):
-        self.filename = None
-        self.date = None
-        self.reference = None
-        self.ifc_project = None
-        self.ifc_spatial_structure_element = None
-        self.is_external = True
-
-
-class Header:
-    def __init__(self):
-        self.files = []
-
-
-class Topic:
-    def __init__(self):
-        self.reference_links = []
-        self.title = ""
-        self.priority = None
-        self.index = None  # Deprecated, stored, but ignored
-        self.labels = []
-        self.creation_date = None
-        self.creation_author = None
-        self.modified_date = None
-        self.modified_author = None
-        self.due_date = None
-        self.assigned_to = None
-        self.stage = None
-        self.description = None
-        self.bim_snippet = None
-        self.document_references = []
-        self.related_topics = []
-        self.topic_status = None
-        self.topic_type = None
-        self.guid = None
-
-        self.header = None
-        self.comments = {}
-        self.viewpoints = {}
-
-
-class Comment:
-    def __init__(self):
-        self.guid = None
-        self.date = None
-        self.author = None
-        self.comment = None
-        self.viewpoint = None
-        self.modified_date = None
-        self.modified_author = None
-        self.topic_guid = None  # Part of BCF-API
-
-
-class ViewSetupHints:
-    def __init__(self):
-        self.spaces_visible = False
-        self.space_boundaries_visible = False
-        self.openings_visible = False
-
-
-class Component:
-    def __init__(self):
-        self.originating_system = None
-        self.authoring_tool_id = None
-        self.ifc_guid = None
-
-
-class ComponentVisibility:
-    def __init__(self):
-        self.exceptions = []
-        self.default_visibility = False
-
-
-class Color:
-    def __init__(self):
-        self.color = None
-        self.components = []
-
-
-class Components:
-    def __init__(self):
-        self.view_setup_hints = None
-        self.selection = []
-        self.visibility = None
-        self.coloring = []
-
-
-class Point:
-    def __init__(self):
-        self.x = 0
-        self.y = 0
-        self.z = 0
-
-
-class Direction(Point):
-    pass
-
-
-class OrthogonalCamera:
-    def __init__(self):
-        self.camera_view_point = Point()
-        self.camera_direction = Direction()
-        self.camera_up_vector = Direction()
-        self.view_to_world_scale = 1.0
-
-
-class PerspectiveCamera:
-    def __init__(self):
-        self.camera_view_point = Point()
-        self.camera_direction = Direction()
-        self.camera_up_vector = Direction()
-        self.field_of_view = 60.0
-
-
-class Line:
-    def __init__(self):
-        self.start_point = Point()
-        self.end_point = Point()
-
-
-class ClippingPlane:
-    def __init__(self):
-        self.location = Point()
-        self.direction = Direction()
-
-
-class Bitmap:
-    def __init__(self):
-        self.reference = ""  # Only in BCF-XML
-        self.bitmap_data = None  # Only in BCF-API
-        self.bitmap_format = "PNG"  # Enum of png or jpg
-        self.location = Point()
-        self.normal = Direction()
-        self.up = Direction()
-        self.height = 1.0
-
-
-class Viewpoint:
-    def __init__(self):
-        self.guid = None
-        self.viewpoint = None
-        self.snapshot = None
-        self.index = None
-
-        self.components = None  # It's not a list, despite the plural name
-        self.orthogonal_camera = None
-        self.perspective_camera = None
-        self.lines = []
-        self.clipping_planes = []
-        self.bitmaps = []

src/bcf/src/bcf/v2/model/__init__.py

@@ -0,0 +1,70 @@
+from bcf.v2.model.markup import (
+    BimSnippet,
+    Comment,
+    CommentViewpoint,
+    Header,
+    HeaderFile,
+    Markup,
+    Topic,
+    TopicDocumentReference,
+    TopicRelatedTopic,
+    ViewPoint,
+)
+from bcf.v2.model.project import Project, ProjectExtension
+from bcf.v2.model.version import Version
+from bcf.v2.model.visinfo import (
+    BitmapFormat,
+    ClippingPlane,
+    Component,
+    ComponentColoring,
+    ComponentColoringColor,
+    Components,
+    ComponentSelection,
+    ComponentVisibility,
+    ComponentVisibilityExceptions,
+    Direction,
+    Line,
+    OrthogonalCamera,
+    PerspectiveCamera,
+    Point,
+    ViewSetupHints,
+    VisualizationInfo,
+    VisualizationInfoBitmap,
+    VisualizationInfoClippingPlanes,
+    VisualizationInfoLines,
+)
+
+__all__ = [
+    "BimSnippet",
+    "Comment",
+    "CommentViewpoint",
+    "Header",
+    "HeaderFile",
+    "Markup",
+    "Topic",
+    "TopicDocumentReference",
+    "TopicRelatedTopic",
+    "ViewPoint",
+    "Project",
+    "ProjectExtension",
+    "Version",
+    "BitmapFormat",
+    "ClippingPlane",
+    "Component",
+    "ComponentColoring",
+    "ComponentColoringColor",
+    "ComponentSelection",
+    "ComponentVisibility",
+    "ComponentVisibilityExceptions",
+    "Components",
+    "Direction",
+    "Line",
+    "OrthogonalCamera",
+    "PerspectiveCamera",
+    "Point",
+    "ViewSetupHints",
+    "VisualizationInfo",
+    "VisualizationInfoBitmap",
+    "VisualizationInfoClippingPlanes",
+    "VisualizationInfoLines",
+]

src/bcf/src/bcf/v2/model/markup.py

@@ -0,0 +1,461 @@
+from dataclasses import dataclass, field
+from typing import List, Optional
+
+from xsdata.models.datatype import XmlDateTime
+
+
+@dataclass(slots=True, kw_only=True)
+class BimSnippet:
+    reference: str = field(
+        metadata={
+            "name": "Reference",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    reference_schema: str = field(
+        metadata={
+            "name": "ReferenceSchema",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    snippet_type: str = field(
+        metadata={
+            "name": "SnippetType",
+            "type": "Attribute",
+            "required": True,
+        }
+    )
+    is_external: bool = field(
+        default=False,
+        metadata={
+            "name": "isExternal",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class CommentViewpoint:
+    class Meta:
+        global_type = False
+
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class HeaderFile:
+    class Meta:
+        global_type = False
+
+    filename: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Filename",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    date: Optional[XmlDateTime] = field(
+        default=None,
+        metadata={
+            "name": "Date",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    reference: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Reference",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    ifc_project: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "IfcProject",
+            "type": "Attribute",
+            "length": 22,
+            "pattern": r"[0-9,A-Z,a-z,_$]*",
+        }
+    )
+    ifc_spatial_structure_element: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "IfcSpatialStructureElement",
+            "type": "Attribute",
+            "length": 22,
+            "pattern": r"[0-9,A-Z,a-z,_$]*",
+        }
+    )
+    is_external: bool = field(
+        default=True,
+        metadata={
+            "name": "isExternal",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicDocumentReference:
+    class Meta:
+        global_type = False
+
+    referenced_document: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "ReferencedDocument",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    description: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Description",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    guid: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "pattern": r"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+        }
+    )
+    is_external: bool = field(
+        default=False,
+        metadata={
+            "name": "isExternal",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicRelatedTopic:
+    class Meta:
+        global_type = False
+
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ViewPoint:
+    viewpoint: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Viewpoint",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    snapshot: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Snapshot",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    index: Optional[int] = field(
+        default=None,
+        metadata={
+            "name": "Index",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Comment:
+    date: XmlDateTime = field(
+        metadata={
+            "name": "Date",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    author: str = field(
+        metadata={
+            "name": "Author",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    comment: str = field(
+        metadata={
+            "name": "Comment",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    viewpoint: Optional[CommentViewpoint] = field(
+        default=None,
+        metadata={
+            "name": "Viewpoint",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    modified_date: Optional[XmlDateTime] = field(
+        default=None,
+        metadata={
+            "name": "ModifiedDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    modified_author: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "ModifiedAuthor",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Header:
+    file: List[HeaderFile] = field(
+        default_factory=list,
+        metadata={
+            "name": "File",
+            "type": "Element",
+            "namespace": "",
+            "min_occurs": 1,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Topic:
+    reference_link: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "ReferenceLink",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    title: str = field(
+        metadata={
+            "name": "Title",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    priority: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Priority",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    index: Optional[int] = field(
+        default=None,
+        metadata={
+            "name": "Index",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    labels: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "Labels",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    creation_date: XmlDateTime = field(
+        metadata={
+            "name": "CreationDate",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    creation_author: str = field(
+        metadata={
+            "name": "CreationAuthor",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    modified_date: Optional[XmlDateTime] = field(
+        default=None,
+        metadata={
+            "name": "ModifiedDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    modified_author: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "ModifiedAuthor",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    due_date: Optional[XmlDateTime] = field(
+        default=None,
+        metadata={
+            "name": "DueDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    assigned_to: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "AssignedTo",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    stage: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Stage",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    description: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Description",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    bim_snippet: Optional[BimSnippet] = field(
+        default=None,
+        metadata={
+            "name": "BimSnippet",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    document_reference: List[TopicDocumentReference] = field(
+        default_factory=list,
+        metadata={
+            "name": "DocumentReference",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    related_topic: List[TopicRelatedTopic] = field(
+        default_factory=list,
+        metadata={
+            "name": "RelatedTopic",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+        }
+    )
+    topic_type: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "TopicType",
+            "type": "Attribute",
+        }
+    )
+    topic_status: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "TopicStatus",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Markup:
+    header: Optional[Header] = field(
+        default=None,
+        metadata={
+            "name": "Header",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    topic: Topic = field(
+        metadata={
+            "name": "Topic",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    comment: List[Comment] = field(
+        default_factory=list,
+        metadata={
+            "name": "Comment",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    viewpoints: List[ViewPoint] = field(
+        default_factory=list,
+        metadata={
+            "name": "Viewpoints",
+            "type": "Element",
+            "namespace": "",
+        }
+    )

src/bcf/src/bcf/v2/model/project.py

@@ -0,0 +1,41 @@
+from dataclasses import dataclass, field
+from typing import Optional
+
+
+@dataclass(slots=True, kw_only=True)
+class Project:
+    name: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Name",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    project_id: str = field(
+        metadata={
+            "name": "ProjectId",
+            "type": "Attribute",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ProjectExtension:
+    project: Optional[Project] = field(
+        default=None,
+        metadata={
+            "name": "Project",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    extension_schema: str = field(
+        metadata={
+            "name": "ExtensionSchema",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )

src/bcf/src/bcf/v2/model/version.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass, field
+from typing import Optional
+
+
+@dataclass(slots=True, kw_only=True)
+class Version:
+    detailed_version: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "DetailedVersion",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    version_id: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "VersionId",
+            "type": "Attribute",
+        }
+    )

src/bcf/src/bcf/v2/model/visinfo.py

@@ -0,0 +1,476 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import List, Optional
+
+
+class BitmapFormat(Enum):
+    PNG = "PNG"
+    JPG = "JPG"
+
+
+@dataclass(slots=True, kw_only=True)
+class Component:
+    originating_system: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "OriginatingSystem",
+            "type": "Element",
+        }
+    )
+    authoring_tool_id: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "AuthoringToolId",
+            "type": "Element",
+        }
+    )
+    ifc_guid: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "IfcGuid",
+            "type": "Attribute",
+            "length": 22,
+            "pattern": r"[0-9,A-Z,a-z,_$]*",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Direction:
+    x: float = field(
+        metadata={
+            "name": "X",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    y: float = field(
+        metadata={
+            "name": "Y",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    z: float = field(
+        metadata={
+            "name": "Z",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Point:
+    x: float = field(
+        metadata={
+            "name": "X",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    y: float = field(
+        metadata={
+            "name": "Y",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    z: float = field(
+        metadata={
+            "name": "Z",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ViewSetupHints:
+    spaces_visible: Optional[bool] = field(
+        default=None,
+        metadata={
+            "name": "SpacesVisible",
+            "type": "Attribute",
+        }
+    )
+    space_boundaries_visible: Optional[bool] = field(
+        default=None,
+        metadata={
+            "name": "SpaceBoundariesVisible",
+            "type": "Attribute",
+        }
+    )
+    openings_visible: Optional[bool] = field(
+        default=None,
+        metadata={
+            "name": "OpeningsVisible",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ClippingPlane:
+    location: Point = field(
+        metadata={
+            "name": "Location",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    direction: Direction = field(
+        metadata={
+            "name": "Direction",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentColoringColor:
+    class Meta:
+        global_type = False
+
+    component: List[Component] = field(
+        default_factory=list,
+        metadata={
+            "name": "Component",
+            "type": "Element",
+            "min_occurs": 1,
+        }
+    )
+    color: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Color",
+            "type": "Attribute",
+            "pattern": r"[0-9,a-f,A-F]{6}([0-9,a-f,A-F]{2})?",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentSelection:
+    component: List[Component] = field(
+        default_factory=list,
+        metadata={
+            "name": "Component",
+            "type": "Element",
+            "min_occurs": 1,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentVisibilityExceptions:
+    class Meta:
+        global_type = False
+
+    component: List[Component] = field(
+        default_factory=list,
+        metadata={
+            "name": "Component",
+            "type": "Element",
+            "min_occurs": 1,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Line:
+    start_point: Point = field(
+        metadata={
+            "name": "StartPoint",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    end_point: Point = field(
+        metadata={
+            "name": "EndPoint",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class OrthogonalCamera:
+    """
+    Attributes
+        camera_view_point:
+        camera_direction:
+        camera_up_vector:
+        view_to_world_scale: view's visible size in meters
+    """
+    camera_view_point: Point = field(
+        metadata={
+            "name": "CameraViewPoint",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    camera_direction: Direction = field(
+        metadata={
+            "name": "CameraDirection",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    camera_up_vector: Direction = field(
+        metadata={
+            "name": "CameraUpVector",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    view_to_world_scale: float = field(
+        metadata={
+            "name": "ViewToWorldScale",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class PerspectiveCamera:
+    """
+    Attributes
+        camera_view_point:
+        camera_direction:
+        camera_up_vector:
+        field_of_view: It is currently limited to a value between 45 and
+            60 degrees. This limitation will be dropped in the next
+            release and viewers should be expect values outside this
+            range in current implementations.
+    """
+    camera_view_point: Point = field(
+        metadata={
+            "name": "CameraViewPoint",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    camera_direction: Direction = field(
+        metadata={
+            "name": "CameraDirection",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    camera_up_vector: Direction = field(
+        metadata={
+            "name": "CameraUpVector",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    field_of_view: float = field(
+        metadata={
+            "name": "FieldOfView",
+            "type": "Element",
+            "required": True,
+            "min_inclusive": 1.0,
+            "max_inclusive": 170.0,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class VisualizationInfoBitmap:
+    class Meta:
+        global_type = False
+
+    bitmap: BitmapFormat = field(
+        metadata={
+            "name": "Bitmap",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    reference: str = field(
+        metadata={
+            "name": "Reference",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    location: Point = field(
+        metadata={
+            "name": "Location",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    normal: Direction = field(
+        metadata={
+            "name": "Normal",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    up: Direction = field(
+        metadata={
+            "name": "Up",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    height: float = field(
+        metadata={
+            "name": "Height",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentColoring:
+    color: List[ComponentColoringColor] = field(
+        default_factory=list,
+        metadata={
+            "name": "Color",
+            "type": "Element",
+            "min_occurs": 1,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentVisibility:
+    exceptions: Optional[ComponentVisibilityExceptions] = field(
+        default=None,
+        metadata={
+            "name": "Exceptions",
+            "type": "Element",
+        }
+    )
+    default_visibility: Optional[bool] = field(
+        default=None,
+        metadata={
+            "name": "DefaultVisibility",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class VisualizationInfoClippingPlanes:
+    class Meta:
+        global_type = False
+
+    clipping_plane: List[ClippingPlane] = field(
+        default_factory=list,
+        metadata={
+            "name": "ClippingPlane",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class VisualizationInfoLines:
+    class Meta:
+        global_type = False
+
+    line: List[Line] = field(
+        default_factory=list,
+        metadata={
+            "name": "Line",
+            "type": "Element",
+            "min_occurs": 1,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Components:
+    view_setup_hints: Optional[ViewSetupHints] = field(
+        default=None,
+        metadata={
+            "name": "ViewSetupHints",
+            "type": "Element",
+        }
+    )
+    selection: Optional[ComponentSelection] = field(
+        default=None,
+        metadata={
+            "name": "Selection",
+            "type": "Element",
+        }
+    )
+    visibility: ComponentVisibility = field(
+        metadata={
+            "name": "Visibility",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    coloring: Optional[ComponentColoring] = field(
+        default=None,
+        metadata={
+            "name": "Coloring",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class VisualizationInfo:
+    """
+    VisualizationInfo documentation.
+    """
+    components: Optional[Components] = field(
+        default=None,
+        metadata={
+            "name": "Components",
+            "type": "Element",
+        }
+    )
+    orthogonal_camera: Optional[OrthogonalCamera] = field(
+        default=None,
+        metadata={
+            "name": "OrthogonalCamera",
+            "type": "Element",
+        }
+    )
+    perspective_camera: Optional[PerspectiveCamera] = field(
+        default=None,
+        metadata={
+            "name": "PerspectiveCamera",
+            "type": "Element",
+        }
+    )
+    lines: Optional[VisualizationInfoLines] = field(
+        default=None,
+        metadata={
+            "name": "Lines",
+            "type": "Element",
+        }
+    )
+    clipping_planes: Optional[VisualizationInfoClippingPlanes] = field(
+        default=None,
+        metadata={
+            "name": "ClippingPlanes",
+            "type": "Element",
+        }
+    )
+    bitmap: List[VisualizationInfoBitmap] = field(
+        default_factory=list,
+        metadata={
+            "name": "Bitmap",
+            "type": "Element",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}",
+        }
+    )

src/bcf/src/bcf/v2/topic.py

@@ -0,0 +1,304 @@
+"""BCF XML V2 Topic handler."""
+import datetime
+import tempfile
+import uuid
+import zipfile
+from pathlib import Path
+from typing import Any, NoReturn, Optional
+
+import numpy as np
+from ifcopenshell import entity_instance
+from numpy.typing import NDArray
+from xsdata.models.datatype import XmlDateTime
+
+import bcf.v2.model as mdl
+from bcf.inmemory_zipfile import ZipFileInterface
+from bcf.v2.visinfo import VisualizationInfoHandler
+from bcf.xml_parser import AbstractXmlParserSerializer, XmlParserSerializer
+
+
+class TopicHandler:
+    """BCF Topic and related objects handler."""
+
+    def __init__(
+        self,
+        topic_dir: Optional[zipfile.Path] = None,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> None:
+        self._markup: Optional[mdl.Markup] = None
+        self._viewpoints: dict[str, VisualizationInfoHandler] = {}
+        self._reference_files: dict[str, bytes] = {}
+        self._document_references: dict[str, bytes] = {}
+        self._bim_snippet: Optional[bytes] = None
+        self._xml_handler = xml_handler or XmlParserSerializer()
+        self._topic_dir = topic_dir
+
+    @property
+    def markup(self) -> Optional[mdl.Markup]:
+        if not self._markup:
+            markup_path = self._topic_dir.joinpath("markup.bcf")
+            if markup_path.exists():
+                self._markup = self._xml_handler.parse(markup_path.read_bytes(), mdl.Markup)
+        return self._markup
+
+    @markup.setter
+    def markup(self, value: mdl.Markup) -> None:
+        self._markup = value
+
+    @property
+    def topic(self) -> mdl.Topic:
+        """Return the Topic object."""
+        return self.markup.topic
+
+    @property
+    def guid(self) -> str:
+        """Return the GUID of the topic."""
+        if self._markup:
+            return self.topic.guid
+        return self._topic_dir.name if self._topic_dir else ""
+
+    @property
+    def header(self) -> Optional[mdl.Header]:
+        """Return the header of the topic."""
+        return self.markup.header if self.markup else None
+
+    @property
+    def comments(self) -> list[mdl.Comment]:
+        """Return the comments of the topic."""
+        return self.markup.comment if self.markup else []
+
+    @property
+    def bim_snippet(self) -> Optional[bytes]:
+        if not self._bim_snippet and self._topic_dir:
+            self._bim_snippet = self._load_bim_snippet()
+        return self._bim_snippet
+
+    @bim_snippet.setter
+    def bim_snippet(self, value: bytes) -> None:
+        self._bim_snippet = value
+
+    @property
+    def viewpoints(self) -> dict[str, VisualizationInfoHandler]:
+        if not self._viewpoints and self._topic_dir:
+            self._viewpoints = self._load_viewpoints()
+        return self._viewpoints
+
+    @property
+    def reference_files(self) -> dict[str, bytes]:
+        if self._reference_files or not self.header:
+            return self._reference_files
+        for ref in self.header.file:
+            if ref.is_external:
+                continue
+            real_path = self._topic_dir
+            for path_part in ref.reference.split("/"):
+                real_path = real_path.parent if path_part == ".." else real_path.joinpath(path_part)
+            self._reference_files[ref.reference] = real_path.read_bytes()
+        return self._reference_files
+
+    @property
+    def document_references(self) -> dict[str, bytes]:
+        if self._document_references or not self.topic:
+            return self._document_references
+        for doc in self.topic.document_reference:
+            if doc.is_external or not doc.referenced_document:
+                continue
+            real_path = self._topic_dir
+            for path_part in doc.referenced_document.split("/"):
+                real_path = real_path.parent if path_part == ".." else real_path.joinpath(path_part)
+            self._document_references[doc.referenced_document] = real_path.read_bytes()
+        return self._document_references
+
+    def _load_bim_snippet(self) -> Optional[bytes]:
+        bim_snippet_obj = self.topic.bim_snippet
+        if bim_snippet_obj and not bim_snippet_obj.is_external:
+            bim_snippet_path = self._topic_dir.joinpath(bim_snippet_obj.reference)
+            if bim_snippet_path.exists():
+                return bim_snippet_path.read_bytes()
+        return None
+
+    def _load_viewpoints(self) -> dict[str, VisualizationInfoHandler]:
+        if self.markup and (viewpoints := self.markup.viewpoints):
+            return VisualizationInfoHandler.from_topic_viewpoints(self._topic_dir, viewpoints)
+        return {}
+
+    @classmethod
+    def create_new(
+        cls,
+        title: str,
+        description: str,
+        author: str,
+        topic_type: str = "",
+        topic_status: str = "",
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> "TopicHandler":
+        """
+        Create a new BCF topic.
+
+        Args:
+            title: The title of the topic.
+            description: The description of the topic.
+            author: The author of the topic.
+            topic_type: The type of the topic.
+            topic_status: The status of the topic.
+            xml_handler: The XML parser/serializer to use.
+
+        Returns:
+            The BCF topic definition.
+        """
+        creation_date = XmlDateTime.from_datetime(datetime.datetime.now())
+        guid = str(uuid.uuid4())
+        topic = mdl.Topic(
+            title=title,
+            description=description,
+            creation_author=author,
+            creation_date=creation_date,
+            guid=guid,
+            topic_type=topic_type,
+            topic_status=topic_status,
+        )
+        markup = mdl.Markup(topic=topic)
+        obj = cls(topic_dir=Path(guid), xml_handler=xml_handler or XmlParserSerializer())
+        obj.markup = markup
+        return obj
+
+    def save(self, destination_zip: ZipFileInterface) -> None:
+        """
+        Save the topic to a BCF zip file.
+
+        Args:
+            bcf_zip: The BCF zip file to save to.
+        """
+        topic_dir = self.guid
+        self._save_xml(destination_zip, self._markup, "markup.bcf")
+        self._save_viewpoints(destination_zip, topic_dir)
+        self._save_bim_snippet(destination_zip)
+        self._save_reference_files(destination_zip)
+        self._save_document_references(destination_zip)
+
+    def _save_viewpoints(self, destination_zip: ZipFileInterface, topic_dir: str) -> None:
+        if not self.markup or not (viewpoints := self.markup.viewpoints):
+            return
+        for vpt in viewpoints:
+            if vpt.viewpoint:
+                self.viewpoints[vpt.viewpoint].save(destination_zip, topic_dir, vpt)
+
+    def _save_xml(self, destination_zip: ZipFileInterface, item: Any, target: str) -> None:
+        if self._topic_dir is None:
+            return
+        to_write = self._xml_handler.serialize(item) if item else self._topic_dir.joinpath(target).read_bytes()
+        destination_zip.writestr(f"{self._topic_dir.name}/{target}", to_write)
+
+    def _save_bim_snippet(self, destination_zip: ZipFileInterface) -> None:
+        snippet = self.topic.bim_snippet
+        if not snippet or snippet.is_external:
+            return
+        ref_filename = Path(snippet.reference).name
+        if self.bim_snippet:
+            destination_zip.writestr(f"{self.topic.guid}/{ref_filename}", self.bim_snippet)
+
+    def _save_reference_files(self, destination_zip: ZipFileInterface) -> None:
+        if not self.header:
+            return
+        for ref in self.header.file:
+            if ref.is_external or not ref.reference:
+                continue
+            real_path = self._topic_dir
+            for path_part in ref.reference.split("/"):
+                real_path = real_path.parent if path_part == ".." else real_path.joinpath(path_part)
+            destination_zip.writestr(real_path.at, self.reference_files[ref.reference])
+
+    def _save_document_references(self, destination_zip: ZipFileInterface) -> None:
+        if not self.topic:
+            return
+        for doc in self.topic.document_reference:
+            if doc.is_external or not doc.referenced_document:
+                continue
+            real_path = self._topic_dir
+            for path_part in doc.referenced_document.split("/"):
+                real_path = real_path.parent if path_part == ".." else real_path.joinpath(path_part)
+            destination_zip.writestr(real_path.at, self.document_references[doc.referenced_document])
+
+    def extract_file(self, entity, outfile: Optional[Path] = None) -> Path:
+        """Extracts an element with a file into a temporary directory
+
+        These include header files, bim snippets, document references, and
+        viewpoint bitmaps. External reference are not downloaded. Instead, the
+        URI reference is returned.
+
+        :param entity: The entity with a file reference to extract
+        :type entity: bcf.v2.model.HeaderFile,bcf.v2.model.BimSnippet,bcf.v2.model.TopicDocumentReference
+        :param outfile: If provided, save the header file to that location.
+            Otherwise, a temporary directory is created and the filename is
+            derived from the header's original filename.
+        :type outfile: pathlib.Path,optional
+        :return: The filepath of the extracted file. It may be a URL if the
+            header file is external.
+        :rtype: Path
+        """
+        if hasattr(entity, "reference"):
+            reference = entity.reference
+        else:
+            reference = entity.referenced_document
+
+        if not reference:
+            return
+
+        if getattr(entity, "is_external", False):
+            return entity.reference
+
+        resolved_reference = self._topic_dir
+
+        for part in Path(reference).parts:
+            if part == "..":
+                resolved_reference = resolved_reference.parent
+            else:
+                resolved_reference = resolved_reference.joinpath(part)
+
+        if not outfile:
+            if getattr(entity, "filename", None):
+                filename = entity.filename
+            else:
+                filename = resolved_reference.name
+            outfile = Path(tempfile.mkdtemp()) / filename
+
+        with open(outfile, "wb") as f:
+            f.write(resolved_reference.read_bytes())
+
+        return outfile
+
+    def add_viewpoint(self, element: entity_instance) -> None:
+        """Add a viewpoint pointed at the placement of an IFC element to the topic.
+
+        Args:
+            element: The IFC element.
+        """
+        new_viewpoint = VisualizationInfoHandler.create_new(element, self._xml_handler)
+        self.add_visinfo_handler(new_viewpoint)
+
+    def add_viewpoint_from_point_and_guids(self, position: NDArray[np.float_], *guids: str) -> None:
+        """Add a viewpoint pointing at an XYZ point in space
+
+        Args:
+            position: the XYZ point in space
+            guids: one or more element GlobalIds.
+        """
+        vi_handler = VisualizationInfoHandler.create_from_point_and_guids(
+            position, *guids, xml_handler=self._xml_handler
+        )
+        self.add_visinfo_handler(vi_handler)
+
+    def add_visinfo_handler(self, new_viewpoint: VisualizationInfoHandler) -> None:
+        self.viewpoints[new_viewpoint.guid + ".bcfv"] = new_viewpoint
+        self.markup.viewpoints.append(mdl.ViewPoint(viewpoint=new_viewpoint.guid + ".bcfv", guid=new_viewpoint.guid))
+
+    def __eq__(self, other: object) -> bool | NoReturn:
+        return (
+            (
+                self.markup == other.markup
+                and self.viewpoints == other.viewpoints
+                and self.bim_snippet == other.bim_snippet
+            )
+            if isinstance(other, TopicHandler)
+            else NotImplemented
+        )

src/bcf/src/bcf/v2/visinfo.py

@@ -0,0 +1,299 @@
+import uuid
+import zipfile
+from functools import lru_cache
+from typing import Any, Iterable, Optional
+
+import numpy as np
+from ifcopenshell import entity_instance
+import ifcopenshell.util.unit
+import ifcopenshell.util.placement
+from numpy.typing import NDArray
+
+import bcf.v2.model as mdl
+from bcf.geometry import (
+    camera_vectors_from_element_placement,
+    camera_vectors_from_target_position,
+)
+from bcf.inmemory_zipfile import ZipFileInterface
+from bcf.xml_parser import AbstractXmlParserSerializer, XmlParserSerializer
+
+
+class VisualizationInfoHandler:
+    """Handle the VisualizationInfo and related objects."""
+
+    def __init__(
+        self,
+        visualization_info: mdl.VisualizationInfo,
+        snapshot: Optional[bytes] = None,
+        bitmaps: Optional[dict[str, bytes]] = None,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> None:
+        self.visualization_info = visualization_info
+        self.snapshot = snapshot
+        self.bitmaps = bitmaps or {}
+        self._xml_handler = xml_handler or XmlParserSerializer()
+
+    @property
+    def guid(self) -> str:
+        """Return the GUID of the visualization info."""
+        return self.visualization_info.guid
+
+    @classmethod
+    def from_topic_viewpoints(
+        cls,
+        topic_dir: zipfile.Path,
+        vps: Iterable[mdl.ViewPoint],
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> dict[str, "VisualizationInfoHandler"]:
+        """Create VisualizationInfoHandler objects of a Topic's ViewPoints."""
+        viewpoints = {}
+        for vpt in vps:
+            visinfo = cls.load(topic_dir, vpt, xml_handler)
+            if visinfo and vpt.viewpoint:
+                viewpoints[vpt.viewpoint] = visinfo
+        return viewpoints
+
+    @classmethod
+    def load(
+        cls,
+        topic_dir: zipfile.Path,
+        vpt: mdl.ViewPoint,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> Optional["VisualizationInfoHandler"]:
+        """
+        Load the VisualizationInfo and related objects from a BCF zip file.
+
+        Args:
+            topic_dir: The directory in the BCF zip file to load from.
+            vpt: The ViewPoint to load.
+            xml_handler: The XML handler to use to parse the VisualizationInfo.
+
+        Returns:
+            The VisualizationInfoHandler object.
+        """
+        visinfo = cls._load_visinfo(topic_dir, vpt.viewpoint, xml_handler)
+        if not visinfo:
+            return None
+        snapshot = cls._load_snapshot(topic_dir, vpt.snapshot)
+        bitmaps = cls._load_bitmaps(topic_dir, visinfo)
+        return cls(visinfo, snapshot, bitmaps, xml_handler)
+
+    @staticmethod
+    def _load_visinfo(
+        topic_dir: zipfile.Path,
+        vp_name: Optional[str],
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> Optional[mdl.VisualizationInfo]:
+        if not vp_name:
+            return None
+        vp_path = topic_dir.joinpath(vp_name)
+        if vp_path.exists():
+            xml_handler = xml_handler or XmlParserSerializer()
+            return xml_handler.parse(vp_path.read_bytes(), mdl.VisualizationInfo)
+        return None
+
+    @staticmethod
+    def _load_snapshot(topic_dir: zipfile.Path, vp_snapshot: Optional[str]) -> Optional[bytes]:
+        if vp_snapshot:
+            snapshot_path = topic_dir.joinpath(vp_snapshot)
+            if snapshot_path.exists():
+                return snapshot_path.read_bytes()
+        return None
+
+    @staticmethod
+    def _load_bitmaps(topic_dir: zipfile.Path, visinfo: Optional[mdl.VisualizationInfo]) -> dict[str, bytes]:
+        if not visinfo or not (bitmaps := visinfo.bitmap):
+            return {}
+        bitmaps_dict = {}
+        for bitmap in bitmaps:
+            if not bitmap.reference:
+                continue
+            bitmap_path = topic_dir.joinpath(bitmap.reference)
+            if bitmap_path.exists():
+                bitmaps_dict[bitmap.reference] = bitmap_path.read_bytes()
+        return bitmaps_dict
+
+    def save(
+        self,
+        bcf_zip: ZipFileInterface,
+        topic_dir: str,
+        vpt: mdl.ViewPoint,
+    ) -> None:
+        """
+        Save the VisualizationInfo and related objects to a BCF zip file.
+
+        Args:
+            bcf_zip: The BCF zip file to save to.
+            topic_dir: The directory in the BCF zip file to save to.
+            vpt: The ViewPoint to save.
+        """
+        if not (vp_name := vpt.viewpoint):
+            return
+        self._save_visinfo(bcf_zip, topic_dir, vp_name)
+        self._save_snapshot(bcf_zip, topic_dir, vpt.snapshot)
+        self._save_bitmaps(bcf_zip, topic_dir)
+
+    def _save_snapshot(self, bcf_zip: ZipFileInterface, topic_dir: str, filename: Optional[str]) -> None:
+        if self.snapshot and filename:
+            bcf_zip.writestr(f"{topic_dir}/{filename}", self.snapshot)
+
+    def _save_visinfo(self, bcf_zip: ZipFileInterface, topic_dir: str, vp_name: str) -> None:
+        bcf_zip.writestr(
+            f"{topic_dir}/{vp_name}",
+            self._xml_handler.serialize(self.visualization_info),
+        )
+
+    def _save_bitmaps(self, bcf_zip: ZipFileInterface, topic_dir: str) -> None:
+        if not self.bitmaps:
+            return
+        if not (bitmaps_defs := self.visualization_info.bitmap):
+            return
+        for bitmap_def in bitmaps_defs:
+            if not (bitmap_name := bitmap_def.reference):
+                continue
+            if bitmap_name in self.bitmaps:
+                bcf_zip.writestr(f"{topic_dir}/{bitmap_name}", self.bitmaps[bitmap_name])
+
+    @classmethod
+    def create_new(
+        cls,
+        element: entity_instance,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> "VisualizationInfoHandler":
+        """
+        Create a new VisualizationInfoHandler object from an IFC element.
+
+        Args:
+            element: The IFC element to point at.
+            xml_handler: The XML handler to use.
+
+        Returns:
+            The VisualizationInfoHandler object.
+        """
+        xml_handler = xml_handler or XmlParserSerializer()
+        return cls(visualization_info=build_viewpoint(element), xml_handler=xml_handler)
+
+    @classmethod
+    def create_from_point_and_guids(
+        cls,
+        position: NDArray[np.float_],
+        *guids: str,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> "VisualizationInfoHandler":
+        """
+        Create a new VisualizationInfoHandler object from an IFC element.
+
+        Args:
+            position: target point coordinates.
+            *guids: One or more IFC element GUID.
+            xml_handler: The XML handler to use.
+
+        Returns:
+            The VisualizationInfoHandler object.
+        """
+        xml_handler = xml_handler or XmlParserSerializer()
+        return cls(
+            visualization_info=build_viewpoint_from_position_and_guids(position, *guids), xml_handler=xml_handler
+        )
+
+
+@lru_cache(maxsize=None)
+def build_viewpoint(element: entity_instance) -> mdl.VisualizationInfo:
+    """
+    Return a BCF viewpoint of an IFC element.
+
+    This function is cached to speedudp the creation of multiple BCF topics regarding the same element.
+
+    Args:
+        element: The IFC element to point at.
+
+    Returns:
+        The BCF viewpoint definition.
+    """
+    ifc_file = element.wrapped_data.file
+    unit_scale = ifcopenshell.util.unit.calculate_unit_scale(ifc_file)
+    elem_placement = ifcopenshell.util.placement.get_local_placement(element.ObjectPlacement)
+    elem_placement[0][3] *= unit_scale
+    elem_placement[1][3] *= unit_scale
+    elem_placement[2][3] *= unit_scale
+
+    return mdl.VisualizationInfo(
+        guid=str(uuid.uuid4()),
+        components=build_components(element.GlobalId),
+        perspective_camera=build_camera(elem_placement),
+    )
+
+
+def build_viewpoint_from_position_and_guids(position: NDArray[np.float_], *guids: str) -> mdl.VisualizationInfo:
+    """
+    Return a BCF viewpoint of an IFC element.
+
+    This function is cached to speedudp the creation of multiple BCF topics regarding the same element.
+
+    Args:
+        position: target point coordinates.
+        *guids: One or more IFC element GUID.
+
+    Returns:
+        The BCF viewpoint definition.
+    """
+    return mdl.VisualizationInfo(
+        guid=str(uuid.uuid4()),
+        components=build_components(*guids),
+        perspective_camera=build_camera_from_vectors(*camera_vectors_from_target_position(position)),
+    )
+
+
+def build_components(*guids: str) -> mdl.Components:
+    """
+    Return the BCF components from an IFC element GUID.
+
+    Args:
+        *guids: One or more IFC element GUID.
+
+    Returns:
+        The BCF components definition.
+    """
+    components = [mdl.Component(ifc_guid=guid) for guid in guids]
+    return mdl.Components(
+        selection=mdl.ComponentSelection(component=components),
+        visibility=mdl.ComponentVisibility(default_visibility=True),
+    )
+
+
+def build_camera(elem_placement: NDArray[np.float_]) -> mdl.PerspectiveCamera:
+    """
+    Return a BCF camera for an IFC element placement matrix.
+
+    Args:
+        elem_placement: The IFC element placement as a rototranslation matrix.
+
+    Returns:
+        The BCF camera definition.
+    """
+    return build_camera_from_vectors(*camera_vectors_from_element_placement(elem_placement))
+
+
+def build_camera_from_vectors(
+    camera_position: NDArray[np.float_], camera_dir: NDArray[np.float_], camera_up: NDArray[np.float_]
+) -> mdl.PerspectiveCamera:
+    """
+    Return a BCF camera for an IFC element placement matrix.
+
+    Args:
+        camera_position: camera position array
+        camera_dir: camera direction versor
+        camera_up_vector: camera up versor
+
+    Returns:
+        The BCF camera definition.
+    """
+    camera_viewpoint = mdl.Point(x=camera_position[0], y=camera_position[1], z=camera_position[2])
+    camera_direction = mdl.Direction(x=camera_dir[0], y=camera_dir[1], z=camera_dir[2])
+    camera_up_vector = mdl.Direction(x=camera_up[0], y=camera_up[1], z=camera_up[2])
+    return mdl.PerspectiveCamera(
+        camera_view_point=camera_viewpoint,
+        camera_direction=camera_direction,
+        camera_up_vector=camera_up_vector,
+        field_of_view=60.0,
+    )

src/bcf/src/bcf/v3/__init__.py

@@ -1,19 +1 @@
-
-# BCF - BCF Python library
-# Copyright (C) 2021 Prabhat Singh <singh01prabhat@gmail.com>
-#
-# This file is part of BCF.
-#
-# BCF is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# BCF is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with BCF.  If not, see <http://www.gnu.org/licenses/>.
-
+"""BCF XML v3 handler."""

src/bcf/src/bcf/v3/bcfapi.py

@@ -1,4 +1,3 @@
-
 # BCF - BCF Python library
 # Copyright (C) 2021 Prabhat Singh <singh01prabhat@gmail.com>
 #
@@ -17,25 +16,27 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with BCF.  If not, see <http://www.gnu.org/licenses/>.
 
-import uuid
-import time
-import json
-import urllib
-import requests
-import webbrowser
-import http.server
 import base64
-import tempfile
+import http.server
 import os
+import tempfile
+import time
+import urllib
+import uuid
+import webbrowser
+from re import A
+from typing import Any, Optional, Tuple
+
+import requests
 
 client_id, client_secret = "", ""
 
 
 class OAuthReceiver(http.server.BaseHTTPRequestHandler):
-    def do_GET(self):
+    def do_GET(self) -> None:
         query = urllib.parse.parse_qs(urllib.parse.urlparse(self.path).query)
-        self.server.auth_code = query.get("code", [""])[0]
-        self.server.auth_state = query.get("state", [""])[0]
+        self.server.auth_code = query.get("code", [""])[0]  # type:ignore
+        self.server.auth_state = query.get("state", [""])[0]  # type:ignore
         self.send_response(200)
         self.send_header("Content-type", "text/plain")
         self.end_headers()
@@ -43,20 +44,21 @@ class OAuthReceiver(http.server.BaseHTTPRequestHandler):
 
 
 class FoundationClient:
-    def __init__(self, client_id, client_secret, base_url=None, redirect_subdir=None):
+    def __init__(
+        self, client_id: str, client_secret: str, base_url: Optional[str] = None, redirect_subdir: Optional[str] = None
+    ) -> None:
         self.baseurl = base_url
         self.access_token = ""
         self.refresh_token = ""
         self.access_token_expires_on = time.time()
         self.refresh_token_expires_on = float("inf")
-        self.auth_endpoint = None
-        self.token_endpoint = None
+        self.token_endpoint = ""
         self.client_id = client_id
         self.client_secret = client_secret
-        self.auth_method = None
+        self.auth_method: Optional[str] = None
         self.redirect_subdir = redirect_subdir
 
-    def get_access_token(self):
+    def get_access_token(self) -> str:
         if self.access_token and self.access_token_expires_on > time.time():
             return self.access_token
         elif self.refresh_token and self.refresh_token_expires_on > time.time():
@@ -65,18 +67,18 @@ class FoundationClient:
             self.login()
         return self.access_token
 
-    def get_auth_methods(self):
+    def get_auth_methods(self) -> list[Any]:
         resp = requests.get(f"{self.baseurl}foundation/1.0/auth")
         return resp.json()["supported_oauth2_flows"]
 
-    def get_versions(self):
+    def get_versions(self) -> list[Any]:
         resp = requests.get(f"{self.baseurl}foundation/versions")
         return resp.json()["versions"]
 
-    def login(self):
+    def login(self) -> None:
         resp = requests.get(f"{self.baseurl}foundation/1.0/auth")
         values = resp.json()
-        self.auth_endpoint = values["oauth2_auth_url"]
+        auth_endpoint = values["oauth2_auth_url"]
         self.token_endpoint = values["oauth2_token_url"]
 
         with http.server.HTTPServer(("", 8080), OAuthReceiver) as server:
@@ -89,25 +91,22 @@ class FoundationClient:
                     "redirect_uri": f"http://localhost:{server.server_address[1]}/{self.redirect_subdir}",
                 }
             )
-            if "?" in self.auth_endpoint:
-                webbrowser.open(f"{self.auth_endpoint}&{query}")
+            if "?" in auth_endpoint:
+                webbrowser.open(f"{auth_endpoint}&{query}")
             else:
-                webbrowser.open(f"{self.auth_endpoint}?{query}")
+                webbrowser.open(f"{auth_endpoint}?{query}")
             server.timeout = 100
-            server.state = state
             server.handle_request()
-            if server.auth_code and server.auth_state == state:
+            if server.auth_code and server.auth_state == state:  # pylint: disable=E1101
                 data = {
                     "grant_type": "authorization_code",
-                    "code": server.auth_code,
+                    "code": server.auth_code,  # pylint: disable=E1101 type:ignore
                     "redirect_uri": f"http://localhost:{server.server_address[1]}/{self.redirect_subdir}",
                 }
-                auth_string = f"{self.client_id}:{self.client_secret}"
-                header_string = base64.b64encode(auth_string.encode("utf-8")).decode("utf-8")
-                headers = {"Authorization": f"Basic {header_string}"}
+                headers = self._get_access_token_headers()
                 self.set_tokens_from_response(requests.post(self.token_endpoint, data=data, headers=headers))
 
-    def get_refresh_token(self):
+    def get_refresh_token(self) -> None:
         self.set_tokens_from_response(
             requests.post(
                 self.token_endpoint,
@@ -118,10 +117,8 @@ class FoundationClient:
             ).json()
         )
 
-    def get_new_access_token(self):
-        auth_string = f"{self.client_id}:{self.client_secret}"
-        header_string = base64.b64encode(auth_string.encode("utf-8")).decode("utf-8")
-        headers = {"Authorization": f"Basic {header_string}"}
+    def get_new_access_token(self) -> None:
+        headers = self._get_access_token_headers()
         self.set_tokens_from_response(
             requests.post(
                 self.token_endpoint,
@@ -133,35 +130,41 @@ class FoundationClient:
             ).json()
         )
 
-    def set_auth_method(self, method="authorization_code_grant"):
+    def _get_access_token_headers(self) -> dict[str, str]:
+        auth_string = f"{self.client_id}:{self.client_secret}"
+        header_string = base64.b64encode(auth_string.encode("utf-8")).decode("utf-8")
+        return {"Authorization": f"Basic {header_string}"}
+
+    def set_auth_method(self, method: str = "authorization_code_grant") -> None:
         if method != "authorization_code_grant":
             raise NotImplementedError(f"{method} not supported")
         else:
             self.auth_method = method
 
-    def set_tokens_from_response(self, response):
-        response = response.json()
-        self.access_token = response["access_token"]
-        self.refresh_token = response["refresh_token"]
-        self.access_token_expires_on = time.time() + response["expires_in"]
-        if "refresh_token_expires_in" in response:
-            self.refresh_token_expires_on = time.time() + response["refresh_token_expires_in"]
+    def set_tokens_from_response(self, response: requests.Response) -> None:
+        response_dict = response.json()
+        self.access_token = response_dict["access_token"]
+        self.refresh_token = response_dict["refresh_token"]
+        self.access_token_expires_on = time.time() + response_dict["expires_in"]
+        if "refresh_token_expires_in" in response_dict:
+            self.refresh_token_expires_on = time.time() + response_dict["refresh_token_expires_in"]
 
 
 class BcfClient:
-    def __init__(self, foundation_client):
+    def __init__(self, foundation_client: FoundationClient) -> None:
         self.foundation_client = foundation_client
-        self.version_id = None
-        self.baseurl = None
+        self.version_id: Optional[str] = None
+        self.baseurl: Optional[str] = None
         self.filepath = tempfile.mkdtemp()
 
-    def set_version(self, version):
+    def set_version(self, version: dict[str, str]) -> None:
         self.version_id = version["version_id"]
         self.baseurl = version["api_base_url"]
 
-    def get(self, endpoint, params=None, is_auth_required=False):
+    def get(self, endpoint: str, params: Any = None, is_auth_required: bool = False) -> Any:
         # TODO: handle error http status codes and raise exception. Follow error.json standard.
-        headers = {"Authorization": "Bearer " + self.foundation_client.get_access_token()}
+        headers = {"Authorization": f"Bearer {self.foundation_client.get_access_token()}"}
+
         response = requests.get(f"{self.baseurl}{endpoint}", headers=headers, params=params or None)
         try:
             response = requests.get(f"{self.baseurl}{endpoint}", headers=headers, params=params or None)
@@ -171,68 +174,62 @@ class BcfClient:
         except requests.exceptions.HTTPError as e:
             print(f"message: {response.reason}'   '{response.status_code}'   '{ e }")
 
-    def post(self, endpoint, data=None, params=None):
+    def post(self, endpoint: str, data: Any = None, params: Any = None) -> Tuple[int, str]:
         headers = {
-            "Authorization": "Bearer " + self.foundation_client.get_access_token(),
+            "Authorization": f"Bearer {self.foundation_client.get_access_token()}",
             "Content-type": "application/json",
         }
+
         try:
             response = requests.post(
-                f"{self.baseurl}{endpoint}",
-                headers=headers,
-                params=params or None,
-                data=data or None,
+                f"{self.baseurl}{endpoint}", headers=headers, params=params or None, data=data or None
             )
-            if response.status_code == 201:
-                return response.status_code, response.text
-            response.raise_for_status()
+
+            if response.status_code != 201:
+                response.raise_for_status()
+            return response.status_code, response.text
         except requests.exceptions.HTTPError as errh:
             print(f"message: {response.reason}'  '{response.status_code}, {errh}")
+            return response.status_code, response.reason
 
-    def put(self, endpoint, data=None, params=None):
+    def put(self, endpoint: str, data: Any = None, params: Any = None) -> Tuple[int, str]:
         headers = {
-            "Authorization": "Bearer " + self.foundation_client.get_access_token(),
+            "Authorization": f"Bearer {self.foundation_client.get_access_token()}",
             "Content-type": "application/json",
         }
+
         try:
             response = requests.put(
-                f"{self.baseurl}{endpoint}",
-                headers=headers,
-                params=params or None,
-                data=data or None,
+                f"{self.baseurl}{endpoint}", headers=headers, params=params or None, data=data or None
             )
-            if response.status_code == 200:
-                return response.status_code, response.text
-            response.raise_for_status()
+
+            if response.status_code != 200:
+                response.raise_for_status()
+            return response.status_code, response.text
         except requests.exceptions.HTTPError as errh:
             print(f"message: {response.reason}'  '{response.status_code}, {errh}")
+            return response.status_code, response.reason
 
-    def delete(self, endpoint, params=None):
+    def delete(self, endpoint: str, params: Any = None) -> Tuple[int, str]:
         headers = {
-            "Authorization": "Bearer " + self.foundation_client.get_access_token(),
+            "Authorization": f"Bearer {self.foundation_client.get_access_token()}",
             "Content-type": "application/json",
         }
+
         try:
-            response = requests.delete(
-                f"{self.baseurl}{endpoint}",
-                headers=headers,
-                params=params or None,
-            )
-            if response.status_code == 200:
-                return response.status_code, response.text
-            response.raise_for_status()
+            response = requests.delete(f"{self.baseurl}{endpoint}", headers=headers, params=params or None)
+
+            if response.status_code != 200:
+                response.raise_for_status()
+            return response.status_code, response.text
         except requests.exceptions.HTTPError as errh:
             print(f"message: {response.reason}'  '{response.status_code}, {errh}")
+            return response.status_code, response.reason
 
-    def get_projects(self) -> list:
-        return self.get(
-            f"/projects",
-        )
+    def get_projects(self) -> list[Any]:
+        return self.get("/projects")
 
-    def get_project(
-        self,
-        project_id="",
-    ) -> dict:
+    def get_project(self, project_id: str = "") -> dict[str, Any]:
         return self.get(
             f"/projects/{project_id}",
             {
@@ -240,16 +237,13 @@ class BcfClient:
             },
         )
 
-    def update_project(self, project_id="", data=None) -> dict:
+    def update_project(self, project_id: str = "", data: Any = None) -> Tuple[int, str]:
         url = f"{self.baseurl}/projects/{project_id}"
-        headers = {"Authorization": "Bearer " + self.foundation_client.get_access_token()}
+        headers = {"Authorization": f"Bearer {self.foundation_client.get_access_token()}"}
         resp = requests.put(url, headers=headers, data=data)
         return resp.status_code, resp.text
 
-    def get_extensions(
-        self,
-        project_id="",
-    ) -> dict:
+    def get_extensions(self, project_id: str = "") -> dict[str, Any]:
         return self.get(
             f"/projects/{project_id}/extensions",
             {
@@ -259,10 +253,10 @@ class BcfClient:
 
     def get_topics(
         self,
-        project_id="",
-        topics="",
-        query_string=None,
-    ) -> list:
+        project_id: str = "",
+        topics: str = "",
+        query_string: Optional[str] = None,
+    ) -> list[Any]:
         # return self.get(
         #     f"/projects/{project_id}/topics",
         #     {
@@ -273,7 +267,7 @@ class BcfClient:
         # )
         pass
 
-    def get_topic(self, project_id="", topic_id="") -> dict:
+    def get_topic(self, project_id: str = "", topic_id: str = "") -> dict[str, Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}",
             {
@@ -282,42 +276,40 @@ class BcfClient:
             },
         )
 
-    def create_topic(self, project_id="", data=None):
+    def create_topic(self, project_id: str = "", data: Any = None) -> Tuple[int, str]:
         return self.post(f"/projects/{project_id}/topics", data=data)
 
-    def update_topic(self, project_id="", topic_id="", data=None) -> dict:
+    def update_topic(self, project_id: str = "", topic_id: str = "", data: Any = None) -> Tuple[int, str]:
         return self.put(f"/projects/{project_id}/topics/{topic_id}", data=data)
 
-    def delete_topic(self, project_id="", topic_id=""):
+    def delete_topic(self, project_id: str = "", topic_id: str = "") -> Tuple[int, str]:
         return self.delete(f"/projects/{project_id}/topics/{topic_id}")
 
-    def get_snippet(self, project_id="", topic_id="") -> str:
+    def get_snippet(self, project_id: str = "", topic_id: str = "") -> Tuple[int, str]:
         headers = {
-            "Authorization": "Bearer " + self.foundation_client.get_access_token(),
+            "Authorization": f"Bearer {self.foundation_client.get_access_token()}",
             "Content-type": "application/octet-stream",
         }
-        response = requests.get(
-            f"{self.baseurl}/projects/{project_id}/topics/{topic_id}/snippet",
-            headers=headers,
-        )
-        # TODO: write to tmpdir
-        with open(os.path.join(self.filepath, f"{project_id}_{topic_id}_snippet.txt"), "wb") as f:
-            f.write(response.content.decode("utf-8"))
-        return response.status_code, response.content
 
-    def update_snippet(self, project_id="", topic_id="", files=None, data=None):
+        response = requests.get(f"{self.baseurl}/projects/{project_id}/topics/{topic_id}/snippet", headers=headers)
+        content = response.content.decode("utf-8")
+        with open(os.path.join(self.filepath, f"{project_id}_{topic_id}_snippet.txt"), "w") as f:
+            f.write(content)
+        return response.status_code, content
+
+    def update_snippet(self, project_id: str = "", topic_id: str = "", files: Any = None, data: Any = None) -> int:
         headers = {
-            "Authorization": "Bearer " + self.foundation_client.get_access_token(),
+            "Authorization": f"Bearer {self.foundation_client.get_access_token()}",
             "Content-type": "application/octet-stream",
         }
+
         response = requests.put(
-            f"{self.baseurl}/projects/{project_id}/topics/{topic_id}/snippet",
-            headers=headers,
-            files=files,
+            f"{self.baseurl}/projects/{project_id}/topics/{topic_id}/snippet", headers=headers, files=files
         )
+
         return response.status_code
 
-    def get_files_information(self, project_id="") -> list:
+    def get_files_information(self, project_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/files_information",
             {
@@ -325,7 +317,7 @@ class BcfClient:
             },
         )
 
-    def get_files(self, project_id="", topic_id="") -> list:
+    def get_files(self, project_id: str = "", topic_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/files",
             {
@@ -336,32 +328,32 @@ class BcfClient:
 
     def update_files(
         self,
-        project_id="",
-        topic_id="",
-        data=None,
-        params=None,
-    ):
+        project_id: str = "",
+        topic_id: str = "",
+        data: Any = None,
+        params: Any = None,
+    ) -> Tuple[int, str]:
         return self.put(
             f"/projects/{project_id}/topics/{topic_id}/files",
             data=data,
         )
 
-    def get_comments(self, project_id="", topic_id="") -> list:
+    def get_comments(self, project_id: str = "", topic_id: str = "") -> None:
         pass
 
     def create_comments(
         self,
-        project_id="",
-        topic_id="",
-        data=None,
-        params=None,
-    ):
+        project_id: str = "",
+        topic_id: str = "",
+        data: Any = None,
+        params: Any = None,
+    ) -> Tuple[int, str]:
         return self.post(
             f"/projects/{project_id}/topics/{topic_id}/comments",
             data=data,
         )
 
-    def get_comment(self, project_id="", topic_id="", comment_id="") -> dict:
+    def get_comment(self, project_id: str = "", topic_id: str = "", comment_id: str = "") -> dict[str, Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/comments/{comment_id}",
             {
@@ -371,22 +363,22 @@ class BcfClient:
             },
         )
 
-    def delete_comment(self, project_id="", topic_id="", comment_id=""):
+    def delete_comment(self, project_id: str = "", topic_id: str = "", comment_id: str = "") -> Tuple[int, str]:
         return self.delete(f"/projects/{project_id}/topics/{topic_id}/comments/{comment_id}")
 
     def update_comment(
         self,
-        project_id="",
-        topic_id="",
-        comment_id="",
-        data=None,
-    ):
+        project_id: str = "",
+        topic_id: str = "",
+        comment_id: str = "",
+        data: Any = None,
+    ) -> Tuple[int, str]:
         return self.put(
             f"/projects/{project_id}/topics/{topic_id}/comments/{comment_id}",
             data=data,
         )
 
-    def get_viewpoints(self, project_id="", topic_id="") -> list:
+    def get_viewpoints(self, project_id: str = "", topic_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints",
             {
@@ -395,13 +387,13 @@ class BcfClient:
             },
         )
 
-    def create_viewpoints(self, project_id="", topic_id="", data=None):
+    def create_viewpoints(self, project_id: str = "", topic_id: str = "", data: Any = None) -> Tuple[int, str]:
         return self.post(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints",
             data=data,
         )
 
-    def get_viewpoint(self, project_id="", topic_id="", viewpoint_id="") -> dict:
+    def get_viewpoint(self, project_id: str = "", topic_id: str = "", viewpoint_id: str = "") -> dict[str, Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints/{viewpoint_id}",
             {
@@ -413,15 +405,15 @@ class BcfClient:
 
     def delete_viewpoint(
         self,
-        project_id="",
-        topic_id="",
-        viewpoint_id="",
-    ):
+        project_id: str = "",
+        topic_id: str = "",
+        viewpoint_id: str = "",
+    ) -> Tuple[int, str]:
         return self.delete(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints/{viewpoint_id}",
         )
 
-    def get_snapshot(self, project_id="", topic_id="", viewpoint_id="") -> str:
+    def get_snapshot(self, project_id: str = "", topic_id: str = "", viewpoint_id: str = "") -> str:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints/{viewpoint_id}/snapshot",
             {
@@ -431,7 +423,7 @@ class BcfClient:
             },
         )
 
-    def get_bitmap(self, project_id="", topic_id="", viewpoint_id="", bitmap_id="") -> str:
+    def get_bitmap(self, project_id: str = "", topic_id: str = "", viewpoint_id: str = "", bitmap_id: str = "") -> str:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints/{viewpoint_id}/bitmaps/{bitmap_id}",
             {
@@ -442,7 +434,7 @@ class BcfClient:
             },
         )
 
-    def get_selection(self, project_id="", topic_id="", viewpoint_id="") -> dict:
+    def get_selection(self, project_id: str = "", topic_id: str = "", viewpoint_id: str = "") -> dict[str, Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints/{viewpoint_id}/selection",
             {
@@ -452,7 +444,7 @@ class BcfClient:
             },
         )
 
-    def get_coloring(self, project_id="", topic_id="", viewpoint_id="") -> dict:
+    def get_coloring(self, project_id: str = "", topic_id: str = "", viewpoint_id: str = "") -> dict[str, Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints/{viewpoint_id}/coloring",
             {
@@ -462,7 +454,7 @@ class BcfClient:
             },
         )
 
-    def get_visibility(self, project_id="", topic_id="", viewpoint_id="") -> dict:
+    def get_visibility(self, project_id: str = "", topic_id: str = "", viewpoint_id: str = "") -> dict[str, Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/viewpoints/{viewpoint_id}/visibility",
             {
@@ -472,7 +464,7 @@ class BcfClient:
             },
         )
 
-    def get_related_topics(self, project_id="", topic_id="") -> list:
+    def get_related_topics(self, project_id: str = "", topic_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/related_topics",
             {
@@ -483,16 +475,16 @@ class BcfClient:
 
     def update_related_topics(
         self,
-        project_id="",
-        topic_id="",
-        data=None,
-    ):
+        project_id: str = "",
+        topic_id: str = "",
+        data: Any = None,
+    ) -> Tuple[int, str]:
         return self.put(
             f"/projects/{project_id}/topics/{topic_id}/related_topics",
             data=data,
         )
 
-    def get_document_references(self, project_id="", topic_id="") -> list:
+    def get_document_references(self, project_id: str = "", topic_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/document_references",
             {
@@ -503,10 +495,10 @@ class BcfClient:
 
     def create_document_reference(
         self,
-        project_id="",
-        topic_id="",
-        data=None,
-    ):
+        project_id: str = "",
+        topic_id: str = "",
+        data: Any = None,
+    ) -> Tuple[int, str]:
         return self.post(
             f"/projects/{project_id}/topics/{topic_id}/document_references",
             data=data,
@@ -514,17 +506,17 @@ class BcfClient:
 
     def update_document_references(
         self,
-        project_id="",
-        topic_id="",
-        document_reference_id="",
-        data=None,
-    ):
+        project_id: str = "",
+        topic_id: str = "",
+        document_reference_id: str = "",
+        data: Any = None,
+    ) -> Tuple[int, str]:
         return self.put(
             f"/projects/{project_id}/topics/{topic_id}/document_references/{document_reference_id}",
             data=data,
         )
 
-    def get_documents(self, project_id="", topic_id="") -> list:
+    def get_documents(self, project_id: str = "", topic_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/documents",
             {
@@ -534,40 +526,36 @@ class BcfClient:
         )
 
     def create_document(
-        self,
-        project_id="",
-        topic_id="",
-        guid=None,
-        files=None,
-        data=None,
-    ):
+        self, project_id: str = "", topic_id: str = "", guid: Optional[str] = None, files: Any = None, data: Any = None
+    ) -> int:
         headers = {
-            "Authorization": "Bearer " + self.foundation_client.get_access_token(),
+            "Authorization": f"Bearer {self.foundation_client.get_access_token()}",
             "Content-type": "application/octet-stream",
         }
+
         response = requests.post(
             f"/projects/{project_id}/topics/{topic_id}/documents",
             data=data,
-            params={guid},
+            params={"guid": guid},
             files=files,
             headers=headers,
         )
+
         return response.status_code
 
-    def get_document(self, project_id="", topic_id="", document_id="") -> str:
+    def get_document(self, project_id: str = "", topic_id: str = "", document_id: str = "") -> Tuple[int, str]:
         headers = {
-            "Authorization": "Bearer " + self.foundation_client.get_access_token(),
+            "Authorization": f"Bearer {self.foundation_client.get_access_token()}",
             "Content-type": "application/octet-stream",
         }
-        response = requests.get(
-            f"{self.baseurl}/projects/{project_id}/topics/documents/{document_id}",
-            headers=headers,
-        )
-        with open(os.path.join(self.filepath, f"{project_id}_{topic_id}_{document_id}_document.txt"), "wb") as f:
-            f.write(response.content.decode("utf-8"))
-        return response.status_code, response.content
 
-    def get_topics_events(self, project_id="") -> list:
+        response = requests.get(f"{self.baseurl}/projects/{project_id}/topics/documents/{document_id}", headers=headers)
+        content = response.content.decode("utf-8")
+        with open(os.path.join(self.filepath, f"{project_id}_{topic_id}_{document_id}_document.txt"), "w") as f:
+            f.write(content)
+        return response.status_code, content
+
+    def get_topics_events(self, project_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/events",
             {
@@ -575,7 +563,7 @@ class BcfClient:
             },
         )
 
-    def get_topic_events(self, project_id="", topic_id="") -> list:
+    def get_topic_events(self, project_id: str = "", topic_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/events",
             {
@@ -584,7 +572,7 @@ class BcfClient:
             },
         )
 
-    def get_comments_events(self, project_id="") -> list:
+    def get_comments_events(self, project_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/comments/events",
             {
@@ -592,7 +580,7 @@ class BcfClient:
             },
         )
 
-    def get_comment_events(self, project_id="", topic_id="", comment_id="") -> list:
+    def get_comment_events(self, project_id: str = "", topic_id: str = "", comment_id: str = "") -> list[Any]:
         return self.get(
             f"/projects/{project_id}/topics/{topic_id}/comments/{comment_id}/events",
             {

src/bcf/src/bcf/v3/data.py

@@ -1,200 +0,0 @@
-
-# BCF - BCF Python library
-# Copyright (C) 2021 Prabhat Singh <singh01prabhat@gmail.com>
-#
-# This file is part of BCF.
-#
-# BCF is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# BCF is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with BCF.  If not, see <http://www.gnu.org/licenses/>.
-
-class Project:
-    def __init__(self):
-        self.project_id = ""
-        self.name = ""
-
-
-class BimSnippet:
-    def __init__(self):
-        self.snippet_type = None
-        self.is_external = False
-        self.reference = None
-        self.reference_schema = None
-
-
-class DocumentReference:
-    def __init__(self):
-        self.description = None
-        self.document_guid = None
-        self.url = None
-        self.guid = None
-
-
-class RelatedTopic:
-    def __init__(self):
-        self.guid = None
-
-
-class HeaderFile:
-    def __init__(self):
-        self.file_name = ""
-        self.date = None
-        self.reference = ""
-        self.ifc_project = None
-        self.ifc_spatial_structure_element = None
-        self.is_external = True
-
-
-class Header:
-    def __init__(self):
-        self.files = []
-
-
-class Topic:
-    def __init__(self):
-        self.reference_links = []
-        self.title = ""
-        self.priority = None
-        self.index = None  # Deprecated, stored, but ignored
-        self.labels = []
-        self.creation_date = None
-        self.creation_author = None
-        self.modified_date = None
-        self.modified_author = None
-        self.due_date = None
-        self.assigned_to = None
-        self.stage = None
-        self.description = None
-        self.bim_snippet = None
-        self.document_references = []
-        self.related_topics = []
-        self.topic_status = None
-        self.topic_type = None
-        self.guid = None
-
-        self.header = None
-        self.comments = {}
-        self.viewpoints = {}
-        self.server_assigned_id = ""
-
-
-class Comment:
-    def __init__(self):
-        self.guid = None
-        self.date = None
-        self.author = ""
-        self.comment = ""
-        self.viewpoint = None
-        self.modified_date = None
-        self.modified_author = ""
-
-
-class ViewSetupHints:
-    def __init__(self):
-        self.spaces_visible = False
-        self.space_boundaries_visible = False
-        self.openings_visible = False
-
-
-class Component:
-    def __init__(self):
-        self.originating_system = None
-        self.authoring_tool_id = None
-        self.ifc_guid = None
-
-
-class ComponentVisibility:
-    def __init__(self):
-        self.exceptions = []
-        self.default_visibility = False
-        self.view_setup_hints = None
-
-
-class Color:
-    def __init__(self):
-        self.color = None
-        self.components = []
-
-
-class Components:
-    def __init__(self):
-
-        self.selection = []
-        self.visibility = None
-        self.coloring = []
-
-
-class Point:
-    def __init__(self):
-        self.x = 0
-        self.y = 0
-        self.z = 0
-
-
-class Direction(Point):
-    pass
-
-
-class OrthogonalCamera:
-    def __init__(self):
-        self.camera_view_point = Point()
-        self.camera_direction = Direction()
-        self.camera_up_vector = Direction()
-        self.view_to_world_scale = 1.0
-        self.aspect_ratio = 1.0
-
-
-class PerspectiveCamera:
-    def __init__(self):
-        self.camera_view_point = Point()
-        self.camera_direction = Direction()
-        self.camera_up_vector = Direction()
-        self.field_of_view = 60.0
-        self.aspect_ratio = 1.0
-
-
-class Line:
-    def __init__(self):
-        self.start_point = Point()
-        self.end_point = Point()
-
-
-class ClippingPlane:
-    def __init__(self):
-        self.location = Point()
-        self.direction = Direction()
-
-
-class Bitmap:
-    def __init__(self):
-        self.reference = ""  # Only in BCF-XML
-        self.bitmap_data = None  # Only in BCF-API
-        self.bitmap_format = "PNG"  # Enum of png or jpg
-        self.location = Point()
-        self.normal = Direction()
-        self.up = Direction()
-        self.height = 1.0
-
-
-class Viewpoint:
-    def __init__(self):
-        self.guid = None
-        self.viewpoint = None
-        self.snapshot = None
-        self.index = None
-
-        self.components = None  # It's not a list, despite the plural name
-        self.orthogonal_camera = None
-        self.perspective_camera = None
-        self.lines = []
-        self.clipping_planes = []
-        self.bitmaps = []

src/bcf/src/bcf/v3/document.py

@@ -0,0 +1,61 @@
+"""BCF XML V3 Documents handler."""
+import zipfile
+from typing import Any, Optional
+
+import bcf.v3.model as mdl
+from bcf.inmemory_zipfile import ZipFileInterface
+from bcf.xml_parser import AbstractXmlParserSerializer, XmlParserSerializer
+
+
+class DocumentsHandler:
+    """BCF documents handler."""
+
+    def __init__(
+        self,
+        definition: mdl.DocumentInfo,
+        documents: Optional[dict[str, bytes]] = None,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> None:
+        self.definition = definition
+        self.documents = documents or {}
+        self._xml_handler = xml_handler or XmlParserSerializer()
+
+    @classmethod
+    def load(
+        cls,
+        zip_file: zipfile.ZipFile,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> Optional["DocumentsHandler"]:
+        """
+        Loads the documents from the given zip file directory.
+
+        Args:
+            zip_path: The directory path inside the zip file.
+            xml_handler: The xml parser/serializer to use.
+
+        Returns:
+            The documents handler.
+        """
+        xml_handler = xml_handler or XmlParserSerializer()
+        file_to_open = zipfile.Path(zip_file, "documents.xml")
+        if not file_to_open.exists():
+            return None
+        definition = xml_handler.parse(file_to_open.read_bytes(), mdl.DocumentInfo)
+        documents = {}
+        if def_docs := definition.documents:
+            for document in def_docs.document:
+                document_path = zipfile.Path(zip_file, f"documents/{document.guid}")
+                if document_path.exists():
+                    documents[document.filename] = document_path.read_bytes()
+        return cls(definition, documents=documents)
+
+    def save(self, bcf_zip: ZipFileInterface) -> None:
+        """Save the documents to the zip file."""
+        bcf_zip.writestr("documents.xml", self._xml_handler.serialize(self.definition))
+        if documents := self.definition.documents:
+            for doc in documents.document:
+                if doc.filename in self.documents:
+                    bcf_zip.writestr(
+                        f"documents/{doc.guid}",
+                        self.documents[doc.filename],
+                    )

src/bcf/src/bcf/v3/model/__init__.py

@@ -0,0 +1,110 @@
+from bcf.v3.model.documents import Document, DocumentInfo, DocumentInfoDocuments
+from bcf.v3.model.extensions import (
+    Extensions,
+    ExtensionsPriorities,
+    ExtensionsSnippetTypes,
+    ExtensionsStages,
+    ExtensionsTopicLabels,
+    ExtensionsTopicStatuses,
+    ExtensionsTopicTypes,
+    ExtensionsUsers,
+)
+from bcf.v3.model.markup import (
+    BimSnippet,
+    Comment,
+    CommentViewpoint,
+    DocumentReference,
+    File,
+    Header,
+    HeaderFiles,
+    Markup,
+    Topic,
+    TopicComments,
+    TopicDocumentReferences,
+    TopicLabels,
+    TopicReferenceLinks,
+    TopicRelatedTopics,
+    TopicRelatedTopicsRelatedTopic,
+    TopicViewpoints,
+    ViewPoint,
+)
+from bcf.v3.model.project import Project, ProjectInfo
+from bcf.v3.model.version import Version
+from bcf.v3.model.visinfo import (
+    Bitmap,
+    BitmapFormat,
+    ClippingPlane,
+    Component,
+    ComponentColoring,
+    ComponentColoringColor,
+    ComponentColoringColorComponents,
+    Components,
+    ComponentSelection,
+    ComponentVisibility,
+    ComponentVisibilityExceptions,
+    Direction,
+    Line,
+    OrthogonalCamera,
+    PerspectiveCamera,
+    Point,
+    ViewSetupHints,
+    VisualizationInfo,
+    VisualizationInfoBitmaps,
+    VisualizationInfoClippingPlanes,
+    VisualizationInfoLines,
+)
+
+__all__ = [
+    "Document",
+    "DocumentInfo",
+    "DocumentInfoDocuments",
+    "Extensions",
+    "ExtensionsPriorities",
+    "ExtensionsSnippetTypes",
+    "ExtensionsStages",
+    "ExtensionsTopicLabels",
+    "ExtensionsTopicStatuses",
+    "ExtensionsTopicTypes",
+    "ExtensionsUsers",
+    "BimSnippet",
+    "Comment",
+    "CommentViewpoint",
+    "DocumentReference",
+    "File",
+    "Header",
+    "HeaderFiles",
+    "Markup",
+    "Topic",
+    "TopicComments",
+    "TopicDocumentReferences",
+    "TopicLabels",
+    "TopicReferenceLinks",
+    "TopicRelatedTopics",
+    "TopicRelatedTopicsRelatedTopic",
+    "TopicViewpoints",
+    "ViewPoint",
+    "Project",
+    "ProjectInfo",
+    "Version",
+    "Bitmap",
+    "BitmapFormat",
+    "ClippingPlane",
+    "Component",
+    "ComponentColoring",
+    "ComponentColoringColor",
+    "ComponentColoringColorComponents",
+    "ComponentSelection",
+    "ComponentVisibility",
+    "ComponentVisibilityExceptions",
+    "Components",
+    "Direction",
+    "Line",
+    "OrthogonalCamera",
+    "PerspectiveCamera",
+    "Point",
+    "ViewSetupHints",
+    "VisualizationInfo",
+    "VisualizationInfoBitmaps",
+    "VisualizationInfoClippingPlanes",
+    "VisualizationInfoLines",
+]

src/bcf/src/bcf/v3/model/documents.py

@@ -0,0 +1,61 @@
+from dataclasses import dataclass, field
+from typing import List, Optional
+
+
+@dataclass(slots=True, kw_only=True)
+class Document:
+    filename: str = field(
+        metadata={
+            "name": "Filename",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    description: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Description",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class DocumentInfoDocuments:
+    class Meta:
+        global_type = False
+
+    document: List[Document] = field(
+        default_factory=list,
+        metadata={
+            "name": "Document",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class DocumentInfo:
+    documents: Optional[DocumentInfoDocuments] = field(
+        default=None,
+        metadata={
+            "name": "Documents",
+            "type": "Element",
+            "namespace": "",
+        }
+    )

src/bcf/src/bcf/v3/model/extensions.py

@@ -0,0 +1,181 @@
+from dataclasses import dataclass, field
+from typing import List, Optional
+
+
+@dataclass(slots=True, kw_only=True)
+class ExtensionsPriorities:
+    class Meta:
+        global_type = False
+
+    priority: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "Priority",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ExtensionsSnippetTypes:
+    class Meta:
+        global_type = False
+
+    snippet_type: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "SnippetType",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ExtensionsStages:
+    class Meta:
+        global_type = False
+
+    stage: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "Stage",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ExtensionsTopicLabels:
+    class Meta:
+        global_type = False
+
+    topic_label: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "TopicLabel",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ExtensionsTopicStatuses:
+    class Meta:
+        global_type = False
+
+    topic_status: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "TopicStatus",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ExtensionsTopicTypes:
+    class Meta:
+        global_type = False
+
+    topic_type: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "TopicType",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ExtensionsUsers:
+    class Meta:
+        global_type = False
+
+    user: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "User",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Extensions:
+    topic_types: Optional[ExtensionsTopicTypes] = field(
+        default=None,
+        metadata={
+            "name": "TopicTypes",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    topic_statuses: Optional[ExtensionsTopicStatuses] = field(
+        default=None,
+        metadata={
+            "name": "TopicStatuses",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    priorities: Optional[ExtensionsPriorities] = field(
+        default=None,
+        metadata={
+            "name": "Priorities",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    topic_labels: Optional[ExtensionsTopicLabels] = field(
+        default=None,
+        metadata={
+            "name": "TopicLabels",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    users: Optional[ExtensionsUsers] = field(
+        default=None,
+        metadata={
+            "name": "Users",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    snippet_types: Optional[ExtensionsSnippetTypes] = field(
+        default=None,
+        metadata={
+            "name": "SnippetTypes",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    stages: Optional[ExtensionsStages] = field(
+        default=None,
+        metadata={
+            "name": "Stages",
+            "type": "Element",
+            "namespace": "",
+        }
+    )

src/bcf/src/bcf/v3/model/markup.py

@@ -0,0 +1,616 @@
+from dataclasses import dataclass, field
+from typing import List, Optional
+
+from xsdata.models.datatype import XmlDateTime
+
+
+@dataclass(slots=True, kw_only=True)
+class BimSnippet:
+    reference: str = field(
+        metadata={
+            "name": "Reference",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    reference_schema: str = field(
+        metadata={
+            "name": "ReferenceSchema",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    snippet_type: str = field(
+        metadata={
+            "name": "SnippetType",
+            "type": "Attribute",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    is_external: bool = field(
+        default=False,
+        metadata={
+            "name": "IsExternal",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class CommentViewpoint:
+    class Meta:
+        global_type = False
+
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class DocumentReference:
+    document_guid: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "DocumentGuid",
+            "type": "Element",
+            "namespace": "",
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )
+    url: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Url",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    description: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Description",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class File:
+    filename: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Filename",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    date: Optional[XmlDateTime] = field(
+        default=None,
+        metadata={
+            "name": "Date",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    reference: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Reference",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    ifc_project: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "IfcProject",
+            "type": "Attribute",
+            "length": 22,
+            "pattern": r"[0-9A-Za-z_$]*",
+        }
+    )
+    ifc_spatial_structure_element: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "IfcSpatialStructureElement",
+            "type": "Attribute",
+            "length": 22,
+            "pattern": r"[0-9A-Za-z_$]*",
+        }
+    )
+    is_external: bool = field(
+        default=True,
+        metadata={
+            "name": "IsExternal",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicLabels:
+    class Meta:
+        global_type = False
+
+    label: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "Label",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicReferenceLinks:
+    class Meta:
+        global_type = False
+
+    reference_link: List[str] = field(
+        default_factory=list,
+        metadata={
+            "name": "ReferenceLink",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicRelatedTopicsRelatedTopic:
+    class Meta:
+        global_type = False
+
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ViewPoint:
+    viewpoint: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Viewpoint",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    snapshot: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Snapshot",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    index: Optional[int] = field(
+        default=None,
+        metadata={
+            "name": "Index",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Comment:
+    date: XmlDateTime = field(
+        metadata={
+            "name": "Date",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    author: str = field(
+        metadata={
+            "name": "Author",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    comment: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Comment",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    viewpoint: Optional[CommentViewpoint] = field(
+        default=None,
+        metadata={
+            "name": "Viewpoint",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    modified_date: Optional[XmlDateTime] = field(
+        default=None,
+        metadata={
+            "name": "ModifiedDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    modified_author: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "ModifiedAuthor",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class HeaderFiles:
+    class Meta:
+        global_type = False
+
+    file: List[File] = field(
+        default_factory=list,
+        metadata={
+            "name": "File",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicDocumentReferences:
+    class Meta:
+        global_type = False
+
+    document_reference: List[DocumentReference] = field(
+        default_factory=list,
+        metadata={
+            "name": "DocumentReference",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicRelatedTopics:
+    class Meta:
+        global_type = False
+
+    related_topic: List[TopicRelatedTopicsRelatedTopic] = field(
+        default_factory=list,
+        metadata={
+            "name": "RelatedTopic",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicViewpoints:
+    class Meta:
+        global_type = False
+
+    view_point: List[ViewPoint] = field(
+        default_factory=list,
+        metadata={
+            "name": "ViewPoint",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Header:
+    files: Optional[HeaderFiles] = field(
+        default=None,
+        metadata={
+            "name": "Files",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class TopicComments:
+    class Meta:
+        global_type = False
+
+    comment: List[Comment] = field(
+        default_factory=list,
+        metadata={
+            "name": "Comment",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Topic:
+    reference_links: Optional[TopicReferenceLinks] = field(
+        default=None,
+        metadata={
+            "name": "ReferenceLinks",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    title: str = field(
+        metadata={
+            "name": "Title",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    priority: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Priority",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    index: Optional[int] = field(
+        default=None,
+        metadata={
+            "name": "Index",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    labels: Optional[TopicLabels] = field(
+        default=None,
+        metadata={
+            "name": "Labels",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    creation_date: XmlDateTime = field(
+        metadata={
+            "name": "CreationDate",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )
+    creation_author: str = field(
+        metadata={
+            "name": "CreationAuthor",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    modified_date: Optional[XmlDateTime] = field(
+        default=None,
+        metadata={
+            "name": "ModifiedDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    modified_author: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "ModifiedAuthor",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    due_date: Optional[XmlDateTime] = field(
+        default=None,
+        metadata={
+            "name": "DueDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    assigned_to: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "AssignedTo",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    stage: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Stage",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    description: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Description",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    bim_snippet: Optional[BimSnippet] = field(
+        default=None,
+        metadata={
+            "name": "BimSnippet",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    document_references: Optional[TopicDocumentReferences] = field(
+        default=None,
+        metadata={
+            "name": "DocumentReferences",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    related_topics: Optional[TopicRelatedTopics] = field(
+        default=None,
+        metadata={
+            "name": "RelatedTopics",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    comments: Optional[TopicComments] = field(
+        default=None,
+        metadata={
+            "name": "Comments",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    viewpoints: Optional[TopicViewpoints] = field(
+        default=None,
+        metadata={
+            "name": "Viewpoints",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )
+    server_assigned_id: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "ServerAssignedId",
+            "type": "Attribute",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    topic_type: str = field(
+        metadata={
+            "name": "TopicType",
+            "type": "Attribute",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    topic_status: str = field(
+        metadata={
+            "name": "TopicStatus",
+            "type": "Attribute",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Markup:
+    header: Optional[Header] = field(
+        default=None,
+        metadata={
+            "name": "Header",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    topic: Topic = field(
+        metadata={
+            "name": "Topic",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )

src/bcf/src/bcf/v3/model/project.py

@@ -0,0 +1,37 @@
+from dataclasses import dataclass, field
+from typing import Optional
+
+
+@dataclass(slots=True, kw_only=True)
+class Project:
+    name: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "Name",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    project_id: str = field(
+        metadata={
+            "name": "ProjectId",
+            "type": "Attribute",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ProjectInfo:
+    project: Project = field(
+        metadata={
+            "name": "Project",
+            "type": "Element",
+            "namespace": "",
+            "required": True,
+        }
+    )

src/bcf/src/bcf/v3/model/version.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass, field
+
+
+@dataclass(slots=True, kw_only=True)
+class Version:
+    version_id: str = field(
+        metadata={
+            "name": "VersionId",
+            "type": "Attribute",
+            "required": True,
+        }
+    )

src/bcf/src/bcf/v3/model/visinfo.py

@@ -0,0 +1,524 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import List, Optional
+
+
+class BitmapFormat(Enum):
+    PNG = "png"
+    JPG = "jpg"
+
+
+@dataclass(slots=True, kw_only=True)
+class Component:
+    originating_system: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "OriginatingSystem",
+            "type": "Element",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    authoring_tool_id: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "AuthoringToolId",
+            "type": "Element",
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    ifc_guid: Optional[str] = field(
+        default=None,
+        metadata={
+            "name": "IfcGuid",
+            "type": "Attribute",
+            "length": 22,
+            "pattern": r"[0-9A-Za-z_$]*",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Direction:
+    x: float = field(
+        metadata={
+            "name": "X",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    y: float = field(
+        metadata={
+            "name": "Y",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    z: float = field(
+        metadata={
+            "name": "Z",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Point:
+    x: float = field(
+        metadata={
+            "name": "X",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    y: float = field(
+        metadata={
+            "name": "Y",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    z: float = field(
+        metadata={
+            "name": "Z",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ViewSetupHints:
+    spaces_visible: bool = field(
+        default=False,
+        metadata={
+            "name": "SpacesVisible",
+            "type": "Attribute",
+        }
+    )
+    space_boundaries_visible: bool = field(
+        default=False,
+        metadata={
+            "name": "SpaceBoundariesVisible",
+            "type": "Attribute",
+        }
+    )
+    openings_visible: bool = field(
+        default=False,
+        metadata={
+            "name": "OpeningsVisible",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Bitmap:
+    format: BitmapFormat = field(
+        metadata={
+            "name": "Format",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    reference: str = field(
+        metadata={
+            "name": "Reference",
+            "type": "Element",
+            "required": True,
+            "min_length": 1,
+            "white_space": "collapse",
+        }
+    )
+    location: Point = field(
+        metadata={
+            "name": "Location",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    normal: Direction = field(
+        metadata={
+            "name": "Normal",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    up: Direction = field(
+        metadata={
+            "name": "Up",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    height: float = field(
+        metadata={
+            "name": "Height",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ClippingPlane:
+    location: Point = field(
+        metadata={
+            "name": "Location",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    direction: Direction = field(
+        metadata={
+            "name": "Direction",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentColoringColorComponents:
+    class Meta:
+        global_type = False
+
+    component: List[Component] = field(
+        default_factory=list,
+        metadata={
+            "name": "Component",
+            "type": "Element",
+            "min_occurs": 1,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentSelection:
+    component: List[Component] = field(
+        default_factory=list,
+        metadata={
+            "name": "Component",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentVisibilityExceptions:
+    class Meta:
+        global_type = False
+
+    component: List[Component] = field(
+        default_factory=list,
+        metadata={
+            "name": "Component",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Line:
+    start_point: Point = field(
+        metadata={
+            "name": "StartPoint",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    end_point: Point = field(
+        metadata={
+            "name": "EndPoint",
+            "type": "Element",
+            "required": True,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class OrthogonalCamera:
+    """
+    Attributes
+        camera_view_point:
+        camera_direction:
+        camera_up_vector:
+        view_to_world_scale: view's visible vertical size in meters
+        aspect_ratio: Proportional relationship between the width and
+            the height of the view (w/h).
+    """
+    camera_view_point: Point = field(
+        metadata={
+            "name": "CameraViewPoint",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    camera_direction: Direction = field(
+        metadata={
+            "name": "CameraDirection",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    camera_up_vector: Direction = field(
+        metadata={
+            "name": "CameraUpVector",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    view_to_world_scale: float = field(
+        metadata={
+            "name": "ViewToWorldScale",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    aspect_ratio: float = field(
+        metadata={
+            "name": "AspectRatio",
+            "type": "Element",
+            "required": True,
+            "min_exclusive": 0.0,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class PerspectiveCamera:
+    """
+    Attributes
+        camera_view_point:
+        camera_direction:
+        camera_up_vector:
+        field_of_view: Vertical field of view, in degrees. It is
+            currently limited to a value between 45 and 60 degrees. This
+            limitation will be dropped in the next release and viewers
+            should be expect values outside this range in current
+            implementations.
+        aspect_ratio: Proportional relationship between the width and
+            the height of the view (w/h).
+    """
+    camera_view_point: Point = field(
+        metadata={
+            "name": "CameraViewPoint",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    camera_direction: Direction = field(
+        metadata={
+            "name": "CameraDirection",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    camera_up_vector: Direction = field(
+        metadata={
+            "name": "CameraUpVector",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    field_of_view: float = field(
+        metadata={
+            "name": "FieldOfView",
+            "type": "Element",
+            "required": True,
+            "min_exclusive": 0.0,
+            "max_exclusive": 180.0,
+        }
+    )
+    aspect_ratio: float = field(
+        metadata={
+            "name": "AspectRatio",
+            "type": "Element",
+            "required": True,
+            "min_exclusive": 0.0,
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentColoringColor:
+    class Meta:
+        global_type = False
+
+    components: ComponentColoringColorComponents = field(
+        metadata={
+            "name": "Components",
+            "type": "Element",
+            "required": True,
+        }
+    )
+    color: str = field(
+        metadata={
+            "name": "Color",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentVisibility:
+    view_setup_hints: Optional[ViewSetupHints] = field(
+        default=None,
+        metadata={
+            "name": "ViewSetupHints",
+            "type": "Element",
+        }
+    )
+    exceptions: Optional[ComponentVisibilityExceptions] = field(
+        default=None,
+        metadata={
+            "name": "Exceptions",
+            "type": "Element",
+        }
+    )
+    default_visibility: bool = field(
+        default=False,
+        metadata={
+            "name": "DefaultVisibility",
+            "type": "Attribute",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class VisualizationInfoBitmaps:
+    class Meta:
+        global_type = False
+
+    bitmap: List[Bitmap] = field(
+        default_factory=list,
+        metadata={
+            "name": "Bitmap",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class VisualizationInfoClippingPlanes:
+    class Meta:
+        global_type = False
+
+    clipping_plane: List[ClippingPlane] = field(
+        default_factory=list,
+        metadata={
+            "name": "ClippingPlane",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class VisualizationInfoLines:
+    class Meta:
+        global_type = False
+
+    line: List[Line] = field(
+        default_factory=list,
+        metadata={
+            "name": "Line",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class ComponentColoring:
+    color: List[ComponentColoringColor] = field(
+        default_factory=list,
+        metadata={
+            "name": "Color",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class Components:
+    selection: Optional[ComponentSelection] = field(
+        default=None,
+        metadata={
+            "name": "Selection",
+            "type": "Element",
+        }
+    )
+    visibility: Optional[ComponentVisibility] = field(
+        default=None,
+        metadata={
+            "name": "Visibility",
+            "type": "Element",
+        }
+    )
+    coloring: Optional[ComponentColoring] = field(
+        default=None,
+        metadata={
+            "name": "Coloring",
+            "type": "Element",
+        }
+    )
+
+
+@dataclass(slots=True, kw_only=True)
+class VisualizationInfo:
+    """
+    VisualizationInfo documentation.
+    """
+    components: Optional[Components] = field(
+        default=None,
+        metadata={
+            "name": "Components",
+            "type": "Element",
+        }
+    )
+    orthogonal_camera: Optional[OrthogonalCamera] = field(
+        default=None,
+        metadata={
+            "name": "OrthogonalCamera",
+            "type": "Element",
+        }
+    )
+    perspective_camera: Optional[PerspectiveCamera] = field(
+        default=None,
+        metadata={
+            "name": "PerspectiveCamera",
+            "type": "Element",
+        }
+    )
+    lines: Optional[VisualizationInfoLines] = field(
+        default=None,
+        metadata={
+            "name": "Lines",
+            "type": "Element",
+        }
+    )
+    clipping_planes: Optional[VisualizationInfoClippingPlanes] = field(
+        default=None,
+        metadata={
+            "name": "ClippingPlanes",
+            "type": "Element",
+        }
+    )
+    bitmaps: Optional[VisualizationInfoBitmaps] = field(
+        default=None,
+        metadata={
+            "name": "Bitmaps",
+            "type": "Element",
+        }
+    )
+    guid: str = field(
+        metadata={
+            "name": "Guid",
+            "type": "Attribute",
+            "required": True,
+            "pattern": r"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+        }
+    )

src/bcf/src/bcf/v3/topic.py

@@ -0,0 +1,206 @@
+"""BCF XML V3 Topic handler."""
+import datetime
+import uuid
+import zipfile
+from pathlib import Path
+from typing import Any, NoReturn, Optional
+
+import numpy as np
+from ifcopenshell import entity_instance
+from numpy.typing import NDArray
+from xsdata.models.datatype import XmlDateTime
+
+import bcf.v3.model as mdl
+from bcf.inmemory_zipfile import ZipFileInterface
+from bcf.v3.visinfo import VisualizationInfoHandler
+from bcf.xml_parser import AbstractXmlParserSerializer, XmlParserSerializer
+
+
+class TopicHandler:
+    """BCF Topic and related objects handler."""
+
+    def __init__(
+        self,
+        topic_dir: Optional[zipfile.Path] = None,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> None:
+        self._markup: Optional[mdl.Markup] = None
+        self._viewpoints: dict[str, VisualizationInfoHandler] = {}
+        self._bim_snippet: Optional[bytes] = None
+        self._xml_handler = xml_handler or XmlParserSerializer()
+        self._topic_dir = topic_dir
+
+    @property
+    def markup(self) -> Optional[mdl.Markup]:
+        if not self._markup and self._topic_dir:
+            markup_path = self._topic_dir.joinpath("markup.bcf")
+            if markup_path.exists():
+                self._markup = self._xml_handler.parse(markup_path.read_bytes(), mdl.Markup)
+        return self._markup
+
+    @markup.setter
+    def markup(self, value: mdl.Markup) -> None:
+        self._markup = value
+
+    @property
+    def topic(self) -> mdl.Topic:
+        """Return the Topic object."""
+        return self.markup.topic
+
+    @property
+    def guid(self) -> Optional[str]:
+        """Return the GUID of the topic."""
+        if self._markup:
+            return self.topic.guid
+        return self._topic_dir.name if self._topic_dir else None
+
+    @property
+    def header(self) -> Optional[mdl.Header]:
+        """Return the header of the topic."""
+        return self.markup.header
+
+    @property
+    def comments(self) -> list[mdl.Comment]:
+        """Return the comments of the topic."""
+        return self.topic.comments.comment if self.topic.comments else []
+
+    @property
+    def bim_snippet(self) -> Optional[bytes]:
+        if not self._bim_snippet and self._topic_dir:
+            self._bim_snippet = self._load_bim_snippet()
+        return self._bim_snippet
+
+    @bim_snippet.setter
+    def bim_snippet(self, value: bytes) -> None:
+        self._bim_snippet = value
+
+    @property
+    def viewpoints(self) -> dict[str, "VisualizationInfoHandler"]:
+        if (
+            not self._viewpoints
+            and self._topic_dir
+            and self.topic.viewpoints
+            and (viewpoints := self.topic.viewpoints.view_point)
+        ):
+            self._viewpoints = VisualizationInfoHandler.from_topic_viewpoints(self._topic_dir, viewpoints)
+        return self._viewpoints
+
+    def _load_bim_snippet(self) -> Optional[bytes]:
+        bim_snippet_obj = self.topic.bim_snippet
+        if bim_snippet_obj and not bim_snippet_obj.is_external and self._topic_dir:
+            bim_snippet_path = self._topic_dir.joinpath(bim_snippet_obj.reference)
+            if bim_snippet_path.exists():
+                return bim_snippet_path.read_bytes()
+        return None
+
+    @classmethod
+    def create_new(
+        cls,
+        title: str,
+        description: str,
+        author: str,
+        topic_type: str = "",
+        topic_status: str = "",
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> "TopicHandler":
+        """
+        Create a new BCF topic.
+
+        Args:
+            title: The title of the topic.
+            description: The description of the topic.
+            author: The author of the topic.
+            topic_type: The type of the topic.
+            topic_status: The status of the topic.
+            xml_handler: The XML parser/serializer to use.
+
+        Returns:
+            The BCF topic definition.
+        """
+        creation_date = XmlDateTime.from_datetime(datetime.datetime.now())
+        guid = str(uuid.uuid4())
+        topic = mdl.Topic(
+            title=title,
+            description=description,
+            creation_author=author,
+            creation_date=creation_date,
+            guid=guid,
+            topic_type=topic_type,
+            topic_status=topic_status,
+        )
+        markup = mdl.Markup(topic=topic)
+        obj = cls(topic_dir=Path(guid), xml_handler=xml_handler or XmlParserSerializer())
+        obj.markup = markup
+        return obj
+
+    def save(self, destination_zip: ZipFileInterface) -> None:
+        """
+        Save the topic to a BCF zip file.
+
+        Args:
+            bcf_zip: The BCF zip file to save to.
+        """
+        topic_dir = self.guid
+        self._save_xml(destination_zip, self._markup, "markup.bcf")
+        self._save_viewpoints(destination_zip, topic_dir)
+        self._save_bim_snippet(destination_zip)
+
+    def _save_viewpoints(self, destination_zip: ZipFileInterface, topic_dir: str) -> None:
+        if not self.topic.viewpoints or not (viewpoints := self.topic.viewpoints.view_point):
+            return
+        for vpt in viewpoints:
+            if vpt.viewpoint:
+                self.viewpoints[vpt.viewpoint].save(destination_zip, topic_dir, vpt)
+
+    def _save_xml(self, destination_zip: ZipFileInterface, item: Any, target: str) -> None:
+        to_write = self._xml_handler.serialize(item) if item else self._topic_dir.joinpath(target).read_bytes()
+        destination_zip.writestr(f"{self._topic_dir.name}/{target}", to_write)
+
+    def _save_bim_snippet(self, destination_zip: ZipFileInterface) -> None:
+        snippet = self.topic.bim_snippet
+        if not snippet or snippet.is_external:
+            return
+        ref_filename = Path(snippet.reference).name
+        if self.bim_snippet:
+            destination_zip.writestr(f"{self.topic.guid}/{ref_filename}", self.bim_snippet)
+
+    def add_viewpoint(self, element: entity_instance) -> None:
+        """
+        Add a viewpoint tergeting an IFC element to the topic.
+
+        Args:
+            element: The IFC element.
+        """
+        new_viewpoint = VisualizationInfoHandler.create_new(element, self._xml_handler)
+        self.add_visinfo_handler(new_viewpoint)
+
+    def add_viewpoint_from_point_and_guids(self, position: NDArray[np.float_], *guids: str) -> None:
+        """
+        Add a viewpoint tergeting an IFC element to the topic.
+
+        Args:
+            element: The IFC element.
+        """
+        vi_handler = VisualizationInfoHandler.create_from_point_and_guids(
+            position, *guids, xml_handler=self._xml_handler
+        )
+        self.add_visinfo_handler(vi_handler)
+
+    def add_visinfo_handler(self, new_viewpoint: VisualizationInfoHandler) -> None:
+        self.viewpoints[new_viewpoint.guid + ".bcfv"] = new_viewpoint
+        if self.topic.viewpoints is None:
+            self.topic.viewpoints = mdl.TopicViewpoints()
+        self.topic.viewpoints.view_point.append(
+            mdl.ViewPoint(viewpoint=new_viewpoint.guid + ".bcfv", guid=new_viewpoint.guid)
+        )
+
+    def __eq__(self, other: object) -> bool | NoReturn:
+        return (
+            (
+                self.markup == other.markup
+                and self.viewpoints == other.viewpoints
+                and self.bim_snippet == other.bim_snippet
+            )
+            if isinstance(other, TopicHandler)
+            else NotImplemented
+        )

src/bcf/src/bcf/v3/visinfo.py

@@ -0,0 +1,294 @@
+import uuid
+import zipfile
+from functools import lru_cache
+from typing import Any, Iterable, Optional
+
+import numpy as np
+from ifcopenshell import entity_instance
+from ifcopenshell.util import placement
+from numpy.typing import NDArray
+
+import bcf.v3.model as mdl
+from bcf.geometry import (
+    camera_vectors_from_element_placement,
+    camera_vectors_from_target_position,
+)
+from bcf.inmemory_zipfile import ZipFileInterface
+from bcf.xml_parser import AbstractXmlParserSerializer, XmlParserSerializer
+
+
+class VisualizationInfoHandler:
+    """Handle the VisualizationInfo and related objects."""
+
+    def __init__(
+        self,
+        visualization_info: mdl.VisualizationInfo,
+        snapshot: Optional[bytes] = None,
+        bitmaps: Optional[dict[str, bytes]] = None,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> None:
+        self.visualization_info = visualization_info
+        self.snapshot = snapshot
+        self.bitmaps = bitmaps or {}
+        self._xml_handler = xml_handler or XmlParserSerializer()
+
+    @property
+    def guid(self) -> str:
+        """Return the GUID of the visualization info."""
+        return self.visualization_info.guid
+
+    @classmethod
+    def from_topic_viewpoints(
+        cls,
+        topic_dir: zipfile.Path,
+        vps: Iterable[mdl.ViewPoint],
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> dict[str, "VisualizationInfoHandler"]:
+        """Create VisualizationInfoHandler objects of a Topic's ViewPoints."""
+        viewpoints = {}
+        for vpt in vps:
+            visinfo = cls.load(topic_dir, vpt, xml_handler)
+            if visinfo and vpt.viewpoint:
+                viewpoints[vpt.viewpoint] = visinfo
+        return viewpoints
+
+    @classmethod
+    def load(
+        cls,
+        topic_dir: zipfile.Path,
+        vpt: mdl.ViewPoint,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> Optional["VisualizationInfoHandler"]:
+        """
+        Load the VisualizationInfo and related objects from a BCF zip file.
+
+        Args:
+            topic_dir: The directory in the BCF zip file to load from.
+            vpt: The ViewPoint to load.
+            xml_handler: The XML handler to use to parse the VisualizationInfo.
+
+        Returns:
+            The VisualizationInfoHandler object.
+        """
+        visinfo = cls._load_visinfo(topic_dir, vpt.viewpoint, xml_handler)
+        if not visinfo:
+            return None
+        snapshot = cls._load_snapshot(topic_dir, vpt.snapshot)
+        bitmaps = cls._load_bitmaps(topic_dir, visinfo)
+        return cls(visinfo, snapshot, bitmaps, xml_handler)
+
+    @staticmethod
+    def _load_visinfo(
+        topic_dir: zipfile.Path,
+        vp_name: Optional[str],
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> Optional[mdl.VisualizationInfo]:
+        if not vp_name:
+            return None
+        vp_path = topic_dir.joinpath(vp_name)
+        if vp_path.exists():
+            xml_handler = xml_handler or XmlParserSerializer()
+            return xml_handler.parse(vp_path.read_bytes(), mdl.VisualizationInfo)
+        return None
+
+    @staticmethod
+    def _load_snapshot(topic_dir: zipfile.Path, vp_snapshot: Optional[str]) -> Optional[bytes]:
+        if vp_snapshot:
+            snapshot_path = topic_dir.joinpath(vp_snapshot)
+            if snapshot_path.exists():
+                return snapshot_path.read_bytes()
+        return None
+
+    @staticmethod
+    def _load_bitmaps(topic_dir: zipfile.Path, visinfo: Optional[mdl.VisualizationInfo]) -> dict[str, bytes]:
+        if not visinfo or not (bitmaps := visinfo.bitmaps):
+            return {}
+        bitmaps_dict = {}
+        for bitmap in bitmaps.bitmap:
+            if not bitmap.reference:
+                continue
+            bitmap_path = topic_dir.joinpath(bitmap.reference)
+            if bitmap_path.exists():
+                bitmaps_dict[bitmap.reference] = bitmap_path.read_bytes()
+        return bitmaps_dict
+
+    def save(
+        self,
+        bcf_zip: ZipFileInterface,
+        topic_dir: str,
+        vpt: mdl.ViewPoint,
+    ) -> None:
+        """
+        Save the VisualizationInfo and related objects to a BCF zip file.
+
+        Args:
+            bcf_zip: The BCF zip file to save to.
+            topic_dir: The directory in the BCF zip file to save to.
+            vpt: The ViewPoint to save.
+        """
+        if not (vp_name := vpt.viewpoint):
+            return
+        self._save_visinfo(bcf_zip, topic_dir, vp_name)
+        self._save_snapshot(bcf_zip, topic_dir, vpt.snapshot)
+        self._save_bitmaps(bcf_zip, topic_dir)
+
+    def _save_snapshot(self, bcf_zip: ZipFileInterface, topic_dir: str, filename: Optional[str]) -> None:
+        if self.snapshot and filename:
+            bcf_zip.writestr(f"{topic_dir}/{filename}", self.snapshot)
+
+    def _save_visinfo(self, bcf_zip: ZipFileInterface, topic_dir: str, vp_name: str) -> None:
+        bcf_zip.writestr(
+            f"{topic_dir}/{vp_name}",
+            self._xml_handler.serialize(self.visualization_info),
+        )
+
+    def _save_bitmaps(self, bcf_zip: ZipFileInterface, topic_dir: str) -> None:
+        if not self.bitmaps:
+            return
+        if not (bitmaps_defs := self.visualization_info.bitmaps):
+            return
+        for bitmap_def in bitmaps_defs.bitmap:
+            if not (bitmap_name := bitmap_def.reference):
+                continue
+            if bitmap_name in self.bitmaps:
+                bcf_zip.writestr(f"{topic_dir}/{bitmap_name}", self.bitmaps[bitmap_name])
+
+    @classmethod
+    def create_new(
+        cls,
+        element: entity_instance,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> "VisualizationInfoHandler":
+        """
+        Create a new VisualizationInfoHandler object from an IFC element.
+
+        Args:
+            element: The IFC element to point at.
+            xml_handler: The XML handler to use.
+
+        Returns:
+            The VisualizationInfoHandler object.
+        """
+        xml_handler = xml_handler or XmlParserSerializer()
+        return cls(visualization_info=build_viewpoint(element), xml_handler=xml_handler)
+
+    @classmethod
+    def create_from_point_and_guids(
+        cls,
+        position: NDArray[np.float_],
+        *guids: str,
+        xml_handler: Optional[AbstractXmlParserSerializer] = None,
+    ) -> "VisualizationInfoHandler":
+        """
+        Create a new VisualizationInfoHandler object from an IFC element.
+
+        Args:
+            position: target point coordinates.
+            *guids: One or more IFC element GUID.
+            xml_handler: The XML handler to use.
+
+        Returns:
+            The VisualizationInfoHandler object.
+        """
+        xml_handler = xml_handler or XmlParserSerializer()
+        return cls(
+            visualization_info=build_viewpoint_from_position_and_guids(position, *guids), xml_handler=xml_handler
+        )
+
+
+@lru_cache(maxsize=None)
+def build_viewpoint(element: entity_instance) -> mdl.VisualizationInfo:
+    """
+    Return a BCF viewpoint of an IFC element.
+
+    This function is cached to speedudp the creation of multiple BCF topics regarding the same element.
+
+    Args:
+        element: The IFC element to point at.
+
+    Returns:
+        The BCF viewpoint definition.
+    """
+    elem_placement = placement.get_local_placement(element.ObjectPlacement)
+
+    return mdl.VisualizationInfo(
+        guid=str(uuid.uuid4()),
+        components=build_components(element.GlobalId),
+        perspective_camera=build_camera(elem_placement),
+    )
+
+
+def build_viewpoint_from_position_and_guids(position: NDArray[np.float_], *guids: str) -> mdl.VisualizationInfo:
+    """
+    Return a BCF viewpoint of an IFC element.
+
+    This function is cached to speedudp the creation of multiple BCF topics regarding the same element.
+
+    Args:
+        position: target point coordinates.
+        *guids: One or more IFC element GUID.
+
+    Returns:
+        The BCF viewpoint definition.
+    """
+    return mdl.VisualizationInfo(
+        guid=str(uuid.uuid4()),
+        components=build_components(*guids),
+        perspective_camera=build_camera_from_vectors(*camera_vectors_from_target_position(position)),
+    )
+
+
+def build_components(*guids: str) -> mdl.Components:
+    """
+    Return the BCF components from an IFC element GUID.
+
+    Args:
+        *guids: One or more IFC element GUID.
+
+    Returns:
+        The BCF components definition.
+    """
+    components = [mdl.Component(ifc_guid=guid) for guid in guids]
+    return mdl.Components(
+        selection=mdl.ComponentSelection(component=components),
+        visibility=mdl.ComponentVisibility(default_visibility=True),
+    )
+
+
+def build_camera(elem_placement: NDArray[np.float_]) -> mdl.PerspectiveCamera:
+    """
+    Return a BCF camera for an IFC element placement matrix.
+
+    Args:
+        elem_placement: The IFC element placement as a rototranslation matrix.
+
+    Returns:
+        The BCF camera definition.
+    """
+    return build_camera_from_vectors(*camera_vectors_from_element_placement(elem_placement))
+
+
+def build_camera_from_vectors(
+    camera_position: NDArray[np.float_], camera_dir: NDArray[np.float_], camera_up: NDArray[np.float_]
+) -> mdl.PerspectiveCamera:
+    """
+    Return a BCF camera for an IFC element placement matrix.
+
+    Args:
+        camera_position: camera position array
+        camera_dir: camera direction versor
+        camera_up_vector: camera up versor
+
+    Returns:
+        The BCF camera definition.
+    """
+    camera_viewpoint = mdl.Point(x=camera_position[0], y=camera_position[1], z=camera_position[2])
+    camera_direction = mdl.Direction(x=camera_dir[0], y=camera_dir[1], z=camera_dir[2])
+    camera_up_vector = mdl.Direction(x=camera_up[0], y=camera_up[1], z=camera_up[2])
+    return mdl.PerspectiveCamera(
+        camera_view_point=camera_viewpoint,
+        camera_direction=camera_direction,
+        camera_up_vector=camera_up_vector,
+        aspect_ratio=1.0,
+        field_of_view=60.0,
+    )

src/bcf/src/bcf/xml_parser.py

@@ -0,0 +1,83 @@
+"""XML Parser and Serializer factories."""
+from typing import Optional, Protocol, Type, TypeVar
+
+from xsdata.formats.dataclass.context import XmlContext
+from xsdata.formats.dataclass.parsers import XmlParser
+from xsdata.formats.dataclass.serializers import XmlSerializer
+from xsdata.formats.dataclass.serializers.config import SerializerConfig
+
+
+def build_xml_parser(context: Optional[XmlContext] = None) -> XmlParser:
+    """Return a parser for an XML file."""
+    parser = XmlParser(context=context or XmlContext())
+    parser.register_namespace("xs", "http://www.w3.org/2001/XMLSchema")
+    return parser
+
+
+def build_serializer(context: Optional[XmlContext] = None) -> XmlSerializer:
+    """Return a serializer for an XML file."""
+    return XmlSerializer(
+        config=SerializerConfig(pretty_print=True),
+        context=context or XmlContext(),
+    )
+
+
+T = TypeVar("T")
+
+
+class AbstractXmlParserSerializer(Protocol):
+    """XML Parser and serializer wrapper."""
+
+    def parse(self, xml: bytes, clazz: Type[T]) -> T:
+        """
+        Parse an XML file to an object.
+
+        Args:
+            xml: The XML file as bytes.
+            clazz: The class to parse to.
+        """
+
+    def serialize(self, obj: T, ns_map: Optional[dict[str, str]] = None) -> str:
+        """
+        Serialize an object to XML.
+
+        Args:
+            obj: The object to serialize.
+            ns_map: The namespace map to use.
+
+        Returns:
+            The XML as string.
+        """
+
+
+class XmlParserSerializer:
+    """XML Parser and serializer wrapper."""
+
+    def __init__(self) -> None:
+        self.context = XmlContext()
+        self.parser = build_xml_parser(self.context)
+        self.serializer = build_serializer(self.context)
+
+    def parse(self, xml: bytes, clazz: Type[T]) -> T:
+        """
+        Parse an XML file to an object.
+
+        Args:
+            xml: The XML file as bytes.
+            clazz: The class to parse to.
+        """
+        return self.parser.from_bytes(xml, clazz)
+
+    def serialize(self, obj: T, ns_map: Optional[dict[str, str]] = None) -> str:
+        """
+        Serialize an object to XML.
+
+        Args:
+            obj: The object to serialize.
+            ns_map: The namespace map to use.
+
+        Returns:
+            The XML as string.
+        """
+        ns_map = ns_map or {"xs": "http://www.w3.org/2001/XMLSchema"}
+        return self.serializer.render(obj, ns_map)

src/bcf/tests/__init__.py

@@ -0,0 +1 @@
+"""BCF tests."""

src/bcf/tests/conftest.py

@@ -0,0 +1,8 @@
+import pytest
+
+from bcf.xml_parser import XmlParserSerializer
+
+
+@pytest.fixture(scope="session")
+def xml_handler() -> XmlParserSerializer:
+    return XmlParserSerializer()

src/bcf/tests/v2/test_bcf_xml.py

@@ -0,0 +1,126 @@
+"""BCF XML tests."""
+import uuid
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+import pytest
+
+import bcf.v2.model as mdl
+from bcf.v2.bcfxml import BcfXml
+from bcf.v2.topic import TopicHandler
+from bcf.v2.visinfo import (
+    VisualizationInfoHandler,
+    build_camera_from_vectors,
+    build_components,
+)
+from bcf.xml_parser import XmlParserSerializer
+
+
+@pytest.fixture()
+def build_sample(xml_handler: XmlParserSerializer) -> tuple[BcfXml, TopicHandler]:
+    bcf = BcfXml.create_new("Test project", xml_handler=xml_handler)
+    orig_th = bcf.add_topic("Test topic", "Test message", "Test author", "Test type")
+    return bcf, orig_th
+
+
+def test_bcf_roundtrip(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            assert parsed == bcf
+            parsed_th = parsed.topics[orig_th.guid]
+            assert parsed_th == orig_th
+
+
+def test_bcf_edit_saveas(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            for th in parsed.topics.values():
+                th.topic.title = "New Topic Title"
+            modified_path = Path(tmp_dir) / "edited.bcf"
+            parsed.save(modified_path)
+            with BcfXml.load(modified_path, xml_handler=xml_handler) as modified_parsed:
+                _assert_modified_parsed(modified_parsed, bcf, orig_th, parsed)
+
+
+def _assert_modified_parsed(modified_parsed, bcf, orig_th, parsed):
+    assert modified_parsed == bcf
+    parsed_th = modified_parsed.topics[orig_th.guid]
+    assert parsed_th.markup != orig_th.markup
+    assert parsed_th.markup == parsed.topics[orig_th.guid].markup
+    assert parsed_th.viewpoints == orig_th.viewpoints
+    assert parsed_th.bim_snippet == orig_th.bim_snippet
+
+
+def test_bcf_edit(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            for th in parsed.topics.values():
+                th.topic.title = "New Topic Title"
+            parsed.save()
+            with BcfXml.load(file_path, xml_handler=xml_handler) as modified_parsed:
+                _assert_modified_parsed(modified_parsed, bcf, orig_th, parsed)
+                assert len(modified_parsed.topics) == 1
+
+
+def test_save_no_filename(build_sample) -> None:
+    bcf, _ = build_sample
+    with pytest.raises(ValueError):
+        bcf.save()
+
+
+def test_load_no_filename() -> None:
+    with pytest.raises(ValueError):
+        BcfXml.load("")
+
+
+def test_save_keep_open(build_sample) -> None:
+    bcf, _ = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path, keep_open=True)
+        assert bcf._zip_file is not None
+        bcf._zip_file.close()
+
+
+def test_massive_bcf(xml_handler) -> None:
+    bcf = BcfXml.create_new("Test project", xml_handler=xml_handler)
+    for i in range(100):
+        th = bcf.add_topic(f"Topic {i:04}", f"Message {i:04}", "Test author", "Test type")
+        vi = mdl.VisualizationInfo(
+            guid=str(uuid.uuid4()),
+            components=build_components(str(uuid.uuid4())),
+            perspective_camera=build_camera_from_vectors([i, 0, 0], [0, 1, 0], [0, 0, 1]),
+        )
+        vh = VisualizationInfoHandler(visualization_info=vi, xml_handler=xml_handler)
+        th.add_visinfo_handler(vh)
+    assert len(bcf.topics) == 100
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+
+
+def test_equality_with_wrong_object(build_sample) -> None:
+    assert build_sample[0] != "Wrong object"
+
+
+def test_topic_equality_with_wrong_object(build_sample) -> None:
+    assert build_sample[1] != "Wrong object"
+
+
+def test_bcf_get_set_version(build_sample) -> None:
+    bcf = build_sample[0]
+    assert bcf.version.version_id == "2.1"
+    bcf.version.version_id = "2.0"
+    assert bcf.version.version_id == "2.0"

src/bcf/tests/v2/test_example_files.py

@@ -0,0 +1,365 @@
+import json
+import os
+import zipfile
+from pathlib import Path
+
+from xsdata.models.datatype import XmlDateTime
+
+import bcf.v2.model as mdl
+from bcf.v2.bcfxml import BcfXml
+from bcf.v2.topic import TopicHandler
+
+
+def test_maximum_information() -> None:
+    """
+    All the info in a BCF is parsed correctly.
+
+    Uses sample file from https://github.com/buildingSMART/BCF-XML/
+    """
+    bcf_path = Path(__file__).parent / "MaximumInformation.bcf"
+    with BcfXml.load(bcf_path) as bcf:
+        assert_everything_in_place(bcf)
+
+
+def test_save_maximum_information() -> None:
+    base_dir = Path(__file__).parent
+    bcf_path = base_dir / "MaximumInformation.bcf"
+    target_path = base_dir / "MaximumInformationSaved.bcf"
+    with BcfXml.load(bcf_path) as bcf:
+        bcf.save(target_path)
+    assert target_path.exists()
+    with BcfXml.load(target_path) as bcf2:
+        assert_everything_in_place(bcf2)
+
+    expected_files = [
+        "bcf.version",
+        "project.bcfp",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/markup.bcf",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/bitmap.png",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/tux.png",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/JsonElement.json",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/Viewpoint_4ab7514b-b216-4d56-98d2-45cf8500ff5a.bcfv",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/Viewpoint_9a4a1878-ecbd-4916-83a8-dad82e560231.bcfv",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/Viewpoint_fc4019d7-365e-47f3-b6d0-b39fc48f15fc.bcfv",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/Snapshot_4ab7514b-b216-4d56-98d2-45cf8500ff5a.png",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/Snapshot_9a4a1878-ecbd-4916-83a8-dad82e560231.png",
+        "7ddc3ef0-0ab7-43f1-918a-45e38b42369c/Snapshot_fc4019d7-365e-47f3-b6d0-b39fc48f15fc.png",
+        "d1068c81-af04-4546-b63c-348810f6c716/markup.bcf",
+        "extensions.xsd",
+        "IfcPile_01.ifc",
+        "markup.xsd",
+    ]
+    assert_files_present(target_path, expected_files)
+    os.unlink(target_path)
+
+
+def assert_everything_in_place(bcf: BcfXml):
+    assert bcf.version.version_id == "2.1"
+    assert bcf.project.name == "BCF API Implementation"
+    assert bcf.project_info.extension_schema == "extensions.xsd"
+
+    assert len(bcf.topics) == 2
+    assert_first_topic_handler(bcf.topics["7ddc3ef0-0ab7-43f1-918a-45e38b42369c"])
+    second_th = bcf.topics["d1068c81-af04-4546-b63c-348810f6c716"]
+    assert second_th.topic == mdl.Topic(
+        title="Referenced topic",
+        creation_date=XmlDateTime(2017, 5, 22, 7, 51, 0, 42987900),
+        creation_author="dangl@iabi.eu",
+        description="This is just an empty topic that acts as a referenced topic.",
+        guid="d1068c81-af04-4546-b63c-348810f6c716",
+    )
+
+
+def assert_first_topic_handler(topic_handler: TopicHandler):
+    assert topic_handler.guid == "7ddc3ef0-0ab7-43f1-918a-45e38b42369c"
+
+    expected_bs1 = mdl.BimSnippet(
+        reference="JsonElement.json", reference_schema="http://json-schema.org", snippet_type="JSON"
+    )
+    expected_t1 = mdl.Topic(
+        reference_link=["https://bim--it.net"],
+        title="Maximum Content",
+        priority="High",
+        index=0,
+        labels=["Structural", "IT Development"],
+        creation_date=XmlDateTime(2015, 6, 21, 12, 0, 0),
+        creation_author="dangl@iabi.eu",
+        modified_date=XmlDateTime(2015, 6, 21, 14, 22, 47),
+        modified_author="dangl@iabi.eu",
+        due_date=XmlDateTime(2016, 10, 2, 14, 22, 47),
+        assigned_to="linhard@iabi.eu",
+        stage="Construction Start",
+        description="This is a topic with all informations present.",
+        bim_snippet=expected_bs1,
+        document_reference=[
+            mdl.TopicDocumentReference(
+                referenced_document="https://github.com/BuildingSMART/BCF-XML",
+                description="GitHub BCF Specification",
+                is_external=True,
+            ),
+            mdl.TopicDocumentReference(
+                referenced_document="../markup.xsd",
+                description="Markup.xsd Schema",
+                is_external=False,
+            ),
+        ],
+        related_topic=[mdl.TopicRelatedTopic(guid="d1068c81-af04-4546-b63c-348810f6c716")],
+        guid="7ddc3ef0-0ab7-43f1-918a-45e38b42369c",
+        topic_type="Structural",
+        topic_status="Open",
+    )
+    assert topic_handler.topic == expected_t1
+    expected_h1 = mdl.Header(
+        file=[
+            mdl.HeaderFile(
+                filename="IfcPile_01.ifc",
+                date=XmlDateTime(2014, 10, 27, 16, 27, 27),
+                reference="../IfcPile_01.ifc",
+                ifc_project="0M6o7Znnv7hxsbWgeu7oQq",
+                ifc_spatial_structure_element="23B$bNeGHFQuMYJzvUX0FD",
+                is_external=False,
+            )
+        ]
+    )
+    assert topic_handler.header == expected_h1
+
+    expected_th1_comments = [
+        mdl.Comment(
+            date=XmlDateTime(2015, 8, 31, 12, 40, 17),
+            author="dangl@iabi.eu",
+            comment="This is an unmodified topic at the uppermost hierarchical level.\nAll times in the XML are marked as UTC times.",
+            guid="07ccdba0-1736-47e1-807d-67dc6f3addaa",
+        ),
+        mdl.Comment(
+            date=XmlDateTime(2015, 8, 31, 14, 0, 1),
+            author="dangl@iabi.eu",
+            comment="This comment was a reply to the first comment in BCF v2.0. This is a no longer supported functionality and therefore is to be treated as a regular comment in v2.1.",
+            guid="a12766c2-61bc-40b4-ab19-e9f45fd0b0bf",
+        ),
+        mdl.Comment(
+            date=XmlDateTime(2015, 8, 31, 13, 7, 11),
+            author="dangl@iabi.eu",
+            comment="This comment again is in the highest hierarchy level.\nIt references a viewpoint.",
+            viewpoint=mdl.CommentViewpoint(guid="4ab7514b-b216-4d56-98d2-45cf8500ff5a"),
+            guid="c2bb5bb0-773d-45dd-bdaa-19a216439ed3",
+        ),
+        mdl.Comment(
+            date=XmlDateTime(2015, 8, 31, 15, 42, 58),
+            author="dangl@iabi.eu",
+            comment="This comment contained some spllng errs.\nHopefully, the modifier did catch them all.",
+            modified_date=XmlDateTime(2015, 8, 31, 16, 7, 11),
+            modified_author="dangl@iabi.eu",
+            guid="0b843a5c-c3bf-41ef-be98-52a9f7bd9790",
+        ),
+    ]
+    assert topic_handler.comments == expected_th1_comments
+
+    expected_th1_viewpoints = [
+        mdl.ViewPoint(
+            viewpoint="Viewpoint_4ab7514b-b216-4d56-98d2-45cf8500ff5a.bcfv",
+            snapshot="Snapshot_4ab7514b-b216-4d56-98d2-45cf8500ff5a.png",
+            index=2,
+            guid="4ab7514b-b216-4d56-98d2-45cf8500ff5a",
+        ),
+        mdl.ViewPoint(
+            viewpoint="Viewpoint_fc4019d7-365e-47f3-b6d0-b39fc48f15fc.bcfv",
+            snapshot="Snapshot_fc4019d7-365e-47f3-b6d0-b39fc48f15fc.png",
+            index=0,
+            guid="fc4019d7-365e-47f3-b6d0-b39fc48f15fc",
+        ),
+        mdl.ViewPoint(
+            viewpoint="Viewpoint_9a4a1878-ecbd-4916-83a8-dad82e560231.bcfv",
+            snapshot="Snapshot_9a4a1878-ecbd-4916-83a8-dad82e560231.png",
+            index=1,
+            guid="9a4a1878-ecbd-4916-83a8-dad82e560231",
+        ),
+    ]
+
+    expected_m1 = mdl.Markup(
+        header=expected_h1,
+        topic=expected_t1,
+        comment=expected_th1_comments,
+        viewpoints=expected_th1_viewpoints,
+    )
+    assert topic_handler.markup == expected_m1
+
+    assert json.loads(topic_handler.bim_snippet) == {"Material": "Concrete", "Temperatures": ["Cold", "Hot", "Hotter"]}
+
+    assert topic_handler.reference_files["../IfcPile_01.ifc"] is not None
+
+    assert_viewpoints(topic_handler.viewpoints)
+
+
+def assert_viewpoints(viewpoints):
+    assert len(viewpoints) == 3
+
+    expected_selection = mdl.ComponentSelection(
+        component=[
+            mdl.Component(ifc_guid="0cSRUx$EX1NRjqiKcYQ$a0"),
+            mdl.Component(ifc_guid="1jQQiGIAnFzxOUzrdmJYDS"),
+            mdl.Component(ifc_guid="0fdpeZZEX3FwJ7x0ox5kzF"),
+            mdl.Component(ifc_guid="23Zwlpd71EyvHlH6OZ77nK"),
+            mdl.Component(ifc_guid="1OpjQ1Nlv4sQuTxfUC_8zS"),
+        ]
+    )
+
+    expected_exception = mdl.ComponentVisibilityExceptions(
+        component=[
+            mdl.Component(ifc_guid="0Gl71cVurFn8bxAOox6M4X"),
+            mdl.Component(ifc_guid="23Zwlpd71EyvHlH6OZ77nK"),
+            mdl.Component(ifc_guid="3DvyPxGIn8qR0KDwbL_9r1"),
+            mdl.Component(ifc_guid="0fdpeZZEX3FwJ7x0ox5kzF"),
+            mdl.Component(ifc_guid="1OpjQ1Nlv4sQuTxfUC_8zS"),
+        ]
+    )
+
+    expected_coloring = mdl.ComponentColoring(
+        color=[
+            mdl.ComponentColoringColor(
+                component=[
+                    mdl.Component(ifc_guid="0fdpeZZEX3FwJ7x0ox5kzF"),
+                    mdl.Component(ifc_guid="23Zwlpd71EyvHlH6OZ77nK"),
+                    mdl.Component(ifc_guid="1OpjQ1Nlv4sQuTxfUC_8zS"),
+                    mdl.Component(ifc_guid="0cSRUx$EX1NRjqiKcYQ$a0"),
+                ],
+                color="3498DB",
+            )
+        ]
+    )
+
+    assert_first_viewpoint(
+        viewpoints["Viewpoint_4ab7514b-b216-4d56-98d2-45cf8500ff5a.bcfv"],
+        expected_selection,
+        expected_exception,
+        expected_coloring,
+    )
+    assert_second_viewpoint(
+        viewpoints["Viewpoint_fc4019d7-365e-47f3-b6d0-b39fc48f15fc.bcfv"],
+        expected_selection,
+        expected_exception,
+        expected_coloring,
+    )
+    assert_third_viewpoint(
+        viewpoints["Viewpoint_9a4a1878-ecbd-4916-83a8-dad82e560231.bcfv"],
+        expected_selection,
+        expected_exception,
+        expected_coloring,
+    )
+
+
+def assert_first_viewpoint(viewpoint, expected_selection, expected_exception, expected_coloring) -> None:
+    expected_vp = mdl.VisualizationInfo(
+        components=mdl.Components(
+            view_setup_hints=mdl.ViewSetupHints(
+                spaces_visible=True,
+                space_boundaries_visible=True,
+                openings_visible=True,
+            ),
+            selection=expected_selection,
+            visibility=mdl.ComponentVisibility(
+                exceptions=expected_exception,
+                default_visibility=True,
+            ),
+            coloring=expected_coloring,
+        ),
+        perspective_camera=mdl.PerspectiveCamera(
+            camera_view_point=mdl.Point(x=0.43079984188079834, y=69.52057647705078, z=10.666350364685059),
+            camera_direction=mdl.Direction(x=0.09159398823976517, y=-0.9375035166740417, z=-0.3357048034667969),
+            camera_up_vector=mdl.Direction(x=0.01938679628074169, y=-0.3353792130947113, z=0.9418837428092957),
+            field_of_view=60,
+        ),
+        lines=mdl.VisualizationInfoLines(
+            line=[
+                mdl.Line(start_point=mdl.Point(x=0, y=0, z=0), end_point=mdl.Point(x=0, y=0, z=1)),
+                mdl.Line(start_point=mdl.Point(x=0, y=0, z=1), end_point=mdl.Point(x=0, y=1, z=1)),
+                mdl.Line(start_point=mdl.Point(x=0, y=1, z=1), end_point=mdl.Point(x=1, y=1, z=1)),
+            ]
+        ),
+        clipping_planes=mdl.VisualizationInfoClippingPlanes(
+            clipping_plane=[
+                mdl.ClippingPlane(location=mdl.Point(x=0, y=0, z=0), direction=mdl.Direction(x=0, y=0, z=1)),
+                mdl.ClippingPlane(location=mdl.Point(x=0, y=0, z=0), direction=mdl.Direction(x=0, y=1, z=0)),
+            ]
+        ),
+        bitmap=[
+            mdl.VisualizationInfoBitmap(
+                bitmap=mdl.BitmapFormat.PNG,
+                reference="bitmap.png",
+                location=mdl.Point(x=10, y=-10, z=7),
+                normal=mdl.Direction(x=0, y=1, z=0),
+                up=mdl.Direction(x=0, y=0, z=1),
+                height=5.0,
+            ),
+            mdl.VisualizationInfoBitmap(
+                bitmap=mdl.BitmapFormat.PNG,
+                reference="tux.png",
+                location=mdl.Point(x=20, y=-10, z=7),
+                normal=mdl.Direction(x=0, y=1, z=0),
+                up=mdl.Direction(x=0, y=0, z=1),
+                height=5.0,
+            ),
+        ],
+        guid="8dc86298-9737-40b4-a448-98a9e953293a",
+    )
+    assert viewpoint.visualization_info == expected_vp
+    assert viewpoint.snapshot is not None
+
+
+def assert_second_viewpoint(viewpoint, expected_selection, expected_exception, expected_coloring) -> None:
+    expected_vp = mdl.VisualizationInfo(
+        components=mdl.Components(
+            view_setup_hints=mdl.ViewSetupHints(
+                spaces_visible=False,
+                space_boundaries_visible=False,
+                openings_visible=False,
+            ),
+            selection=expected_selection,
+            visibility=mdl.ComponentVisibility(
+                exceptions=expected_exception,
+                default_visibility=False,
+            ),
+            coloring=expected_coloring,
+        ),
+        perspective_camera=mdl.PerspectiveCamera(
+            camera_view_point=mdl.Point(x=-47.18794250488281, y=43.829200744628906, z=10.666350364685059),
+            camera_direction=mdl.Direction(x=0.6745243072509766, y=-0.6599355936050415, z=-0.33091068267822266),
+            camera_up_vector=mdl.Direction(x=0.2271970510482788, y=-0.24091780185699463, z=0.9435783624649048),
+            field_of_view=60,
+        ),
+        guid="21dd4807-e9af-439e-a980-04d913a6b1ce",
+    )
+    assert viewpoint.visualization_info == expected_vp
+    assert viewpoint.snapshot is not None
+
+
+def assert_third_viewpoint(viewpoint, expected_selection, expected_exception, expected_coloring) -> None:
+    expected_vp = mdl.VisualizationInfo(
+        components=mdl.Components(
+            view_setup_hints=mdl.ViewSetupHints(
+                spaces_visible=False,
+                space_boundaries_visible=False,
+                openings_visible=True,
+            ),
+            selection=expected_selection,
+            visibility=mdl.ComponentVisibility(
+                exceptions=expected_exception,
+                default_visibility=True,
+            ),
+            coloring=expected_coloring,
+        ),
+        perspective_camera=mdl.PerspectiveCamera(
+            camera_view_point=mdl.Point(x=-48.974571228027344, y=-64.20051574707031, z=10.666350364685059),
+            camera_direction=mdl.Direction(x=0.7232745289802551, y=0.5967116951942444, z=-0.3475759029388428),
+            camera_up_vector=mdl.Direction(x=0.27662187814712524, y=0.21082592010498047, z=0.937567412853241),
+            field_of_view=60,
+        ),
+        guid="81daa431-bf01-4a49-80a2-1ab07c177717",
+    )
+    assert viewpoint.visualization_info == expected_vp
+    assert viewpoint.snapshot is not None
+
+
+def assert_files_present(saved_bcf_path, expected_files):
+    with zipfile.ZipFile(saved_bcf_path) as bcf_zip:
+        for file_path in expected_files:
+            assert zipfile.Path(bcf_zip, file_path).exists()

src/bcf/tests/v2/test_ifcclash_api.py

@@ -0,0 +1,36 @@
+import numpy as np
+import pytest
+
+from bcf.v2.bcfxml import BcfXml
+
+
+def test_create_clash_set_bcf() -> None:
+    bcfxml = BcfXml.create_new("Clash Test")
+    topic = bcfxml.add_topic("Test", "Test topic", "IfcClash")
+    topic.add_viewpoint_from_point_and_guids(
+        np.array([10, 10, 10]),
+        "firstId",
+        "secondId",
+    )
+    assert len(topic.viewpoints) == 1
+    guid, vi_handler = next((k, v) for k, v in topic.viewpoints.items())
+    v_info = vi_handler.visualization_info
+    assert f"{v_info.guid}.bcfv" == guid
+    components = v_info.components.selection.component
+    assert {c.ifc_guid for c in components} == {"firstId", "secondId"}
+    camera = v_info.perspective_camera
+    viewpoint = camera.camera_view_point
+    assert viewpoint.x == 15
+    assert viewpoint.y == 15
+    assert viewpoint.z == 15
+    # default direction is the unit vector of -1, -1, -1
+    direction = camera.camera_direction
+    assert direction.x == pytest.approx(-1 / 3**0.5)
+    assert direction.y == pytest.approx(-1 / 3**0.5)
+    assert direction.z == pytest.approx(-1 / 3**0.5)
+    # default
+    up_vector = camera.camera_up_vector
+    assert up_vector.x == pytest.approx(-1 / 6**0.5)
+    assert up_vector.y == pytest.approx(-1 / 6**0.5)
+    assert up_vector.z == pytest.approx(1 / 1.5**0.5)
+    assert camera.field_of_view == 60

src/bcf/tests/v3/test_bcf_xml.py

@@ -0,0 +1,121 @@
+"""BCF XML tests."""
+import uuid
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+import pytest
+
+import bcf.v3.model as mdl
+from bcf.v3.bcfxml import BcfXml
+from bcf.v3.topic import TopicHandler
+from bcf.v3.visinfo import (
+    VisualizationInfoHandler,
+    build_camera_from_vectors,
+    build_components,
+)
+from bcf.xml_parser import XmlParserSerializer
+
+
+@pytest.fixture()
+def build_sample(xml_handler: XmlParserSerializer) -> tuple[BcfXml, TopicHandler]:
+    ext = mdl.Extensions(topic_types=mdl.ExtensionsTopicTypes(topic_type=["Test type"]))
+    bcf = BcfXml.create_new("Test project", extensions=ext, xml_handler=xml_handler)
+    orig_th = bcf.add_topic("Test topic", "Test message", "Test author", "Test type")
+    return bcf, orig_th
+
+
+def test_bcf_roundtrip(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            assert parsed == bcf
+            parsed_th = parsed.topics[orig_th.guid]
+            assert parsed_th == orig_th
+
+
+def test_bcf_edit_saveas(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            for th in parsed.topics.values():
+                th.topic.title = "New Topic Title"
+            modified_path = Path(tmp_dir) / "edited.bcf"
+            parsed.save(modified_path)
+            with BcfXml.load(modified_path, xml_handler=xml_handler) as modified_parsed:
+                _assert_modified_parsed(modified_parsed, bcf, orig_th, parsed)
+
+
+def _assert_modified_parsed(modified_parsed, bcf, orig_th, parsed):
+    assert modified_parsed == bcf
+    parsed_th = modified_parsed.topics[orig_th.guid]
+    assert parsed_th.markup != orig_th.markup
+    assert parsed_th.markup == parsed.topics[orig_th.guid].markup
+    assert parsed_th.viewpoints == orig_th.viewpoints
+    assert parsed_th.bim_snippet == orig_th.bim_snippet
+
+
+def test_bcf_edit(xml_handler, build_sample) -> None:
+    """Saving and loading a bcf xml project returns the same objects."""
+    bcf, orig_th = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+        with BcfXml.load(file_path, xml_handler=xml_handler) as parsed:
+            for th in parsed.topics.values():
+                th.topic.title = "New Topic Title"
+            parsed.save()
+            with BcfXml.load(file_path, xml_handler=xml_handler) as modified_parsed:
+                _assert_modified_parsed(modified_parsed, bcf, orig_th, parsed)
+                assert len(modified_parsed.topics) == 1
+
+
+def test_save_no_filename(build_sample) -> None:
+    bcf, _ = build_sample
+    with pytest.raises(ValueError):
+        bcf.save()
+
+
+def test_load_no_filename() -> None:
+    with pytest.raises(ValueError):
+        BcfXml.load("")
+
+
+def test_save_keep_open(build_sample) -> None:
+    bcf, _ = build_sample
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path, keep_open=True)
+        assert bcf._zip_file is not None
+        bcf._zip_file.close()
+
+
+def test_massive_bcf(xml_handler) -> None:
+    ext = mdl.Extensions(topic_types=mdl.ExtensionsTopicTypes(topic_type=["Test type"]))
+    bcf = BcfXml.create_new("Test project", extensions=ext, xml_handler=xml_handler)
+    for i in range(100):
+        th = bcf.add_topic(f"Topic {i:04}", f"Message {i:04}", "Test author", "Test type")
+        vi = mdl.VisualizationInfo(
+            guid=str(uuid.uuid4()),
+            components=build_components(str(uuid.uuid4())),
+            perspective_camera=build_camera_from_vectors([i, 0, 0], [0, 1, 0], [0, 0, 1]),
+        )
+        vh = VisualizationInfoHandler(visualization_info=vi, xml_handler=xml_handler)
+        th.add_visinfo_handler(vh)
+    assert len(bcf.topics) == 100
+    with TemporaryDirectory() as tmp_dir:
+        file_path = Path(tmp_dir) / "test.bcf"
+        bcf.save(file_path)
+
+
+def test_equality_with_wrong_object(build_sample) -> None:
+    assert build_sample[0] != "Wrong object"
+
+
+def test_topic_equality_with_wrong_object(build_sample) -> None:
+    assert build_sample[1] != "Wrong object"

src/bcf/tests/v3/test_example_files.py

@@ -0,0 +1,230 @@
+import json
+import os
+import zipfile
+from pathlib import Path
+
+from xsdata.models.datatype import XmlDateTime
+
+import bcf.v3.model as mdl
+from bcf.v3.bcfxml import BcfXml
+from bcf.v3.topic import TopicHandler
+
+
+def test_doc_ref_internal() -> None:
+    """
+    All the info in a BCF is parsed correctly.
+
+    Uses sample file from https://github.com/buildingSMART/BCF-XML/
+    """
+    bcf_path = Path(__file__).parent / "Document reference internal.bcf"
+    with BcfXml.load(bcf_path) as bcf:
+        assert_everything_in_place(bcf)
+
+
+def test_doc_ref_internal_save() -> None:
+    base_dir = Path(__file__).parent
+    bcf_path = base_dir / "Document reference internal.bcf"
+    target_path = base_dir / "Document reference internal Saved.bcf"
+    with BcfXml.load(bcf_path) as bcf:
+        bcf.save(target_path)
+    assert target_path.exists()
+    with BcfXml.load(target_path) as bcf2:
+        assert_everything_in_place(bcf2)
+    assert_files_present(target_path)
+    os.unlink(target_path)
+
+
+def assert_everything_in_place(bcf: BcfXml):
+    assert bcf.version.version_id == "3.0"
+    assert bcf.project.name == "BCF 3.0 test cases"
+    assert bcf.project.project_id == "de894a86-3a08-4ea0-b2d1-6c222b5602d1"
+
+    assert len(bcf.topics) == 1
+    topic_handler = bcf.topics["8ac9822a-761a-4deb-9f39-f61286acbf6a"]
+
+    expected_h1 = mdl.Header(
+        files=mdl.HeaderFiles(
+            file=[
+                mdl.File(
+                    filename="BCF-ARK",
+                    date=XmlDateTime(2021, 1, 4, 9, 37, 45),
+                    reference="https://bimsync.com/project/f5fbb3c695274d1890036bf64f77eb71/revisions/007afab57f264d2296aae0a452486ae1",
+                    is_external=True,
+                ),
+                mdl.File(
+                    filename="BCF-MEP",
+                    date=XmlDateTime(2017, 8, 7, 9, 51, 34),
+                    reference="https://bimsync.com/project/f5fbb3c695274d1890036bf64f77eb71/revisions/a21ed391f9e046a2bb2bc879c48f1d48",
+                    is_external=True,
+                ),
+            ]
+        )
+    )
+    assert topic_handler.header == expected_h1
+
+    expected_comments = [
+        mdl.Comment(
+            date=XmlDateTime(2021, 2, 17, 9, 16, 4, 160_000_000),
+            author="Architect@example.com",
+            comment="A comment",
+            viewpoint=mdl.CommentViewpoint(guid="20ad2ff7-ceac-4d4b-b288-ad92a0f65182"),
+            guid="c045ef04-324d-4c36-9ac8-831f2a15c6d6",
+        ),
+    ]
+    assert topic_handler.comments == expected_comments
+
+    expected_viewpoints = [
+        mdl.ViewPoint(
+            viewpoint="Viewpoint_20ad2ff7-ceac-4d4b-b288-ad92a0f65182.bcfv",
+            snapshot="Snapshot_20ad2ff7-ceac-4d4b-b288-ad92a0f65182.png",
+            guid="20ad2ff7-ceac-4d4b-b288-ad92a0f65182",
+        ),
+    ]
+
+    expected_topic = mdl.Topic(
+        reference_links=mdl.TopicReferenceLinks(),
+        title="Document Reference Internal",
+        labels=mdl.TopicLabels(),
+        creation_date=XmlDateTime(2021, 2, 17, 9, 16, 4, 160_000_000),
+        creation_author="Architect@example.com",
+        modified_date=XmlDateTime(2021, 2, 17, 9, 16, 4, 160_000_000),
+        assigned_to="OtherUser@doe.com",
+        document_references=mdl.TopicDocumentReferences(
+            document_reference=[
+                mdl.DocumentReference(
+                    document_guid="b1d1b7f0-60b9-457d-ad12-16e0fb997bc5",
+                    description="ThisIsADocument.txt",
+                    guid="048e898f-555f-47c3-a273-6c664fb2ef69",
+                ),
+            ],
+        ),
+        related_topics=mdl.TopicRelatedTopics(),
+        comments=mdl.TopicComments(comment=expected_comments),
+        viewpoints=mdl.TopicViewpoints(view_point=expected_viewpoints),
+        guid="8ac9822a-761a-4deb-9f39-f61286acbf6a",
+        server_assigned_id="6",
+        topic_type="ERROR",
+        topic_status="OPEN",
+    )
+    assert topic_handler.topic == expected_topic
+
+    expected_m1 = mdl.Markup(
+        header=expected_h1,
+        topic=expected_topic,
+    )
+    assert topic_handler.markup == expected_m1
+
+    assert topic_handler.bim_snippet is None
+
+    assert_viewpoints(topic_handler.viewpoints)
+
+
+def assert_viewpoints(viewpoints):
+    assert len(viewpoints) == 1
+
+    expected_vp = mdl.VisualizationInfo(
+        components=mdl.Components(
+            selection=mdl.ComponentSelection(),
+            visibility=mdl.ComponentVisibility(
+                view_setup_hints=mdl.ViewSetupHints(
+                    spaces_visible=False,
+                    space_boundaries_visible=False,
+                    openings_visible=False,
+                ),
+                exceptions=mdl.ComponentVisibilityExceptions(
+                    component=[
+                        mdl.Component(ifc_guid="1m5wAJelDFdhn6qBdOGjos", originating_system="https://bimsync.com"),
+                        mdl.Component(ifc_guid="1bbI761TbBCOoIa5Kt6PXt", originating_system="https://bimsync.com"),
+                    ]
+                ),
+                default_visibility=True,
+            ),
+            coloring=mdl.ComponentColoring(),
+        ),
+        perspective_camera=mdl.PerspectiveCamera(
+            camera_view_point=mdl.Point(x=23.112083480037754, y=-25.45574897560043, z=18.52519828443092),
+            camera_direction=mdl.Direction(x=-0.6289237666876837, y=0.5933487270610425, z=-0.5023864884632315),
+            camera_up_vector=mdl.Direction(x=-0.36542566067664123, y=0.3447553774917179, z=0.8646431727652648),
+            field_of_view=60,
+            aspect_ratio=1,
+        ),
+        lines=mdl.VisualizationInfoLines(),
+        clipping_planes=mdl.VisualizationInfoClippingPlanes(),
+        bitmaps=mdl.VisualizationInfoBitmaps(),
+        guid="20ad2ff7-ceac-4d4b-b288-ad92a0f65182",
+    )
+
+    viewpoint = viewpoints["Viewpoint_20ad2ff7-ceac-4d4b-b288-ad92a0f65182.bcfv"]
+    assert viewpoint.visualization_info == expected_vp
+    assert viewpoint.snapshot is not None
+
+
+def assert_second_viewpoint(viewpoint, expected_selection, expected_exception, expected_coloring) -> None:
+    expected_vp = mdl.VisualizationInfo(
+        components=mdl.Components(
+            view_setup_hints=mdl.ViewSetupHints(
+                spaces_visible=False,
+                space_boundaries_visible=False,
+                openings_visible=False,
+            ),
+            selection=expected_selection,
+            visibility=mdl.ComponentVisibility(
+                exceptions=expected_exception,
+                default_visibility=False,
+            ),
+            coloring=expected_coloring,
+        ),
+        perspective_camera=mdl.PerspectiveCamera(
+            camera_view_point=mdl.Point(x=-47.18794250488281, y=43.829200744628906, z=10.666350364685059),
+            camera_direction=mdl.Direction(x=0.6745243072509766, y=-0.6599355936050415, z=-0.33091068267822266),
+            camera_up_vector=mdl.Direction(x=0.2271970510482788, y=-0.24091780185699463, z=0.9435783624649048),
+            field_of_view=60,
+        ),
+        guid="21dd4807-e9af-439e-a980-04d913a6b1ce",
+    )
+    assert viewpoint.visualization_info == expected_vp
+    assert viewpoint.snapshot is not None
+
+
+def assert_third_viewpoint(viewpoint, expected_selection, expected_exception, expected_coloring) -> None:
+    expected_vp = mdl.VisualizationInfo(
+        components=mdl.Components(
+            view_setup_hints=mdl.ViewSetupHints(
+                spaces_visible=False,
+                space_boundaries_visible=False,
+                openings_visible=True,
+            ),
+            selection=expected_selection,
+            visibility=mdl.ComponentVisibility(
+                exceptions=expected_exception,
+                default_visibility=True,
+            ),
+            coloring=expected_coloring,
+        ),
+        perspective_camera=mdl.PerspectiveCamera(
+            camera_view_point=mdl.Point(x=-48.974571228027344, y=-64.20051574707031, z=10.666350364685059),
+            camera_direction=mdl.Direction(x=0.7232745289802551, y=0.5967116951942444, z=-0.3475759029388428),
+            camera_up_vector=mdl.Direction(x=0.27662187814712524, y=0.21082592010498047, z=0.937567412853241),
+            field_of_view=60,
+        ),
+        guid="81daa431-bf01-4a49-80a2-1ab07c177717",
+    )
+    assert viewpoint.visualization_info == expected_vp
+    assert viewpoint.snapshot is not None
+
+
+def assert_files_present(saved_bcf_path):
+    expected_files = [
+        "bcf.version",
+        "project.bcfp",
+        "documents.xml",
+        "extensions.xml",
+        "documents/b1d1b7f0-60b9-457d-ad12-16e0fb997bc5",
+        "8ac9822a-761a-4deb-9f39-f61286acbf6a/markup.bcf",
+        "8ac9822a-761a-4deb-9f39-f61286acbf6a/Viewpoint_20ad2ff7-ceac-4d4b-b288-ad92a0f65182.bcfv",
+        "8ac9822a-761a-4deb-9f39-f61286acbf6a/Snapshot_20ad2ff7-ceac-4d4b-b288-ad92a0f65182.png",
+    ]
+
+    with zipfile.ZipFile(saved_bcf_path) as bcf_zip:
+        for file_path in expected_files:
+            assert zipfile.Path(bcf_zip, file_path).exists()

src/bcf/tests/v3/test_ifcclash_api.py

@@ -0,0 +1,36 @@
+import numpy as np
+import pytest
+
+from bcf.v3.bcfxml import BcfXml
+
+
+def test_create_clash_set_bcf() -> None:
+    bcfxml = BcfXml.create_new("Clash Test")
+    topic = bcfxml.add_topic("Test", "Test topic", "IfcClash")
+    topic.add_viewpoint_from_point_and_guids(
+        np.array([10, 10, 10]),
+        "firstId",
+        "secondId",
+    )
+    assert len(topic.viewpoints) == 1
+    guid, vi_handler = next((k, v) for k, v in topic.viewpoints.items())
+    v_info = vi_handler.visualization_info
+    assert f"{v_info.guid}.bcfv" == guid
+    components = v_info.components.selection.component
+    assert {c.ifc_guid for c in components} == {"firstId", "secondId"}
+    camera = v_info.perspective_camera
+    viewpoint = camera.camera_view_point
+    assert viewpoint.x == 15
+    assert viewpoint.y == 15
+    assert viewpoint.z == 15
+    # default direction is the unit vector of -1, -1, -1
+    direction = camera.camera_direction
+    assert direction.x == pytest.approx(-1 / 3**0.5)
+    assert direction.y == pytest.approx(-1 / 3**0.5)
+    assert direction.z == pytest.approx(-1 / 3**0.5)
+    # default
+    up_vector = camera.camera_up_vector
+    assert up_vector.x == pytest.approx(-1 / 6**0.5)
+    assert up_vector.y == pytest.approx(-1 / 6**0.5)
+    assert up_vector.z == pytest.approx(1 / 1.5**0.5)
+    assert camera.field_of_view == 60

src/blenderbim/Makefile

@@ -1,5 +1,5 @@
 # BlenderBIM Add-on - OpenBIM Blender Add-on
-# Copyright (C) 2020, 2021 Dion Moult <dion@thinkmoult.com>
+# Copyright (C) 2020-2023 Dion Moult <dion@thinkmoult.com>
 #
 # This file is part of BlenderBIM Add-on.
 #
@@ -16,6 +16,25 @@
 # You should have received a copy of the GNU General Public License
 # along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
 
+PYTHON:=python3.10
+PIP:=pip3.10
+PATCH:=patch
+SED:=sed -i
+ifeq ($(OS),Windows_NT)
+HOSTOS:=win
+else
+UNAME_S:=$(shell uname -s)
+ifeq ($(UNAME_S),Linux)
+HOSTOS:=linux
+endif
+ifeq ($(UNAME_S),Darwin)
+HOSTOS:=macos
+PYTHON:=python3
+PATCH:=patch -d
+SED:=sed -i '' -e
+endif
+endif
+
 VERSION:=`date '+%y%m%d'`
 PYVERSION:=py37
 
@@ -27,6 +46,10 @@ ifeq ($(PYVERSION), py39)
 PYLIBDIR:=python3.9
 PYNUMBER:=39
 endif
+ifeq ($(PYVERSION), py310)
+PYLIBDIR:=python3.10
+PYNUMBER:=310
+endif
 
 ifeq ($(PLATFORM), linux)
 ifeq ($(PYVERSION), py37)
@@ -34,12 +57,24 @@ HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.7.5/download/linux-64/hpp
 EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.5/download/linux-64/eigenpy-2.6.5-py37h95e2c48_0.tar.bz2
 BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/linux-64/boost-1.74.0-py37h0379df6_3.tar.bz2
 LXML_URL:=https://files.pythonhosted.org/packages/30/c0/d0526314971fc661b083ab135747dc68446a3022686da8c16d25fcf6ef07/lxml-4.6.3-cp37-cp37m-manylinux2014_x86_64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/1d/a4/931d0780f31f3ea8c4f9ef6464a2825137c5241e6707a5fb03bef760a7eb/shapely-2.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/ed/d5/c2e84e1e36ab8ebea033921d5886a056c77e18bab5ab1051fcc22de2e8a2/Pillow-9.2.0-cp37-cp37m-manylinux_2_28_x86_64.whl
 endif
 ifeq ($(PYVERSION), py39)
 HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.7.5/download/linux-64/hpp-fcl-1.7.5-py39hbcdfc36_0.tar.bz2
 EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.5/download/linux-64/eigenpy-2.6.5-py39h5aed9d1_0.tar.bz2
 BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/linux-64/boost-1.74.0-py39h5472131_3.tar.bz2
 LXML_URL:=https://files.pythonhosted.org/packages/19/d9/a69c6aff5673554df48120565a14a50eaa41d29ae03b02faa0b023666318/lxml-4.6.3-cp39-cp39-manylinux2014_x86_64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/2d/f2/8ec281d357e8bb7d08dc8d727f0e4c8ef3dae7d3fa75c69c8e452bb82d50/shapely-2.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/01/61/3ff85fb4bb596ce3d223c8fcf93c8df5c12bc8899dfb4fb3cb1c5b20dd5f/Pillow-9.2.0-cp39-cp39-manylinux_2_28_x86_64.whl
+endif
+ifeq ($(PYVERSION), py310)
+HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.8.0/download/linux-64/hpp-fcl-1.8.0-py310hdaf7e41_1.tar.bz2
+EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.11/download/linux-64/eigenpy-2.6.11-py310hf3e5c9c_0.tar.bz2
+BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/linux-64/boost-1.74.0-py310h7c3ba0c_5.tar.bz2
+LXML_URL:=https://files.pythonhosted.org/packages/25/1e/19b46d8e8881fe0df2e20945d51919eeb1817836d62a90efa8506530e45c/lxml-4.8.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_24_x86_64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/a8/a5/403728b5614b28083f6424dfdefec5fcf58068495fb03bb08532671c642f/shapely-2.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/f6/51/320986ebd6d46a0e95c2240468ced73153b691ce07617078bcdf30c609ec/Pillow-9.2.0-cp310-cp310-manylinux_2_28_x86_64.whl
 endif
 ASSIMP_URL:=https://anaconda.org/conda-forge/assimp/5.0.1/download/linux-64/assimp-5.0.1-hedfc422_6.tar.bz2
 OCTOMAP_URL:=https://anaconda.org/conda-forge/octomap/1.9.7/download/linux-64/octomap-1.9.7-h4bd325d_0.tar.bz2
@@ -52,36 +87,98 @@ HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.7.5/download/osx-64/hpp-f
 EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.5/download/osx-64/eigenpy-2.6.5-py37h0695097_0.tar.bz2
 BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/osx-64/boost-1.74.0-py37hd79e0ac_3.tar.bz2
 LXML_URL:=https://files.pythonhosted.org/packages/1e/3e/f0abc15d5dac50939bccc589aae336d5ead4c72e7ad1039a2e0f3630ea92/lxml-4.6.3-cp37-cp37m-macosx_10_9_x86_64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/e6/7d/4923f27c340339e1c896c77cafc8ed672c8d381a025bbab6c6ddcba27e8f/shapely-2.0.1-cp37-cp37m-macosx_10_9_x86_64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/88/49/c26fc3b5b0e82bdc9d8751d6b939da29327b0d98f7c3b95a575cbfed2743/Pillow-9.2.0-cp37-cp37m-macosx_10_10_x86_64.whl
 endif
 ifeq ($(PYVERSION), py39)
 HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.7.5/download/osx-64/hpp-fcl-1.7.5-py39h1e32b98_0.tar.bz2
 EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.5/download/osx-64/eigenpy-2.6.5-py39h5405915_0.tar.bz2
 BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/osx-64/boost-1.74.0-py39ha641261_3.tar.bz2
 LXML_URL:=https://files.pythonhosted.org/packages/b8/74/a71f7ad72e8db54ce899efab84507b801660750cbbfa6a39e6717557d36a/lxml-4.6.3-cp39-cp39-macosx_10_9_x86_64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/36/a4/7e542a209f862f967d7cb8e939eff155f4294a27d17e16441fb8bdd51a2c/shapely-2.0.1-cp39-cp39-macosx_10_9_x86_64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/88/7a/ddfe28b485b623361457d4783007c1f9ba83a87f93e7fec32f64793efb6c/Pillow-9.2.0-cp39-cp39-macosx_10_10_x86_64.whl
+endif
+ifeq ($(PYVERSION), py310)
+HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.8.0/download/osx-64/hpp-fcl-1.8.0-py310h651ac30_1.tar.bz2
+EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.11/download/osx-64/eigenpy-2.6.11-py310hc03097c_0.tar.bz2
+BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/osx-64/boost-1.74.0-py310h509978a_5.tar.bz2
+LXML_URL:=https://files.pythonhosted.org/packages/a1/44/17b7dac7a18807d30e2fe10c3328c152808f5464565e230bfd0e77f178c6/lxml-4.8.0-cp310-cp310-macosx_10_15_x86_64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/1f/2a/dc3353c2431cf53e8d04bb8fba27e584410ca3435c9c85f76d71bf0c0e80/shapely-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/d8/60/b13c00d403f34110e96c1b5c0afa73ce461efe3fe960c3a7e3e7fe190d82/Pillow-9.2.0-cp310-cp310-macosx_10_10_x86_64.whl
 endif
 ASSIMP_URL:=https://anaconda.org/conda-forge/assimp/5.0.1/download/osx-64/assimp-5.0.1-h1224e73_6.tar.bz2
 OCTOMAP_URL:=https://anaconda.org/conda-forge/octomap/1.9.7/download/osx-64/octomap-1.9.7-h940c156_0.tar.bz2
 ZLIB_URL:=https://anaconda.org/conda-forge/zlib/1.2.11/download/osx-64/zlib-1.2.11-h7795811_1010.tar.bz2
 endif
 
+ifeq ($(PLATFORM), macosm1)
+ifeq ($(PYVERSION), py37)
+# Warning: py37 not supported on Apple M1
+HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.7.5/download/osx-64/hpp-fcl-1.7.5-py37h2d7f23a_0.tar.bz2
+EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.5/download/osx-64/eigenpy-2.6.5-py37h0695097_0.tar.bz2
+BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/osx-64/boost-1.74.0-py37hd79e0ac_3.tar.bz2
+LXML_URL:=https://anaconda.org/conda-forge/lxml/4.9.1/download/osx-64/lxml-4.9.1-py37h994c40b_0.tar.bz2
+SHAPELY_URL:=https://files.pythonhosted.org/packages/e6/7d/4923f27c340339e1c896c77cafc8ed672c8d381a025bbab6c6ddcba27e8f/shapely-2.0.1-cp37-cp37m-macosx_10_9_x86_64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/aa/bc/21097cd891dd2fa02f2b3d767e02e883e026482e59d29975d1bc30024aa3/Pillow-9.2.0-cp39-cp39-macosx_11_0_arm64.whl
+endif
+ifeq ($(PYVERSION), py39)
+HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.7.5/download/osx-arm64/hpp-fcl-1.7.5-py39ha69f3c1_2.tar.bz2
+EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.7/download/osx-arm64/eigenpy-2.6.7-py39ha69f3c1_0.tar.bz2
+BOOST_URL:=https://anaconda.org/conda-forge/boost/1.78.0/download/osx-arm64/boost-1.78.0-py39h2550fe3_0.tar.bz2
+LXML_URL:=https://anaconda.org/conda-forge/lxml/4.9.1/download/osx-arm64/lxml-4.9.1-py39h9eb174b_0.tar.bz2
+SHAPELY_URL:=https://files.pythonhosted.org/packages/ea/aa/45fbd031edf3149cb767d8b9f9db45d5faf0324d743c6b8fb0298cc022d0/shapely-2.0.1-cp39-cp39-macosx_11_0_arm64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/aa/bc/21097cd891dd2fa02f2b3d767e02e883e026482e59d29975d1bc30024aa3/Pillow-9.2.0-cp39-cp39-macosx_11_0_arm64.whl
+endif
+ifeq ($(PYVERSION), py310)
+HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.8.0/download/osx-arm64/hpp-fcl-1.8.0-py310h5699539_2.tar.bz2
+EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.9/download/osx-arm64/eigenpy-2.6.9-py310habfc766_1.tar.bz2
+BOOST_URL:=https://anaconda.org/conda-forge/boost/1.78.0/download/osx-arm64/boost-1.78.0-py310h4566fd1_0.tar.bz2
+LXML_URL:=https://anaconda.org/conda-forge/lxml/4.9.1/download/osx-arm64/lxml-4.9.1-py310h02f21da_0.tar.bz2
+SHAPELY_URL:=https://files.pythonhosted.org/packages/ec/41/d59208743e737184e1b403e95a937aebb022b8459e99efbcd5208fc8be46/shapely-2.0.1-cp310-cp310-macosx_11_0_arm64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/0c/5f/117b653cad585f3aedfe0de996c292e67d4b020ed77f652e5a6c8c24f908/Pillow-9.2.0-cp310-cp310-macosx_11_0_arm64.whl
+endif
+ASSIMP_URL:=https://anaconda.org/conda-forge/assimp/5.0.1/download/osx-arm64/assimp-5.0.1-h0f81e16_7.tar.bz2
+OCTOMAP_URL:=https://anaconda.org/conda-forge/octomap/1.9.7/download/osx-arm64/octomap-1.9.7-hc021e02_0.tar.bz2
+ZLIB_URL:=https://anaconda.org/conda-forge/zlib/1.2.11/download/osx-arm64/zlib-1.2.11-h90dfc92_1014.tar.bz2
+endif
+
 ifeq ($(PLATFORM), win)
 ifeq ($(PYVERSION), py37)
 HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.7.5/download/win-64/hpp-fcl-1.7.5-py37h839d6b1_0.tar.bz2
 EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.5/download/win-64/eigenpy-2.6.5-py37h2c32e34_0.tar.bz2
 BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/win-64/boost-1.74.0-py37h3b38789_3.tar.bz2
 LXML_URL:=https://files.pythonhosted.org/packages/9e/5e/171ee9d40a600f565fe691ec5bf7596247ec62cfb2edc00c91afe8ea837b/lxml-4.6.3-cp37-cp37m-win_amd64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/e2/87/b8b8d8d57b429b01aa56b7d723075c09f33c988b8091bb6f790c83436909/shapely-2.0.1-cp37-cp37m-win_amd64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/69/f5/9e802159d78b2eaf26bf1f8b94648605993f5ca7247ac8870f065063fc40/Pillow-9.2.0-cp37-cp37m-win_amd64.whl
 endif
 ifeq ($(PYVERSION), py39)
 HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.7.5/download/win-64/hpp-fcl-1.7.5-py39h2e7c763_0.tar.bz2
 EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.5/download/win-64/eigenpy-2.6.5-py39h3ce40e6_0.tar.bz2
 BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/win-64/boost-1.74.0-py39hefe7e4c_3.tar.bz2
 LXML_URL:=https://files.pythonhosted.org/packages/72/d4/426ecb8849c47c3e370c87aa0ac05d85768df917ffea27fcd6686a5e6495/lxml-4.6.3-cp39-cp39-win_amd64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/a7/ae/eab645c4075093584b7a65ab71cb8ff4563a015bd935c9b55dba14b2c1eb/shapely-2.0.1-cp39-cp39-win_amd64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/19/3f/b4d4bcf05dbcbe07f2e9613a8f4180c297395e73a91d8ad22c32c6624f8c/Pillow-9.2.0-cp39-cp39-win_amd64.whl
+endif
+ifeq ($(PYVERSION), py310)
+HPPFCL_URL:=https://anaconda.org/conda-forge/hpp-fcl/1.8.0/download/win-64/hpp-fcl-1.8.0-py310hc5a3c62_1.tar.bz2
+EIGENPY_URL:=https://anaconda.org/conda-forge/eigenpy/2.6.11/download/win-64/eigenpy-2.6.11-py310hbd43d28_0.tar.bz2
+BOOST_URL:=https://anaconda.org/conda-forge/boost/1.74.0/download/win-64/boost-1.74.0-py310hc781a3c_5.tar.bz2
+LXML_URL:=https://files.pythonhosted.org/packages/f6/71/65c80a4caa1617a4c6e8fe1500cebb179db96232e2f623bfe6a1f4294e39/lxml-4.8.0-cp310-cp310-win_amd64.whl
+SHAPELY_URL:=https://files.pythonhosted.org/packages/81/8a/7ac076a86b2632f1872284c5e60ed5f2fc26094875a85b35d9fa17b52504/shapely-2.0.1-cp310-cp310-win_amd64.whl
+PILLOW_URL:=https://files.pythonhosted.org/packages/02/55/67a3c17b9e7d972ed8c246f104da99ca4f3ea42fba566697e479011b84b6/Pillow-9.2.0-cp310-cp310-win_amd64.whl
 endif
 ASSIMP_URL:=https://anaconda.org/conda-forge/assimp/5.0.1/download/win-64/assimp-5.0.1-hc2aa0de_6.tar.bz2
 OCTOMAP_URL:=https://anaconda.org/conda-forge/octomap/1.9.7/download/win-64/octomap-1.9.7-h5362a0b_0.tar.bz2
 ZLIB_URL:=https://anaconda.org/conda-forge/zlib/1.2.11/download/win-64/zlib-1.2.11-h62dcd97_1010.tar.bz2
 endif
 
+.PHONY: bump
+bump:
+	cd . && $(SED) "s/$(OLD)/$(NEW)/" Makefile
+	cd ../ifcopenshell-python/ && $(SED) "s/$(OLD)/$(NEW)/" Makefile
+	cd ../ifcopenshell-python/docs/ifcconvert/ && $(SED) "s/$(OLD)/$(NEW)/" installation.rst
+	cd ../ifcopenshell-python/docs/ifcopenshell-python/ && $(SED) "s/$(OLD)/$(NEW)/" installation.rst
+
 .PHONY: dist
 dist:
 ifndef PLATFORM
@@ -93,9 +190,9 @@ endif
 	cp -r blenderbim/* dist/blenderbim/
 
 	# Provides IfcOpenShell Python functionality
-	cd dist/working && wget https://s3.amazonaws.com/ifcopenshell-builds/ifcblender-python-$(PYNUMBER)-v0.7.0-9853d3d-$(PLATFORM)64.zip
-	cd dist/working && unzip ifcblender*
-	cp -r dist/working/io_import_scene_ifc/ifcopenshell dist/blenderbim/libs/site/packages/
+	cd dist/working && wget https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-$(PYNUMBER)-v0.7.0-476ab50-$(PLATFORM)64.zip
+	cd dist/working && unzip ifcopenshell-python*
+	cp -r dist/working/ifcopenshell dist/blenderbim/libs/site/packages/
 
 	# See bug #812
 	cd dist/working && wget https://raw.githubusercontent.com/IfcOpenShell/IfcOpenShell/v0.7.0/src/blenderbim/occ_utils.py
@@ -111,16 +208,20 @@ endif
 	cp -r dist/working/IfcOpenShell-0.7.0/src/ifcopenshell-python/ifcopenshell/api/* dist/blenderbim/libs/site/packages/ifcopenshell/api/
 	cp dist/working/IfcOpenShell-0.7.0/src/ifcopenshell-python/ifcopenshell/entity_instance.py dist/blenderbim/libs/site/packages/ifcopenshell/
 	cp dist/working/IfcOpenShell-0.7.0/src/ifcopenshell-python/ifcopenshell/file.py dist/blenderbim/libs/site/packages/ifcopenshell/
+	cp dist/working/IfcOpenShell-0.7.0/src/ifcopenshell-python/ifcopenshell/validate.py dist/blenderbim/libs/site/packages/ifcopenshell/
+	cp dist/working/IfcOpenShell-0.7.0/src/ifcopenshell-python/ifcopenshell/express/rule_executor.py dist/blenderbim/libs/site/packages/ifcopenshell/express/
 	# Provides bcf functionality
 	cp -r dist/working/IfcOpenShell-0.7.0/src/bcf/src/bcf dist/blenderbim/libs/site/packages/
 	# Provides IFCClash functionality
 	cp -r dist/working/IfcOpenShell-0.7.0/src/ifcclash/ifcclash dist/blenderbim/libs/site/packages/
 	# Provides BIMTester functionality
-	cd dist/working && python -m venv env
-	cd dist/working && . env/bin/activate && pip install pybabel
-	cd dist/working && . env/bin/activate && pip install babel
+	cd dist/working && $(PYTHON) -m venv env
+	cd dist/working && . env/bin/activate && $(PIP) install pybabel
+	cd dist/working && . env/bin/activate && $(PIP) install babel
 	cd dist/working && . env/bin/activate && ./env/bin/pybabel compile -d ./IfcOpenShell-0.7.0/src/ifcbimtester/bimtester/locale/
 	cp -r dist/working/IfcOpenShell-0.7.0/src/ifcbimtester/bimtester dist/blenderbim/libs/site/packages/
+	# Provides IFCTester functionality
+	cp -r dist/working/IfcOpenShell-0.7.0/src/ifctester/ifctester dist/blenderbim/libs/site/packages/
 	# Provides IFCCOBie functionality
 	cp -r dist/working/IfcOpenShell-0.7.0/src/ifccobie/* dist/blenderbim/libs/site/packages/
 	# Provides IFCDiff functionality
@@ -133,13 +234,21 @@ endif
 	cp -r dist/working/IfcOpenShell-0.7.0/src/ifc4d/ifc4d dist/blenderbim/libs/site/packages/
 	# Provides IFC5D functionality
 	cp -r dist/working/IfcOpenShell-0.7.0/src/ifc5d/ifc5d dist/blenderbim/libs/site/packages/
+	# Provides IFCCityJSON functionality
+	cp -r dist/working/IfcOpenShell-0.7.0/src/ifccityjson dist/blenderbim/libs/site/packages/
+	# Provides IfcGit functionality
+	cd dist/working && . env/bin/activate && $(PIP) install GitPython --target=./site-packages
+	cp -r dist/working/site-packages/smmap dist/blenderbim/libs/site/packages/
+	cp -r dist/working/site-packages/gitdb dist/blenderbim/libs/site/packages/
+	cp -r dist/working/site-packages/git dist/blenderbim/libs/site/packages/
 	rm -rf dist/working
 
 	# Provides Mustache templating in construction documentation
+	# TODO: remove this dependency, it seems overkill and we seem to get by with str replaces
 	mkdir dist/working
-	cd dist/working && wget https://files.pythonhosted.org/packages/d6/fd/eb8c212053addd941cc90baac307c00ac246ac3fce7166b86434c6eae963/pystache-0.5.4.tar.gz
+	cd dist/working && wget https://files.pythonhosted.org/packages/3f/e7/8750ba6c6101d6aa5ceeb20c013adf2c6f3554a12c71d75654b468404bfa/pystache-0.6.0.tar.gz
 	cd dist/working && tar -xzvf pystache*
-	cd dist/working/pystache-0.5.4/ && python setup.py build && cp -r build/lib/pystache ../../blenderbim/libs/site/packages/
+	cd dist/working/pystache-0.6.0/ && $(PYTHON) setup.py build && cp -r build/lib/pystache ../../blenderbim/libs/site/packages/
 	rm -rf dist/working
 
 	# Provides SVG export in construction documentation
@@ -177,6 +286,13 @@ endif
 	cp -r dist/working/decorator-5.0.9/src/decorator.py dist/blenderbim/libs/site/packages/
 	rm -rf dist/working
 
+	# Provides audio playback for costing
+	mkdir -p dist/working
+	git clone https://github.com/Andrej730/aud.git --branch master-reduced-size --depth 1 dist/working/aud
+	cd dist/working/aud && git checkout 529af208fbcb707c387bfb681d2605c0b6112de7
+	cp -r dist/working/aud/aud dist/blenderbim/libs/site/packages/
+	rm -rf dist/working
+
 	# Provides jsgantt-improved supports for web-based construction sequencing gantt charts
 	mkdir dist/working
 	cd dist/working && wget https://raw.githubusercontent.com/jsGanttImproved/jsgantt-improved/master/dist/jsgantt.js
@@ -186,9 +302,9 @@ endif
 
 	# Required by IFCDiff
 	mkdir dist/working
-	cd dist/working && wget https://github.com/Moult/deepdiff/archive/master.zip
-	cd dist/working && unzip master.zip
-	cp -r dist/working/deepdiff-master/deepdiff dist/blenderbim/libs/site/packages/
+	cd dist/working && wget https://files.pythonhosted.org/packages/0f/ca/caead2949fbb824c7142e3774fa841aa853bb4d4331b440da8c8514dfc6f/deepdiff-5.8.1.tar.gz
+	cd dist/working && tar -xzvf deepdiff*
+	cp -r dist/working/deepdiff-5.8.1/deepdiff dist/blenderbim/libs/site/packages/
 	rm -rf dist/working
 
 	# Required by deepdiff
@@ -214,16 +330,23 @@ endif
 
 	# Required by bcf
 	mkdir dist/working
-	cd dist/working && wget https://files.pythonhosted.org/packages/bb/41/ad9ce53bb978b68af8ae415293cafc89b165b8ad55a593725299dca76729/xmlschema-1.1.1.tar.gz
+	cd dist/working && wget https://files.pythonhosted.org/packages/5b/ef/f97c3e1a7efa00e989a793fe15297214fc95ad7d9e3810586bd08ce9f0f3/xmlschema-2.0.2.tar.gz
 	cd dist/working && tar -xzvf xmlschema*
-	cp -r dist/working/xmlschema-1.1.1/xmlschema dist/blenderbim/libs/site/packages/
+	cp -r dist/working/xmlschema-2.0.2/xmlschema dist/blenderbim/libs/site/packages/
 	rm -rf dist/working
 
 	# Required by bcf
 	mkdir dist/working
-	cd dist/working && wget https://files.pythonhosted.org/packages/12/f9/f9960222d5274944b01391749e55e4dcdf28d8f0c108b64ac931ceff6fdb/elementpath-1.4.3.tar.gz
+	cd dist/working && wget https://files.pythonhosted.org/packages/ad/c7/17c9d16320d8e2cfdb27d2fd298b5e8f7a3f211025b0c1bc7a39a85bd690/xsdata-22.11.tar.gz
+	cd dist/working && tar -xzvf xsdata*
+	cp -r dist/working/xsdata-22.11/xsdata dist/blenderbim/libs/site/packages/
+	rm -rf dist/working
+
+	# Required by bcf
+	mkdir dist/working
+	cd dist/working && wget https://files.pythonhosted.org/packages/11/bc/5afb61dd5d863e5cf77cd952445c50c17e65953405986f19e97e4389692a/elementpath-3.0.2.tar.gz
 	cd dist/working && tar -xzvf elementpath*
-	cp -r dist/working/elementpath-1.4.3/elementpath dist/blenderbim/libs/site/packages/
+	cp -r dist/working/elementpath-3.0.2/elementpath dist/blenderbim/libs/site/packages/
 	rm -rf dist/working
 
 	# Required by bcf
@@ -240,6 +363,55 @@ endif
 	cp -r dist/working/lark-parser-0.8.5/lark dist/blenderbim/libs/site/packages/
 	rm -rf dist/working
 
+	# Required by IFC4D
+	mkdir dist/working
+	cd dist/working && wget https://files.pythonhosted.org/packages/b0/bb/9c4dddd3ca173cb56241cfb2eddfae24690dc676d357ac4cab17d0a36d9d/PyP6Xer-1.13.0.tar.gz
+	cd dist/working && tar -xzvf PyP6Xer*
+	cp -r dist/working/PyP6Xer-1.13.0/xerparser dist/blenderbim/libs/site/packages/
+	rm -rf dist/working
+
+	# Required by QTOCalculator
+	mkdir dist/working
+	cd dist/working && wget $(SHAPELY_URL)
+	cd dist/working && cp *.whl shapely.zip && unzip shapely.zip
+	cp -r dist/working/shapely dist/blenderbim/libs/site/packages/
+ifeq ($(PLATFORM), win)
+	cp -r dist/working/shapely.libs dist/blenderbim/libs/site/packages/
+endif
+ifeq ($(PLATFORM), linux)
+	cp -r dist/working/shapely.libs dist/blenderbim/libs/site/packages/
+endif
+	rm -rf dist/working
+
+	# Required by the BIM tool thumbnail generator
+	mkdir dist/working
+	cd dist/working && wget $(PILLOW_URL)
+	cd dist/working && cp *.whl pillow.zip && unzip pillow.zip
+	cp -r dist/working/PIL dist/blenderbim/libs/site/packages/
+ifeq ($(PLATFORM), linux)
+	cp -r dist/working/Pillow.libs dist/blenderbim/libs/site/packages/
+endif
+	rm -rf dist/working
+
+	# Required by xerparser and IFC4D
+	# TODO: remove this dependency. It's only used to show a progress bar.
+	mkdir dist/working
+	cd dist/working && wget https://files.pythonhosted.org/packages/9f/7b/76c4e5ef1a1b528fcaada4133f972e77d33c252831676cf414119ca6093d/tqdm-4.50.0.tar.gz
+	cd dist/working && tar -xzvf tqdm*
+	cp -r dist/working/tqdm-4.50.0/tqdm dist/blenderbim/libs/site/packages/
+	rm -rf dist/working
+
+	mkdir dist/working
+	cd dist/working && $(PYTHON) -m venv env
+	cd dist/working && mkdir site-packages
+	# Required by IFCCityJSON
+	cd dist/working && . env/bin/activate && $(PIP) install cjio --target=./site-packages
+	# Provides express rule validation for ifcopenshell.validate
+	cd dist/working && . env/bin/activate && $(PIP) install pytest --target=./site-packages
+	cd dist/working/site-packages/ && rm -r *dist-info*
+	cp -r dist/working/site-packages/* dist/blenderbim/libs/site/packages/
+	rm -rf dist/working
+
 	# Required by IFCClash
 	mkdir dist/working
 	cd dist/working && wget $(HPPFCL_URL)
@@ -341,16 +513,30 @@ endif
 	# See bug #1294
 	cd dist/working/ && wget https://raw.githubusercontent.com/IfcOpenShell/IfcOpenShell/v0.7.0/src/ifcbimtester/patch/model_core.patch
 	cd dist/working/ && wget https://raw.githubusercontent.com/IfcOpenShell/IfcOpenShell/v0.7.0/src/ifcbimtester/patch/runner_util.patch
-	cd dist/working/ && patch ../blenderbim/libs/site/packages/behave/model_core.py < model_core.patch
-	cd dist/working/ && patch ../blenderbim/libs/site/packages/behave/runner_util.py < runner_util.patch
+	cd dist/working/ && $(PATCH) ../blenderbim/libs/site/packages/behave/model_core.py < model_core.patch
+	cd dist/working/ && $(PATCH) ../blenderbim/libs/site/packages/behave/runner_util.py < runner_util.patch
+	# See bug #2159
+	cd dist/working/ && wget https://raw.githubusercontent.com/IfcOpenShell/IfcOpenShell/v0.7.0/src/ifcbimtester/patch/junit.patch
+	cd dist/working/ && $(PATCH) ../blenderbim/libs/site/packages/behave/reporter/junit.py < junit.patch
 	rm -rf dist/working
 
-	# Required by ids
+	# Required by ids - uh, not any more, but I'm trying it out in the drawing module
+ifeq ($(PLATFORM), macosm1)
+	# No wheels available for MacOS M1, but turns out this Anaconda build works
+	mkdir dist/working
+	cd dist/working && wget $(LXML_URL)
+	cd dist/working && tar -xf lxml*
+	cp -r dist/working/lib/$(PYLIBDIR)/site-packages/lxml dist/blenderbim/libs/site/packages/
+	rm -rf dist/working
+else
+	# Wheels are preferred for other OSes. A first attempt at using Anaconda
+	# builds for everything shows it breaks on windows. See #2422.
 	mkdir dist/working
 	cd dist/working && wget $(LXML_URL)
 	cd dist/working && cp *.whl lxml.zip && unzip lxml.zip
 	cp -r dist/working/lxml dist/blenderbim/libs/site/packages/
 	rm -rf dist/working
+endif
 
 	# Required by behave
 	mkdir dist/working
@@ -367,6 +553,7 @@ endif
 	rm -rf dist/working
 
 	# Required by IFCCOBie for XLSX support
+	# TODO: see if we can replace this with openpyxl which does both read/write
 	mkdir dist/working
 	cd dist/working && wget https://files.pythonhosted.org/packages/0c/bc/82d6783f83f65f56d8b77d052773c4a2f952fa86385f0cd54e1e006658d7/XlsxWriter-1.2.9.tar.gz
 	cd dist/working && tar -xzvf XlsxWriter*
@@ -422,14 +609,69 @@ endif
 	cp -r dist/working/IFC2JSON_python-master/file_converters/ifcjson dist/blenderbim/libs/site/packages/
 	rm -rf dist/working
 
-	# Provides OpenLCA fucntionality
+	# Provides OpenLCA functionality
 	mkdir dist/working
 	cd dist/working && wget https://files.pythonhosted.org/packages/85/33/f91b96e9e8608ff65a003b692e8a9cdd60f2178f60617e5b1d21334c009c/olca-ipc-0.0.10.tar.gz
 	cd dist/working && tar -xzvf olca-ipc*
 	cd dist/working/olca-ipc-0.0.10/ && cp -r olca ../../blenderbim/libs/site/packages/
 	rm -rf dist/working
 
-	cd dist/blenderbim && sed -i "s/999999/$(VERSION)/" __init__.py
+	# Provides Brickschema functionality
+	mkdir dist/working
+	cd dist/working && wget https://files.pythonhosted.org/packages/ca/37/8309da9a72407d2f5eb5489c197ac3cfe96ee3ccba1902d2a0ecc7843f92/brickschema-0.5.1.tar.gz
+	cd dist/working && tar -xzvf brickschema*
+	# This is an evil hack because we don't want to bundle flask
+	echo "" > dist/working/brickschema-0.5.1/brickschema/web.py
+	cd dist/working/brickschema-0.5.1/ && cp -r brickschema ../../blenderbim/libs/site/packages/
+	# For now lets bundle the latest nightly schema
+	cd dist/working && wget https://github.com/BrickSchema/Brick/releases/download/nightly/Brick.ttl
+	cd dist/working && cp Brick.ttl ../blenderbim/bim/schema/Brick.ttl
+	rm -rf dist/working
+
+	# Required by brickschema
+	mkdir dist/working
+	cd dist/working && wget https://files.pythonhosted.org/packages/c7/22/37bb938be8e5c20d443b0c9ba0a243573b671b01739efb0a19f81bc5b470/pyshacl-0.17.2.tar.gz
+	cd dist/working && tar -xzvf pyshacl*
+	cd dist/working/pyshacl-0.17.2/ && cp -r pyshacl ../../blenderbim/libs/site/packages/
+	rm -rf dist/working
+
+	# Required by brickschema
+	mkdir dist/working
+	cd dist/working && wget https://files.pythonhosted.org/packages/d2/a7/be8244688bfcee37c23733ab4fe8e6afa6d4403bd2674a3ae7bd2cecc77b/rdflib-6.0.2.tar.gz
+	cd dist/working && tar -xzvf rdflib*
+	cd dist/working/rdflib-6.0.2/ && cp -r rdflib ../../blenderbim/libs/site/packages/
+	rm -rf dist/working
+
+	# Required by brickschema
+	mkdir dist/working
+	cd dist/working && wget https://files.pythonhosted.org/packages/7d/c7/208aece36279e4f1236e437119358786e39530ecc1719d4e1afeddba5288/owlrl-6.0.2.tar.gz
+	cd dist/working && tar -xzvf owlrl*
+	cd dist/working/owlrl-6.0.2/ && cp -r owlrl ../../blenderbim/libs/site/packages/
+	rm -rf dist/working
+
+	# Required by brickschema
+	# This is a bit of a dodgy one, it should be provided by setuptools which Blender doesn't ship.
+	mkdir dist/working
+	cd dist/working && wget https://blenderbim.org/builds/pkg_resources.tar.gz
+	cd dist/working && tar -xzvf pkg_resources*
+	cd dist/working/ && cp -r pkg_resources ../blenderbim/libs/site/packages/
+	rm -rf dist/working
+
+	# Required for hipped roof generation
+	mkdir dist/working
+	cd dist/working && wget https://github.com/prochitecture/bpypolyskel/archive/refs/heads/master.zip
+	cd dist/working && unzip master.zip
+	cp -r dist/working/bpypolyskel-master/bpypolyskel dist/blenderbim/libs/site/packages/
+	rm -rf dist/working
+
+	# Required for Desktop icon and file association
+	cp -r blenderbim/libs/desktop dist/blenderbim/libs/
+
+	# Remove dependencies also bundled with Blender
+	rm -rf dist/blenderbim/libs/site/packages/numpy
+	rm -rf dist/blenderbim/libs/site/packages/numpy.libs
+
+	cd dist/blenderbim && $(SED) "s/999999/$(VERSION)/" __init__.py
 	cd dist && zip -r blenderbim-$(VERSION)-$(PYVERSION)-$(PLATFORM).zip ./*
 	rm -rf dist/blenderbim
 
@@ -445,11 +687,19 @@ test-core:
 
 .PHONY: test-bim
 test-bim:
+ifndef MODULE
 	pytest test/bim
+else
+	pytest test/bim -m "$(MODULE)" ./ --maxfail=1
+endif
 
 .PHONY: test-tool
 test-tool:
+ifndef MODULE
 	pytest test/tool
+else
+	pytest test/tool/test_$(MODULE).py
+endif
 
 .PHONY: qa
 qa:
@@ -464,7 +714,7 @@ coverage:
 
 .PHONY: license
 license:
-	copyright-header --license GPL3 --copyright-holder "Dion Moult <dion@thinkmoult.com>" --copyright-year "2021" --copyright-software "BlenderBIM Add-on" --copyright-software-description "OpenBIM Blender Add-on" -a ./ -o ./
+	copyright-header --license GPL3 --copyright-holder "Dion Moult <dion@thinkmoult.com>" --copyright-year "2022" --copyright-software "BlenderBIM Add-on" --copyright-software-description "OpenBIM Blender Add-on" -a ./ -o ./
 
 .PHONY: clean
 clean:

src/blenderbim/README.md

@@ -1,127 +1,5 @@
-# Blender BIM IFC
+# BlenderBIM Add-on
 
-_Under heavy development!_
+An add-on to Blender to allow BIM functionality.
 
-Let's use Blender to create BIM models, because why not?
-
-## Features
-
- - IFC4 is a first-class citizen. IFC4 has been an ISO standard since 2013, with
-   the latest published in 2018. It contains many more features than IFC2X3,
-   published back in 2005.
- - Available for Windows, Mac, and Linux!
- - Use open-source Blender 2.8 to do digital modeling! Used by NASA, Hollywood,
-   and Ubisoft, Blender allows real-time modeling in rendered view, animations,
-   file linking, proxy objects, Blender Cloud collaboration, lighting analysis,
-   CFD, energy modeling, and a huge ecosystem of add-ons with a thriving
-   community. No licensing, and with a strong Python API to integrate into your
-   custom workflow.
- - Create complex spatial structures with multiple sites, buildings, facilities,
-   bridges, and building parts. Sites can be broken down into sub-sites and
-   multiple buildings per site. You can categorise different floors to different
-   buildings.
- - Classify any geometry as any IFC type. Just because it is a wall doesn't
-   mean you should be limited to modeling it in a certain way. Easily change
-   from one type to another, switch relationships and aggregations, reuse or
-   even remove geometry altogether, without damaging your geometry or breaking
-   your BIM model.
- - Use collections to create element compositions and decompositions with full
-   control over the classifications of their parts. Most BIM programs don't give
-   this flexibility. Create collection instances to efficiently duplicate
-   composite objects.
- - Allow BIM objects to instance a shared geometric representations. This allows
-   you to place the same shape in multiple objects without drastically
-   increasing your filesize.
- - Provide a custom value to any simple IFC attribute of an IFC product.
- - Create product types that regular IFC products can inherit attributes from.
- - Define your own property sets with control over exactly how the data in the
-   property sets are stored using property set template definitions which you
-   can download or create yourself. Property sets can apply to both types and
-   objects, and object property sets can selectively override type property
-   sets.
- - Applies array modifiers to create instances.
- - Basic quantity take-off support for costing.
- - Settings to toggle export of quantities or geometric representations.
-   Exporting IFC data without geometric representations is much faster and a
-   fraction of the filesize.
- - Maintain `GlobalId` between exports, so that you can manipulate the IFC
-   reliably in other software while making changes.
- - Not all objects need full solid geometry. Create representations as 2D or 3D
-   curves / wireframes for rapid and lightweight BIM development.
- - Create map conversions and coordinate reference system definitions to link
-   BIM to GIS.
- - Export basic materials with surface and diffuse colours for representation.
-   You can also link materials to an externally defined file, such as a `.blend`
-   Cycles material, V-Ray material, or even Radiance material for lighting
-   simulation.
- - Switch between different types of metric units when modeling.
- - Model multiple representations for different purposes for a single BIM
-   object or type, such as footprints, axis, reference, or clearance geometry.
-   You can export just the type of representation required for your usecase, or
-   export multiple for the user to choose from.
- - Record qualitative objectives such as design intentions, health and safety
-   strategies, or code compliance, performance solutions, and more, in the BIM
-   model and directly associate them to objects or types.
- - Classify objects and types to different classification systems such as
-   Uniclass, Omniclass, or your custom system.
- - Associate external document files such as plans, brochures, specifications,
-   warranties, or anything to objects and types.
- - Specify swept solid geometries, allowing you to round-trip geometry
-   manipulation with other BIM software which have more limited geometric tools,
-   like Revit.
- - Create material layer sets, for objects which have materials in predefined
-   layers with thicknesses.
- - Create material constituent sets, for objects which are made up of
-   arbitrarily mixed ingredients.
- - Specify nested and hosted element relationships.
- - Specify predefined door attributes as defined in the IFC4 specification.
- - Specify predefined window attributes as defined in the IFC4 specification.
- - Specify surface styles either defined as part of a material or assigned
-   directly to an object's representation.
- - Colour coding by IFC class to visually spot mistakes
-
-Some more experimental features:
-
- - Cut sections for documentation with OpenCascade
- - Export gbXML files that are linked to your IFC file to do energy analysis
- - QA module to generate Gherkin unit tests to validate your BIM models
- - HTML formatter to generate reports from QA results
- - COBie spreadsheet extraction to import into CAFM systems
-
-## Demo
-
-[See demo video](https://www.youtube.com/watch?v=iD3v3eu2AjY)
-
-It's only just started, so everything can and will change. But if you want to
-check it out:
-
- 1. Install [Blender](https://www.blender.org/) 64-bit version.
- 2. Download the latest packaged version of Blender BIM from
-    [here](https://blenderbim.org/builds/).
- 3. Launch Blender. Go to `Edit->Preferences->Add-ons->Install...`. Browse to
-    the downloaded `.zip` file from step 2.
- 4. Enable the checkbox next to the Import-Export IFC Blender plugin which will
-    show up.
- 5. All done! You will find an import and export IFC option in the `File` menu.
-
-By default, Blender BIM will export whatever you have selected. The objects you
-have selected _must_ belong in an `IfcProject` and spatially contained, such as
-witihn an `IfcBuilding`. It must also follow the naming convention. Please see
-the screenshot below for an example scene.
-
-A naming convention of `IfcClass/IfcName` is enforced. If you name your object
-`IfcWall/Foo`, it will turn into an `IfcWall` with the name attribute set to
-`Foo`. You can override object attributes using Blender's `Custom Properties`.
-Your objects must live in a top level `Collection` defined as a context class,
-usually something like `IfcProject/Foo`. You can then nest spatial structures
-underneath to create a hierarchy.
-
-## Pictures
-
-![UI](https://aws1.discourse-cdn.com/business6/uploads/buildingsmart1/original/1X/ce820c3ee22adcffae59b40f98ff23379f7e3547.png)
-
-![Blender screenshot](blender-screenshot.png)
-
-... this Blender files creates this IFC file ...
-
-![IfcOpenShell screenshot](ifcopenshell-screenshot.png)
+More information on the [BlenderBIM Add-on website](https://blenderbim.org).

src/blenderbim/blenderbim/__init__.py

@@ -34,7 +34,8 @@ bl_info = {
 if sys.modules.get("bpy", None):
     # Process *.pth in /libs/site/packages to setup globally importable modules
     # This is 3 levels deep as required by the static RPATH of ../../ from dependencies taken from Anaconda
-    site.addsitedir(os.path.join(os.path.dirname(os.path.realpath(__file__)), "libs", "site", "packages"))
+    # site.addsitedir(os.path.join(os.path.dirname(os.path.realpath(__file__)), "libs", "site", "packages"))
+    sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(__file__)), "libs", "site", "packages"))
 
     import blenderbim.bim
 

src/blenderbim/blenderbim/bim/__init__.py

@@ -17,8 +17,9 @@
 # along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
 
 import bpy
+import blenderbim
 import importlib
-from . import handler, ui, prop, operator
+from . import handler, ui, prop, operator, helper
 
 modules = {
     "project": None,
@@ -27,9 +28,11 @@ modules = {
     "root": None,
     "unit": None,
     "model": None,
+    "cad": None,
     "georeference": None,
     "context": None,
     "drawing": None,
+    "misc": None,
     "attribute": None,
     "type": None,
     "spatial": None,
@@ -42,6 +45,7 @@ modules = {
     "sequence": None,
     "group": None,
     "system": None,
+    "brick": None,
     "structural": None,
     "boundary": None,
     "profile": None,
@@ -52,42 +56,56 @@ modules = {
     "pset": None,
     "qto": None,
     "classification": None,
+    "library": None,
     "constraint": None,
     "document": None,
     "pset_template": None,
     "clash": None,
     "lca": None,
     "csv": None,
+    "tester": None,
     "bimtester": None,
     "diff": None,
     "patch": None,
+    "gis": None,
     "covetool": None,
     "augin": None,
     "debug": None,
+    "ifcgit": None,
+    # Uncomment this line to enable loading of the demo module. Happy hacking!
+    # The name "demo" must correlate to a folder name in `bim/module/`.
+    # "demo": None,
 }
 
+
 for name in modules.keys():
     modules[name] = importlib.import_module(f"blenderbim.bim.module.{name}")
 
+
 classes = [
-    operator.OpenUri,
-    operator.SelectDataDir,
-    operator.SelectSchemaDir,
-    operator.SelectIfcFile,
-    operator.ExportIFC,
-    operator.ImportIFC,
-    operator.OpenUpstream,
-    operator.AddSectionPlane,
-    operator.RemoveSectionPlane,
-    operator.ReloadIfcFile,
     operator.AddIfcFile,
+    operator.BIM_OT_add_section_plane,
+    operator.BIM_OT_remove_section_plane,
+    operator.ConfigureVisibility,
+    operator.OpenUpstream,
+    operator.OpenUri,
+    operator.ReloadIfcFile,
     operator.RemoveIfcFile,
-    operator.SetOverrideColour,
-    operator.SetViewportShadowFromSun,
-    operator.SnapSpacesTogether,
-    operator.OverrideDelete,
+    operator.SelectDataDir,
+    operator.SelectIfcFile,
+    operator.ReloadSelectedIfcFile,
+    operator.SelectSchemaDir,
+    operator.FileAssociate,
+    operator.FileUnassociate,
+    operator.SelectURIAttribute,
+    operator.EditBlenderCollection,
+    operator.BIM_OT_open_webbrowser,
+    operator.BIM_OT_show_description,
     prop.StrProperty,
+    operator.BIM_OT_enum_property_search,  # /!\ Register AFTER prop.StrProperty
+    prop.ObjProperty,
     prop.Attribute,
+    prop.ModuleVisibility,
     prop.BIMProperties,
     prop.IfcParameter,
     prop.PsetQto,
@@ -99,23 +117,33 @@ classes = [
     ui.BIM_UL_generic,
     ui.BIM_UL_topics,
     ui.BIM_ADDON_preferences,
+    # Scene panel groups
+    ui.BIM_PT_project_info,
+    ui.BIM_PT_project_setup,
+    ui.BIM_PT_collaboration,
+    ui.BIM_PT_selection,
+    ui.BIM_PT_geometry,
+    ui.BIM_PT_services,
+    ui.BIM_PT_structural,
+    ui.BIM_PT_4D5D,
+    ui.BIM_PT_quality_control,
+    ui.BIM_PT_integrations,
+    # Object panel groups
+    ui.BIM_PT_object_metadata,
+    ui.BIM_PT_geometry_object,
+    ui.BIM_PT_services_object,
+    ui.BIM_PT_utilities_object,
+    ui.BIM_PT_misc_object,
 ]
 
 for mod in modules.values():
     classes.extend(mod.classes)
 
 
-def menu_func_export(self, context):
-    self.layout.operator(operator.ExportIFC.bl_idname, text="Industry Foundation Classes (.ifc/.ifczip/.ifcjson)")
-
-
-def menu_func_import(self, context):
-    self.layout.operator(operator.ImportIFC.bl_idname, text="Industry Foundation Classes (.ifc/.ifczip/.ifcxml)")
-
-
 def on_register(scene):
     handler.setDefaultProperties(scene)
-    bpy.app.handlers.depsgraph_update_post.remove(on_register)
+    if not bpy.app.background:
+        bpy.app.handlers.depsgraph_update_post.remove(on_register)
 
 
 def register():
@@ -128,9 +156,7 @@ def register():
     bpy.app.handlers.redo_post.append(handler.redo_post)
     bpy.app.handlers.load_post.append(handler.setDefaultProperties)
     bpy.app.handlers.load_post.append(handler.loadIfcStore)
-    bpy.app.handlers.save_pre.append(handler.ensureIfcExported)
-    bpy.types.TOPBAR_MT_file_export.append(menu_func_export)
-    bpy.types.TOPBAR_MT_file_import.append(menu_func_import)
+    bpy.app.handlers.save_post.append(handler.ensureIfcExported)
     bpy.types.Scene.BIMProperties = bpy.props.PointerProperty(type=prop.BIMProperties)
     bpy.types.Object.BIMObjectProperties = bpy.props.PointerProperty(type=prop.BIMObjectProperties)
     bpy.types.Material.BIMObjectProperties = bpy.props.PointerProperty(type=prop.BIMObjectProperties)
@@ -140,6 +166,8 @@ def register():
     bpy.types.Camera.BIMMeshProperties = bpy.props.PointerProperty(type=prop.BIMMeshProperties)
     bpy.types.PointLight.BIMMeshProperties = bpy.props.PointerProperty(type=prop.BIMMeshProperties)
     bpy.types.SCENE_PT_unit.append(ui.ifc_units)
+    if hasattr(bpy.types, "UI_MT_button_context_menu"):
+        bpy.types.UI_MT_button_context_menu.append(ui.draw_custom_context_menu)
 
     for mod in modules.values():
         mod.register()
@@ -147,12 +175,14 @@ def register():
 
 def unregister():
     for cls in reversed(classes):
-        bpy.utils.unregister_class(cls)
+        if getattr(cls, "is_registered", None) is None:
+            bpy.utils.unregister_class(cls)
+        elif cls.is_registered:
+            bpy.utils.unregister_class(cls)
+
     bpy.app.handlers.load_post.remove(handler.setDefaultProperties)
     bpy.app.handlers.load_post.remove(handler.loadIfcStore)
-    bpy.app.handlers.save_pre.remove(handler.ensureIfcExported)
-    bpy.types.TOPBAR_MT_file_export.remove(menu_func_export)
-    bpy.types.TOPBAR_MT_file_import.remove(menu_func_import)
+    bpy.app.handlers.save_post.remove(handler.ensureIfcExported)
     del bpy.types.Scene.BIMProperties
     del bpy.types.Object.BIMObjectProperties
     del bpy.types.Material.BIMObjectProperties
@@ -162,6 +192,8 @@ def unregister():
     del bpy.types.Camera.BIMMeshProperties
     del bpy.types.PointLight.BIMMeshProperties
     bpy.types.SCENE_PT_unit.remove(ui.ifc_units)
+    if hasattr(bpy.types, "UI_MT_button_context_menu"):
+        bpy.types.UI_MT_button_context_menu.remove(ui.draw_custom_context_menu)
 
     for mod in reversed(list(modules.values())):
         mod.unregister()

src/blenderbim/blenderbim/bim/data/assets/default.css

@@ -0,0 +1,78 @@
+/*
+ * BlenderBIM Add-on - OpenBIM Blender Add-on
+ * Copyright (C) 2020, 2021 Dion Moult <dion@thinkmoult.com>
+ *
+ * This file is part of BlenderBIM Add-on.
+ *
+ * BlenderBIM Add-on is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * BlenderBIM Add-on is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+* { stroke-linecap: round; stroke-linejoin: round; }
+text, tspan { /* 2.5mm */ fill: black; stroke: none; font-family: 'OpenGost Type B TT', 'DejaVu Sans Condensed', 'Liberation Sans', 'Arial Narrow', 'Arial'; font-size: 4.13px; }
+.cut { fill: black; stroke: black; stroke-linecap: 'round'; stroke-width: 0.35; fill-rule: evenodd; }
+.projection { fill: white; stroke: black; stroke-linecap: 'round'; stroke-width: 0.25; }
+.surface { stroke: none; fill: #fff; fill-rule: evenodd; }
+.annotation { fill: none; stroke: black; stroke-linecap: 'round'; stroke-width: 0.25; }
+.IfcAnnotation { fill: none; stroke: black; stroke-linecap: 'round'; stroke-width: 0.25; }
+.IfcGeographicElement { fill: none; stroke: black; stroke-linecap: 'round'; stroke-width: 1; }
+.PredefinedType-LINEWORK { stroke: black; stroke-width: 0.25; }
+.PredefinedType-BACKGROUND { stroke: black; stroke-width: 0.18; }
+.PredefinedType-GRID { marker-start: url(#grid-marker); marker-end: url(#grid-marker); }
+.PredefinedType-SECTION { stroke-dasharray: 12.5, 3, 3, 3; }
+.PredefinedType-SECTIONLEVEL { marker-start: url(#section-level-marker); stroke-dasharray: 12.5, 3, 3, 3; }
+.PredefinedType-PLANLEVEL { marker-end: url(#plan-level-marker); }
+.PredefinedType-DIMENSION { marker-start: url(#dimension-marker-start); marker-end: url(#dimension-marker-end); }
+.PredefinedType-ANGLE { marker-start: url(#angle-marker-start); marker-end: url(#angle-marker-end); }
+.PredefinedType-RADIUS { marker-end: url(#fall-marker-end); }
+.PredefinedType-FALL { marker-end: url(#radius-marker-end); }
+.PredefinedType-SLOPEANGLE { marker-end: url(#radius-marker-end); }
+.PredefinedType-SLOPEPERCENT { marker-end: url(#radius-marker-end); }
+.PredefinedType-SLOPEFRACTION { marker-end: url(#radius-marker-end); }
+.PredefinedType-DIAMETER { marker-start: url(#diameter-marker-start); marker-end: url(#diameter-marker-end); }
+.PredefinedType-HIDDENLINE { stroke-dasharray: 3, 2; }
+.PredefinedType-STAIRARROW { marker-start: url(#stair-marker-start); marker-end: url(#stair-marker-end); }
+.PredefinedType-BOUNDARY { fill: none; stroke: red; stroke-width: 1; stroke-dasharray: 12, 4, 3, 4, 3, 4; }
+.PredefinedType-SEALANT { fill: url(#crosshatch1); stroke-width: 0.25; }
+.PredefinedType-FILLAREA { fill: white; stroke: black; }
+.PredefinedType-BREAKLINE { fill: none; stroke: black; stroke-width: 0.25; marker-mid: url(#breakline-marker); }
+.PredefinedType-TEXT { fill: black; stroke: none; }
+path.PredefinedType-TEXTLEADER { marker-end: url(#leader-marker); }
+text.PredefinedType-TEXTLEADER, tspan.PredefinedType-TEXTLEADER { fill: black; stroke: none; }
+text.title, tspan.title { /* 7mm */ font-size: 11.55px; }
+text.header, tspan.header { /* 5mm */ font-size: 8.25px; }
+text.large, tspan.large { /* 3.5mm */ font-size: 5.78px; }
+text.regular, tspan.regular { /* 2.5mm */ font-size: 4.13px; }
+text.small, tspan.small { /* 1.8mm */ font-size: 2.97px; }
+text.GRID, tspan.GRID { /* 5mm */ font-size: 8.25px; }
+.material-blank { fill: white; }
+.material-diagonal1 { fill: url(#diagonal1); }
+.material-diagonal2 { fill: url(#diagonal2); }
+.material-diagonal3 { fill: url(#diagonal3); }
+.material-crosshatch1 { fill: url(#crosshatch1); }
+.material-crosshatch2 { fill: url(#crosshatch2); }
+.material-crosshatch3 { fill: url(#crosshatch3); }
+.material-brick { fill: url(#brick); }
+.material-earth { fill: url(#earth); }
+.material-glass { fill: url(#glass); }
+.material-liquid { fill: url(#liquid); }
+.material-grass { fill: url(#grass); }
+.material-honeycomb { fill: url(#honeycomb); }
+.material-sand { fill: url(#sand); }
+.material-concrete { fill: url(#concrete); stroke-width: 0.5; }
+.IfcSpace { fill: none; stroke: none; }
+.PredefinedType-STUD { stroke: black; stroke-width: 1; }
+.PredefinedType-WOOD { fill: url(#wood); stroke: black; stroke-width: 0.5; }
+.PredefinedType-STEEL { fill: url(#steel); stroke: black; stroke-width: 0.5; }
+.PredefinedType-CONCRETE { fill: url(#concrete); stroke: black; stroke-width: 0.5; }
+.PredefinedType-PLASTERBOARD { fill: url(#sand); stroke: black; stroke-width: 0.25; }

src/blenderbim/blenderbim/bim/data/assets/markers.svg

@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <svg baseProfile="full" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:ev="http://www.w3.org/2001/xml-events" xmlns:xlink="http://www.w3.org/1999/xlink">
+        <!-- Tip: https://svg-path-visualizer.netlify.app/ -->
+        <!-- Tip: https://www.svgviewer.dev/ -->
     <marker id="eng-dimension-marker-start" markerHeight="14" markerWidth="11" orient="auto" refX="1" refY="7">
         <g>
             <path d="M 11 3.5 L 11 10.5 L 1 7" class="annotation" style="fill:black;" />
@@ -12,6 +14,41 @@
             <path d="M 10 0 L 10 14" class="annotation" style="stroke-width:1;" />
         </g>
     </marker>
+    <marker id="radius-marker-end" markerHeight="14" markerWidth="11" orient="auto" refX="10" refY="7">
+        <g>
+            <path d="M 0 3.5 L 0 10.5 L 10 7" class="annotation" style="fill:black;" />
+        </g>
+    </marker>
+    <!-- same as for the radius -->
+    <marker id="fall-marker-end" markerHeight="14" markerWidth="11" orient="auto" refX="10" refY="7">
+        <g>
+            <path d="M 0 3.5 L 0 10.5 L 10 7" class="annotation" style="fill:black;" />
+        </g>
+    </marker>
+    <marker id="angle-marker-start" markerHeight="14" markerWidth="11" orient="auto" refX="1" refY="7">
+        <g>
+            <path d="M 11 3.5 L 11 10.5 L 1 7" class="annotation" style="fill:black;" />
+            <path d="M 1 0 L 1 14" class="annotation" style="stroke-width:1;" />
+        </g>
+    </marker>
+    <marker id="angle-marker-end" markerHeight="14" markerWidth="11" orient="auto" refX="10" refY="7">
+        <g>
+            <path d="M 0 3.5 L 0 10.5 L 10 7" class="annotation" style="fill:black;" />
+            <path d="M 10 0 L 10 14" class="annotation" style="stroke-width:1;" />
+        </g>
+    </marker>
+    <marker id="diameter-marker-start" markerHeight="14" markerWidth="11" orient="auto" refX="1" refY="7">
+        <g>
+            <path d="M 11 3.5 L 11 10.5 L 1 7" class="annotation" style="fill:black;" />
+            <path d="M 1 0 L 1 14" class="annotation" style="stroke-width:1;" />
+        </g>
+    </marker>
+    <marker id="diameter-marker-end" markerHeight="14" markerWidth="11" orient="auto" refX="10" refY="7">
+        <g>
+            <path d="M 0 3.5 L 0 10.5 L 10 7" class="annotation" style="fill:black;" />
+            <path d="M 10 0 L 10 14" class="annotation" style="stroke-width:1;" />
+        </g>
+    </marker>
     <marker id="dimension-marker-start" markerHeight="30" markerWidth="20" refX="10" refY="15" orient="auto">
         <g>
             <path d="M 0 15 L 20 15" class="annotation" style="stroke-width:1;" />
@@ -53,10 +90,18 @@
             <path d="M 0 1 L 90 1" class="annotation" style="stroke-width:1;" />
         </g>
     </marker>
-    <marker id="breakline-marker" markerHeight="20" markerWidth="15" refX="7.5" refY="10">
+    <marker id="breakline-marker" markerHeight="20" markerWidth="15" refX="7.5" refY="10" orient="auto">
         <g>
             <path d="M 0 10 L 5 20 L 7.5 10" class="annotation" style="stroke-width:1; fill: white;" />
             <path d="M 7.5 10 L 10 0 L 15 10" class="annotation" style="stroke-width:1; fill: white;" />
         </g>
     </marker>
+    <filter x="0" y="0" width="1" height="1" id="fill-background">
+      <feFlood flood-color="white" result="bg" />
+      <feMerge>
+        <feMergeNode in="bg"/>
+        <feMergeNode in="SourceGraphic"/>
+      </feMerge>
+    </filter>
+
 </svg>

src/blenderbim/blenderbim/bim/data/assets/patterns.svg

@@ -3,6 +3,10 @@
 <pattern id="demolish" width="1" height="1" patternTransform="rotate(45 0 0)" patternUnits="userSpaceOnUse">
     <line x1="0" y1="0" x2="0" y2="1" style="stroke:red; stroke-width:0.25" />
 </pattern>
+<pattern id="steel" width="3" height="1" patternTransform="rotate(45 0 0)" patternUnits="userSpaceOnUse">
+    <line x1="0" y1="0" x2="0" y2="1" style="stroke:black; stroke-width:0.25" />
+    <line x1="1" y1="0" x2="1" y2="1" style="stroke:black; stroke-width:0.25" />
+</pattern>
 <pattern id="diagonal1" width="1" height="1" patternTransform="rotate(45 0 0)" patternUnits="userSpaceOnUse">
     <line x1="0" y1="0" x2="0" y2="1" style="stroke:black; stroke-width:0.25" />
 </pattern>
@@ -13,16 +17,49 @@
     <line x1="0" y1="0" x2="0" y2="3" style="stroke:black; stroke-width:0.25" />
 </pattern>
 <pattern id="square1" width="1" height="1" patternUnits="userSpaceOnUse">
-    <line x1="0" y1="0" x2="0" y2="1" style="stroke:black; stroke-width:0.25" />
-    <line x1="0" y1="0" x2="1" y2="0" style="stroke:black; stroke-width:0.25" />
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 1 0 1 1" />
 </pattern>
 <pattern id="square2" width="2" height="2" patternUnits="userSpaceOnUse">
-    <line x1="0" y1="0" x2="0" y2="2" style="stroke:black; stroke-width:0.25" />
-    <line x1="0" y1="0" x2="2" y2="0" style="stroke:black; stroke-width:0.25" />
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 2 0 2 2" />
 </pattern>
 <pattern id="square3" width="3" height="3" patternUnits="userSpaceOnUse">
-    <line x1="0" y1="0" x2="0" y2="3" style="stroke:black; stroke-width:0.25" />
-    <line x1="0" y1="0" x2="3" y2="0" style="stroke:black; stroke-width:0.25" />
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 3 0 3 3" />
+</pattern>
+<pattern id="recth1" width="2" height="1" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 2 0 2 1" />
+</pattern>
+<pattern id="recth2" width="4" height="2" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 4 0 4 2" />
+</pattern>
+<pattern id="recth3" width="6" height="3" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 6 0 6 3" />
+</pattern>
+<pattern id="rectv1" width="1" height="2" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 1 0 1 2" />
+</pattern>
+<pattern id="rectv2" width="2" height="4" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 2 0 2 4" />
+</pattern>
+<pattern id="rectv3" width="3" height="6" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.25; fill: none;" d="M 0 0 3 0 3 6" />
+</pattern>
+<pattern id="tile1" width="2" height="2" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.15; fill: none;" d="M 0 0 2 0 2 1 0 1 M 1 1 1 2" />
+</pattern>
+<pattern id="tile2" width="4" height="4" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.15; fill: none;" d="M 0 0 4 0 4 2 0 2 M 2 2 2 4" />
+</pattern>
+<pattern id="tile3" width="6" height="6" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.15; fill: none;" d="M 0 0 6 0 6 3 0 3 M 3 3 3 6" />
+</pattern>
+<pattern id="board1" width="4" height="2" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.15; fill: none;" d="M 0 0 4 0 4 1 0 1 M 2 1 2 2" />
+</pattern>
+<pattern id="board2" width="8" height="4" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.15; fill: none;" d="M 0 0 8 0 8 2 0 2 M 4 2 4 4" />
+</pattern>
+<pattern id="board3" width="12" height="6" patternUnits="userSpaceOnUse">
+    <path style="stroke: black; stroke-width: 0.15; fill: none;" d="M 0 0 12 0 12 3 0 3 M 6 3 6 6" />
 </pattern>
 <pattern id="crosshatch1" width="1" height="1" patternTransform="rotate(45 0 0)" patternUnits="userSpaceOnUse">
     <line x1="0" y1="0" x2="0" y2="1" style="stroke:black; stroke-width:0.25" />
@@ -80,6 +117,9 @@
     <path d="M 1.25,2.165 L 2.5,4.33 L 5,4.33 L 6.25,2.165 L 5,0 L 2.5,0 L 1.25,2.165" style="stroke:black;stroke-width:0.25;stroke-linecap:round;fill:none" />
     <path d="M 6.25,2.165 L 7.5,2.165" style="stroke:black;stroke-width:0.25;stroke-linecap:round" />
 </pattern>
+<pattern id="wood" width="50" height="50" patternUnits="userSpaceOnUse">
+    <path style="fill:none; stroke: black; stroke-width:0.25;" d="M 49.649999,1.3460737 A 69.019995,69.019995 0 0 0 48.653938,0.34999949 M 49.649999,4.9389583 A 66.554994,66.554994 0 0 0 45.06105,0.34999949 M 49.649999,8.6983527 A 64.089999,64.089999 0 0 0 41.301656,0.34999949 M 49.649999,12.675003 A 61.624998,61.624998 0 0 0 37.325,0.34999949 M 49.649999,16.948067 A 59.159997,59.159997 0 0 0 33.05192,0.34999949 M 49.649999,21.652972 A 56.694997,56.694997 0 0 0 28.347017,0.34999949 M 49.649999,27.057906 A 54.229999,54.229999 0 0 0 22.942096,0.34999949 M 49.649999,33.866298 A 51.764998,51.764998 0 0 0 16.1337,0.34999949 M 49.649999,49.649989 A 49.299997,49.299997 0 0 0 0.34999949,0.34999949 M 47.185,49.649989 A 46.834999,46.834999 0 0 0 0.34999949,2.8149951 M 44.72,49.649989 A 44.369998,44.369998 0 0 0 0.34999949,5.2799906 M 42.254999,49.649989 A 41.904997,41.904997 0 0 0 0.34999949,7.7450123 M 39.790001,49.649989 A 39.439999,39.439999 0 0 0 0.34999949,10.210008 M 37.325,49.649989 A 36.974998,36.974998 0 0 0 0.34999949,12.675003 M 34.859999,49.649989 A 34.509998,34.509998 0 0 0 0.34999949,15.139998 M 32.395001,49.649989 A 32.044999,32.044999 0 0 0 0.34999949,17.604994 M 29.93,49.649989 A 29.579999,29.579999 0 0 0 0.34999949,20.069989 M 27.465,49.649989 A 27.114998,27.114998 0 0 0 0.34999949,22.535011 M 24.999997,49.649989 A 24.649999,24.649999 0 0 0 0.34999949,25.000007 M 22.534998,49.649989 A 22.184999,22.184999 0 0 0 0.34999949,27.465003 M 20.069998,49.649989 A 19.719999,19.719999 0 0 0 0.34999949,29.929999 M 17.604998,49.649989 A 17.254999,17.254999 0 0 0 0.34999949,32.394994 M 15.139998,49.649989 A 14.789999,14.789999 0 0 0 0.34999949,34.85999 M 12.674999,49.649989 A 12.325,12.325 0 0 0 0.34999949,37.325011 M 10.209999,49.649989 A 9.8599994,9.8599994 0 0 0 0.34999949,39.790007 M 7.7449994,49.649989 A 7.3949999,7.3949999 0 0 0 0.34999949,42.255002 M 5.2799992,49.649989 A 4.9299997,4.9299997 0 0 0 0.34999949,44.719998 M 2.8149995,49.649989 A 2.4649999,2.4649999 0 0 0 0.34999949,47.184993 M 0.34999949,49.649989 H 3.8010003 M 0.34999949,49.649989 H 3.8010003 M 0.34999949,49.649989 H 3.8010003" />
+</pattern>
 <pattern id="sand" width="50" height="50" patternUnits="userSpaceOnUse">
     <path style="fill: white;" d="M 0 0 50 0 50 50 0 50" />
     <path

src/blenderbim/blenderbim/bim/data/assets/symbols.svg

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<svg baseProfile="full" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:ev="http://www.w3.org/2001/xml-events" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <g id="rectangle-tag">
+        <rect x="-6" y="-2.5" width="12" height="5" fill="white" stroke="black" style="stroke-width: 0.25;" />
+    </g>
+    <g id="triangle-tag">
+        <path style="fill: white; stroke: black; stroke-width: 0.25;" d="M 3.1409425e-7,-7.1069207 5.7650623,2.8784603 l -11.5301246,-6e-7 z" />
+    </g>
+    <g id="hexagon-tag">
+        <path style="fill: white; stroke: black; stroke-width: 0.25;" d="m 0.0161133,-6.0583333 5.2339915,3.8366023 -2.031433,6.1633977 c 0,0 -6.4894866,-0.027414 -6.4894866,-0.027414 l -1.97929,-6.1803395 5.2662181,-3.7922467" />
+    </g>
+    <g id="capsule-tag">
+        <rect x="-6" y="-2.5" width="12" height="5" rx="2.5" ry="2.5" fill="white" stroke="black" style="stroke-width: 0.25;" />
+    </g>
+    <g id="circle-tag">
+        <circle r="5" fill="white" stroke="black" style="stroke-width: 0.25;" />
+    </g>
+    <g id="door-tag">
+        <circle r="5" fill="white" stroke="black" style="stroke-width: 0.25;" />
+        <text y="-1.75" class="regular" text-anchor="middle" dominant-baseline="middle" data-type="text-template"></text>
+        <line x1="-5" x2="5" style="stroke: black; stroke-width: 0.25;" />
+        <text y="2.5" class="regular" text-anchor="middle" dominant-baseline="middle" data-type="text-template"></text>
+    </g>
+    <g id="space-tag">
+        <text y="-5" class="large" text-anchor="middle" dominant-baseline="middle" data-type="text-template"></text>
+        <rect x="-6" y="-2.5" width="12" height="5" fill="white" stroke="black" style="stroke-width: 0.25;" />
+        <text class="regular" text-anchor="middle" dominant-baseline="middle" data-type="text-template"></text>
+        <text y="5" class="regular" text-anchor="middle" dominant-baseline="middle" data-type="text-template"></text>
+    </g>
+    <g id="elevation-arrow">
+        <path style="fill: black;" d="M -7.07106 0 0 -7.07106 7.07106 0" />
+    </g>
+    <g id="elevation-tag">
+        <circle r="5" fill="white" stroke="black" style="stroke-width: 0.25;" />
+        <line x1="-5" y1="0" x2="5" y2="0" style="stroke: black; stroke-width: 0.25;" />
+    </g>
+    <g id="section-arrow">
+        <path style="fill: black;" d="M -7.07106 0 0 -7.07106 7.07106 0" />
+    </g>
+    <g id="section-tag">
+        <circle r="5" fill="white" stroke="black" style="stroke-width: 0.25;" />
+        <line x1="-5" y1="0" x2="5" y2="0" style="stroke: black; stroke-width: 0.25;" />
+    </g>
+</svg>

src/blenderbim/blenderbim/bim/data/assets/view-title.svg

@@ -70,7 +70,7 @@
          style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.96055365px;font-family:'OpenGost Type B TT';-inkscape-font-specification:'OpenGost Type B TT';text-align:center;text-anchor:middle;stroke-width:0.26458332px"
          y="103.10933"
          x="32.822662"
-         id="tspan857">{{no}}</tspan></text>
+         id="tspan857">{{Identification}}</tspan></text>
     <text
        xml:space="preserve"
        style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:17.71626091px;line-height:125%;font-family:Arial;-inkscape-font-specification:Arial;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458329px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
@@ -80,7 +80,7 @@
          id="tspan861"
          x="39.12896"
          y="100.19173"
-         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.54325247px;font-family:'OpenGost Type B TT';-inkscape-font-specification:'OpenGost Type B TT';text-align:start;text-anchor:start;stroke-width:0.26458329px">{{name}}</tspan></text>
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.54325247px;font-family:'OpenGost Type B TT';-inkscape-font-specification:'OpenGost Type B TT';text-align:start;text-anchor:start;stroke-width:0.26458329px">{{Name}}</tspan></text>
     <text
        id="text867"
        y="105.0553"
@@ -90,6 +90,6 @@
          style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.54325247px;font-family:'OpenGost Type B TT';-inkscape-font-specification:'OpenGost Type B TT';text-align:start;text-anchor:start;stroke-width:0.26458332px"
          y="105.0553"
          x="39.285267"
-         id="tspan865">{{scale}}</tspan></text>
+         id="tspan865">{{Scale}}</tspan></text>
   </g>
 </svg>