removed unnecessary code

Co-authored-by: Bruno Perdigão <57102715+brunoperdigao@users.noreply.github.com>

.github/workflows/cd.yml

@@ -16,7 +16,7 @@ jobs:
     - run: echo ok go
 
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     needs: activate
     steps:
     - uses: actions/checkout@v2
@@ -29,7 +29,7 @@ jobs:
         sudo apt-get install --no-install-recommends \
         git cmake gcc g++ libboost-all-dev python3-all-dev swig libpcre3-dev libxml2-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
+        libhdf5-dev libcgal-dev nlohmann-json3-dev
 
     -
       name: ccache
@@ -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
@@ -78,7 +80,7 @@ jobs:
         path: build/assets/Ifc*
 
   deliver:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     needs: build
     name: Docker Build, Tag, Push
 

.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-pypi.yml

@@ -0,0 +1,57 @@
+name: ci-bcf-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-bcf-pypi.yml'
+  workflow_dispatch:
+
+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 # https://github.com/actions/checkout
+      - 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/bcf &&
+          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/bcf/dist

.github/workflows/ci-bcf.yml

@@ -1,38 +0,0 @@
-name: ci-bcf
-
-on:
-  push:
-
-jobs:
-  activate:
-    runs-on: ubuntu-latest
-    if: |
-      github.repository == 'IfcOpenShell/IfcOpenShell' &&
-      contains(github.event.head_commit.message, '[bcf release]')
-    steps:
-      - run: echo ok go
-  upload:
-    needs: activate
-    name: Upload BCF package to Pypi
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: '3.x'
-      - name: Build package
-        run: |
-          cd src/bcf
-          pip install build
-          python -m build
-      - 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

@@ -43,7 +43,7 @@ jobs:
       - 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
+          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 }}
 

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

@@ -39,7 +39,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        pyver: [py37, py39, py310]
+        pyver: [py39, py310, py311]
         config:
           - {
             name: "Windows Build",
@@ -61,8 +61,8 @@ jobs:
       - 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.11'
       - run: echo ${{ env.DATE }}
       - name: Get current date
         id: date

.github/workflows/ci-bsdd-pypi.yaml

@@ -0,0 +1,48 @@
+name: ci-bsdd-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 * *"
+  workflow_dispatch:
+
+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
+    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.11' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+      - name: Compile
+        run: |
+          pip install build
+          cd src/bsdd &&
+          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/bsdd/dist

.github/workflows/ci-ifcclash-pypi.yaml

@@ -0,0 +1,48 @@
+name: ci-ifcclash-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 * *"
+  workflow_dispatch:
+
+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
+    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.11' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+      - name: Compile
+        run: |
+          pip install build
+          cd src/ifcclash &&
+          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/ifcclash/dist

.github/workflows/ci-ifccsv-pypi.yaml

@@ -0,0 +1,48 @@
+name: ci-ifccsv-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 * *"
+  workflow_dispatch:
+
+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
+    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.11' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+      - name: Compile
+        run: |
+          pip install build
+          cd src/ifccsv &&
+          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/ifccsv/dist

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

@@ -1,23 +1,19 @@
 name: ci-ifcopenshell-conda-daily
 
 on:
-  workflow_run:
-    workflows: ["ci"]
-    types:
-      - completed
+  workflow_dispatch:
+  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
+    name: ${{ matrix.platform.distver }}-${{ matrix.pyver.name }}-${{ matrix.variant }}
     runs-on: ${{ matrix.platform.distver }}
     defaults:
       run:
@@ -26,21 +22,23 @@ jobs:
       fail-fast: false
       matrix:
         pyver: [
-          { name: py39, distver: '3.9' },
-          { name: py310, distver: '3.10'}
+          { name: py311, distver: '3.11'},
+          { name: py312, distver: '3.12'}
         ]
         platform: [
-          { name: Windows, distver: windows-2022, upload: 'false' },
-          { name: Windows, distver: windows-2019, upload: 'true' },
-          { name: Linux, distver: ubuntu-20.04,  upload: 'false' },
-          { name: Linux, distver: ubuntu-18.04,  upload: 'true' },
-          { name: macOS, distver: macos-11, upload: 'true' },
-          { name: macOS, distver: macos-10.15, upload: 'false' }
+          { name: Windows, distver: windows-2022, upload: 'true' },
+          { name: Linux, distver: ubuntu-22.04,  upload: 'true' },
+          { name: macOS, distver: macos-12, upload: 'true' }
+        ]
+        variant: [
+          'novtk',
+#          'all'
         ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: recursive
+
       - name: Download MacOSX SDK
         if: ${{ matrix.platform.name == 'macOS' }}
         run: |
@@ -48,17 +46,22 @@ jobs:
           tar xf MacOSX10.13.sdk.tar.xz && \
           sudo mv -v MacOSX10.13.sdk /opt/ && \
           ls /opt/
-      - uses: seanmiddleditch/gha-setup-ninja@master
-      - uses: conda-incubator/setup-miniconda@v2  # https://github.com/conda-incubator/setup-miniconda
+
+      - uses: mamba-org/setup-micromamba@v1 # https://github.com/mamba-org/setup-micromamba
         with:
-          activate-environment: conda-build
-          python-version: ${{ matrix.pyver.distver }}
-          environment-file: conda/environment.yml
+          environment-name: build-env
+          cache-environment: true
+          condarc: |
+            channels:
+              - conda-forge
+            channel_priority: strict
+          create-args: >-
+            python=3.11
+            anaconda-client
+            boa
+
       - 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 --no-remove-work-dir
-      - name: build & test ifcopenshell
-        if: ${{ matrix.platform.upload == 'false' }}
-        run: |
-          conda-build . --python ${{ matrix.pyver.distver }} -c conda-forge --no-remove-work-dir
+          conda mambabuild . --python ${{ matrix.pyver.distver }} -c conda-forge --variants "{variant: ${{ matrix.variant }}}" --token ${{ secrets.ANACONDA_TOKEN }} --user ifcopenshell
+        working-directory: ./conda

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

@@ -1,6 +1,7 @@
 name: ci-ifcopenshell-pypi
 
 on:
+  workflow_dispatch:
   schedule:
     #         ┌───────────── minute (0 - 59)
     #         │  ┌───────────── hour (0 - 23)
@@ -8,7 +9,11 @@ on:
     #         │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
     #         │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
     #         *  * * * *
-    - cron: "49 23 1 * *" # 11min before utc midnight
+    - cron: "0 0 18 * *"
+  push:
+    paths:
+      - '.github/workflows/ci-ifcopenshell-pypi.yml'
+
 
 env:
   major: 0
@@ -31,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        pyver: [py36, py37, py38, py39, py310]
+        pyver: [py39, py310, py311, py312]
         config:
           - {
             name: "Windows Build",
@@ -53,7 +58,7 @@ jobs:
       - 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
+          python-version: '3.11' # 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

.github/workflows/ci-ifcpatch-pypi.yaml

@@ -0,0 +1,48 @@
+name: ci-ifcpatch-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 * *"
+  workflow_dispatch:
+
+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
+    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.11' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+      - name: Compile
+        run: |
+          pip install build
+          cd src/ifcpatch &&
+          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/ifcpatch/dist

.github/workflows/ci-ifcsverchok-build.yml

@@ -0,0 +1,53 @@
+name: Publish-ifcsverchok
+
+on:
+  push:
+    paths:
+      - '.github/workflows/ci-ifcsverchok-build.yml'
+      - 'src/ifcsverchok/*'
+    branches:
+      - v0.7.0
+
+env:
+  major: 0
+  minor: 0
+  name: ifcsverchok
+
+jobs:
+  activate:
+    runs-on: ubuntu-latest
+    if: |
+      github.repository == 'IfcOpenShell/IfcOpenShell'
+    steps:
+    - name: Set env
+      run: echo ok go
+
+  build:
+    needs: activate
+    name: ifcsverchok
+    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:
+          architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+          python-version: '3.11'
+      - run: echo ${{ env.DATE }}
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%y%m%d')"
+      - name: Compile
+        run: |
+          cd src/ifcsverchok
+          make dist
+      - name: Upload Zip file to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: src/ifcsverchok/dist/ifcsverchok-${{steps.date.outputs.date}}.zip
+          asset_name: ifcsverchok-${{steps.date.outputs.date}}.zip
+          tag: "ifcsverchok-${{steps.date.outputs.date}}"
+          overwrite: true
+          body: "ifcsverchok build for ${{steps.date.outputs.date}}"

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

@@ -0,0 +1,48 @@
+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 * *"
+  workflow_dispatch:
+
+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
+    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.11' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+      - 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

@@ -1,95 +0,0 @@
-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
-
-      - name: Build ifcopenshell
-        run: |
-          mkdir build && cd build
-          cmake \
-               -DCMAKE_C_COMPILER_LAUNCHER=ccache \
-               -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
-               -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" \
-               -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 numpy lxml
-          sudo /usr/bin/python -m pip install src/bcf
-          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
-
-      - 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

@@ -31,12 +31,25 @@ jobs:
       - run: echo ok go
 
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     needs: activate
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
             submodules: recursive
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install xmlschema xsdata numpy lxml pytest isodate lark networkx tabulate python-dateutil
+          pip install src/bcf --no-deps
+          pip install https://github.com/Andrej730/aud/archive/refs/heads/master-reduced-size.zip
+
       - name: Install C++ dependencies
         run: |
           sudo apt update
@@ -49,7 +62,6 @@ jobs:
           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 \
@@ -57,9 +69,14 @@ jobs:
           
       - name: ccache
         uses: hendrikmuhs/ccache-action@v1
+        with:
+          key: ${GITHUB_WORKFLOW}
 
       - name: Build ifcopenshell
         run: |
+          echo $Python3_ROOT_DIR
+          echo ${{ env.pythonLocation }}
+          
           mkdir build && cd build
           cmake \
                -DCMAKE_C_COMPILER_LAUNCHER=ccache \
@@ -69,11 +86,11 @@ jobs:
                -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 \
+               -DPYTHON_EXECUTABLE:FILEPATH=${{ env.pythonLocation }}/bin/python \
+               -DPYTHON_INCLUDE_DIR:PATH=${{ env.pythonLocation }}/include/python3.11 \
+               -DPYTHON_LIBRARY:FILEPATH=${{ env.pythonLocation }}/lib/libpython3.11.so \
                -DCOLLADA_SUPPORT=Off \
-               "-DSCHEMA_VERSIONS=2x3;4;4x3" \
+               "-DSCHEMA_VERSIONS=2x3;4;4x3_add1" \
                -DGLTF_SUPPORT=On \
                -DJSON_INCLUDE_DIR=/usr/include \
                -DCGAL_INCLUDE_DIR=/usr/include \
@@ -86,20 +103,25 @@ jobs:
           sudo make -j $(nproc)
           sudo make install
 
-      - name: Install Python dependencies
+      - name: Run IfcConvert on Sample files
         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 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
+          (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: Test
+
+      - name: Test ifcopenshell-python
         run: |
           cd test
-          sudo /usr/bin/python tests.py
+          python tests.py
           cd ../src/ifcopenshell-python
           mv ifcopenshell ifcopenshell-local # Force testing on installed module
-          make test
+          make test-safe

.gitignore

@@ -7,34 +7,26 @@
 
 # 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
+
 # General Python residue
 __pycache__
 *.py.bak
+
 # Visual Studio Code files
 .vscode
 .vs
+
 # PyCharm files
 .idea
 
-#Virtual Env Files
-Pipfile
-Pipfile.lock
-
 # Docs
-/docs/output
-/docs/rst_files
-/docs/doxygen
-/src/ifcblenderexport/docs/_build
+/docs/cpp-api/output
 
 # gettext binary translation files
 *.mo
@@ -73,3 +65,39 @@ _build/
 
 # IDS Docs
 src/ifcopenshell-python/test/build
+
+# tox cache
+.tox/
+*.egg-info/
+
+# mypy cache
+.mypy_cache
+
+# blenderbim libs
+src/blenderbim/blenderbim/libs
+
+# blenderbim i18n
+src/blenderbim/blenderbim/translations.py
+
+# blenderbim test temp files
+src/blenderbim/test/files/temp
+src/blenderbim/test/files/basic.ifc.cache.blend
+src/blenderbim/test/files/basic.ifc.cache.sqlite
+
+src/blenderbim/drawings
+src/blenderbim/layouts
+
+# ifcopenshell swig and compiled files
+src/ifcopenshell-python/ifcopenshell/_ifcopenshell_wrapper.so
+src/ifcopenshell-python/ifcopenshell/ifcopenshell_wrapper.py
+
+# apple
+.DS_Store
+
+# clangd config
+.clangd
+# clangd cache
+.cache
+
+# Brickschema
+src/blenderbim/blenderbim/bim/schema/Brick.ttl

.gitmodules

@@ -10,4 +10,7 @@
 	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
+	url = https://github.com/IfcOpenShell/ids-test-files
+[submodule "docs/cpp-api/assets/doxygen-awesome-css"]
+	path = docs/cpp-api/assets/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git

.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

@@ -27,7 +27,7 @@ RUN echo "deb http://archive.ubuntu.com/ubuntu focal-proposed main restricted" |
                     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 ; \
+                    libhdf5-serial-dev python3-pytest ; \
     rm -rf /var/lib/apt/lists/* ; 
 
 COPY . /home/IfcOpenShell/

README.md

@@ -1,330 +1,83 @@
+
 IfcOpenShell 
 ============
-IfcOpenShell is an open source ([LGPL]) software library for working with the Industry Foundation Classes ([IFC]) 
-file format. Extensive geometric support is implemented for the IFC releases [IFC2x3 TC1] and [IFC4 Add2 TC1].
-Support for parsing is provided for IFC4x1, IFC4x2, and the IFC4x3 release candidates. Extending with support for
-arbitrary IFC schemas is possible at compile-time when using C++ and at run-time when using Python.
 
-For more information, see
-* [http://ifcopenshell.org](http://ifcopenshell.org)  
-* [http://academy.ifcopenshell.org](http://academy.ifcopenshell.org)
+<p align="center">
+<img src="https://github.com/IfcOpenShell/IfcOpenShell/assets/88302/34901387-e2dd-4a0c-8e38-9ffc32a66cde">
+</p>
+
+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, IFC4x2, and [IFC4x3 Add2]. 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.
+
+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.
+
+For more information, see:
+
+* [IfcOpenShell Website](http://ifcopenshell.org)
+* [IfcOpenShell Documentation](https://docs.ifcopenshell.org)
+  * [IfcOpenShell C++ Installation](https://docs.ifcopenshell.org/ifcopenshell/installation.html)
+  * [IfcOpenShell Python Installation](https://docs.ifcopenshell.org/ifcopenshell-python/installation.html)
+  * [IfcOpenShell Python Hello World Tutorial](https://docs.ifcopenshell.org/ifcopenshell-python/hello_world.html)
+* [BlenderBIM Add-on Website](https://blenderbim.org)
+* [BlenderBIM Add-on Documentation](https://docs.blenderbim.org/index.html)
+  * [Add-on Installation](https://docs.blenderbim.org/users/installation.html)
+  * [Exploring an IFC model](https://docs.blenderbim.org/users/exploring_an_ifc_model.html)
 
 | 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                           | [![AUR Badge](https://img.shields.io/aur/version/ifcopenshell-git)](https://aur.archlinux.org/packages/ifcopenshell-git)                     |
+| 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)                 |
 
-Prerequisites
--------------
-* Git
-* CMake (3.1.3 or newer)
-* Windows: [Visual Studio] 2008 to 2019 (2022 not yet supported by dependency CMake) with C++ toolset (or [Visual C++ Build Tools]) or [MSYS2] + MinGW
-* *nix: GCC 4.7 or newer, or Clang (any version)
-
-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 tessellated 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.
-
-Building IfcOpenShell
----------------------
-
-Note 1: 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.
-
-Note 2: If you had not used `git clone --recursive https://github.com/IfcOpenShell/IfcOpenshell.git`, update the submodules by running `git submodule init & git submodule update`.
-
-Note 3: Be careful with special characters is the path when using the nix or win build scripts, because the OpenCASCADE build will fail on paths containing ++ and likely other situations.
-
-### 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 1: It is recommended to use OCCT for IfcOpenShell. You could use OCE as well, but sometimes it may lag behind OCCT and 
-therefore not compile with the latest IfcOpenShell.
-
-Note 2: 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 libcgal-dev
-
-**2a)** Either use an OCCT package from your operating system's software repository
-
-    $ sudo apt-get install libocct-data-exchange-dev libocct-draw-dev libocct-foundation-dev libocct-modeling-algorithms-dev libocct-modeling-data-dev libocct-ocaf-dev libocct-visualization-dev
-
-**2b)** or, if OCCT is not available or the latest code is wanted, obtain and compile OCCT from https://dev.opencascade.org/release
-
-**2c)** or, if you'd like to try using OCE, use the 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
-
-**2d)** or if OCE is 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
-
-**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/ \
-          -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_SUPPORT=Off
-    $ 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 cmake python3 cgal ftgl gmp libaec opencascade swig hdf5 zlib
-# homebrew automatically links most libraries, except some keg-only ones
-$ brew link zlib --force
-```
-
-**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/``) for Intel machines with x84_64 architecture,
-(``/opt/homebrew/``) for Apple Silicon processors with arm64 architecture.
-```{shell}
-$ cd /path/to/IfcOpenShell
-$ mkdir build && cd build
-# set library flags
-$ export LDFLAGS="$LDFLAGS -Wl,-flat_namespace,-undefined,suppress"
-$ cmake ../cmake
-    -DPYTHON_EXECUTABLE=/opt/homebrew/bin/python3.10 \
-    -DPYTHON_LIBRARY=/opt/homebrew/opt/python@3.10/Frameworks/Python.framework/Versions/3.10/lib/libpython3.10.dylib \
-    -DPYTHON_INCLUDE_DIR=/opt/homebrew/opt/python@3.10/Frameworks/Python.framework/Versions/3.10/include/python3.10/ \
-    -DOCC_LIBRARY_DIR=/opt/homebrew/lib/ \
-    -DOCC_INCLUDE_DIR=/opt/homebrew/include/opencascade/ \
-    -DCGAL_INCLUDE_DIR=/opt/homebrew/include/ \
-    -DGMP_LIBRARY_DIR=/opt/homebrew/lib/ \
-    -DMPFR_LIBRARY_DIR=/opt/homebrew/lib/ \
-    -DHDF5_LIBRARY_DIR=/opt/homebrew/lib/ \
-    -DHDF5_INCLUDE_DIR=/opt/homebrew/include/ \
-    -DCOLLADA_SUPPORT=0
-# `sysctl -n hw.ncpu` returns the number of cpu cores on macOS
-$ make -j$(sysctl -n hw.ncpu)
-```
-
-Note: Make sure to compile using the XCode provided Apple Clang compiler, installed with `xcode-select --install
-`, 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   |
+| 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"
 [IFC2x3 TC1]: https://standards.buildingsmart.org/IFC/RELEASE/IFC2x3/TC1/HTML/ "IFC2x3 TC1"
 [IFC4 Add2 TC1]: https://standards.buildingsmart.org/IFC/RELEASE/IFC4/ADD2_TC1/HTML/ "IFC4 Add2 TC1"
+[IFC4x3 Add2]: https://standards.buildingsmart.org/IFC/RELEASE/IFC4_3/ "IFC4x3 Add2"
 [Visual Studio]: https://www.visualstudio.com/ "Visual Studio"
 [Visual C++ Build Tools]: http://landinghub.visualstudio.com/visual-cpp-build-tools "Visual C++ Build Tools"
 [MSYS2]: https://msys2.github.io/ "MSYS2"

aws/lambda/Dockerfile

@@ -0,0 +1,40 @@
+# Dockerfile for Running AWS Lambda Function with Python and IfcOpenShell
+
+# Base image: Python 3.9 from AWS's public container registry
+FROM public.ecr.aws/docker/library/python:3.9 AS build
+
+# Set the location of your Lambda function code
+ARG FUNCTION_DIR="/var/task"
+
+# Install necessary packages
+RUN apt-get -y update && apt-get -y install unzip curl
+
+# Install AWS Lambda runtime interface client
+RUN pip install --target ${FUNCTION_DIR} awslambdaric
+
+# Set the IfcOpenShell build version (check available builds at: https://docs.ifcopenshell.org/ifcopenshell-python/installation.html)
+ARG IFC_OPENSHELL_BUILD="39-v0.7.0-476ab50"
+
+# Download and extract IfcOpenShell
+RUN curl https://s3.amazonaws.com/ifcopenshell-builds/ifcopenshell-python-${IFC_OPENSHELL_BUILD}-linux64.zip -O && \
+    unzip ifcopenshell-python-${IFC_OPENSHELL_BUILD}-linux64.zip && \
+    mv ifcopenshell ${FUNCTION_DIR} && \
+    rm ifcopenshell-python-${IFC_OPENSHELL_BUILD}-linux64.zip
+
+# Copy the requirements file and install dependencies
+COPY requirements.txt .
+RUN pip install -r requirements.txt
+
+# Copy the Lambda function code
+COPY ./example_handler ${FUNCTION_DIR}/example_handler
+
+# Set the working directory
+WORKDIR ${FUNCTION_DIR}
+
+# Set the entrypoint for the Lambda function
+ENTRYPOINT [ "/usr/local/bin/python", "-m", "awslambdaric" ]
+
+# Set the Python import path to the Lambda function handler
+# This path is relative to the root of the Lambda function code (FUNCTION_DIR)
+# Lambda invocation will look for this path
+CMD ["example_handler.extract_wall_psets_handler"]

aws/lambda/example_handler/__init__.py

@@ -0,0 +1,27 @@
+import ifcopenshell
+import ifcopenshell.util.element
+import boto3
+
+s3 = boto3.client('s3')
+
+def extract_wall_psets_handler(event, context):
+    print("Hello from lambda")
+    print("Event: {}".format(event))
+    print("Context: {}".format(context))
+
+    filename = event['body']['filename']
+    
+    s3.download_file('my_ifc_files_bucket', filename, f'/tmp/{filename}')
+    ifc_file = ifcopenshell.open(f'/tmp/{filename}')
+    walls = ifc_file.by_type('IfcWall')
+    
+    psets = []
+    for wall in walls:
+        wall_data = ifcopenshell.util.element.get_psets(wall)
+        wall_data['id'] = wall.GlobalId
+        psets.append(wall_data)
+
+    return {
+        'statusCode': 200,
+        'body': psets
+    }

aws/lambda/requirements.txt

@@ -0,0 +1 @@
+boto3

choco/blenderbim/blenderbim.nuspec

@@ -15,7 +15,7 @@
     <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>
+    <docsUrl>https://docs.blenderbim.org/</docsUrl>
     <!--<mailingListUrl></mailingListUrl>-->
     <bugTrackerUrl>https://github.com/IfcOpenShell/IfcOpenShell/issues</bugTrackerUrl>
     <tags>blender bim blenderbim ifc python opensource foss</tags>

choco/blenderbim/check_repo_infos.py

@@ -13,68 +13,77 @@ def request_repo_info(url: str):
     return resp
 
 
+def get_choco_package_info() -> str:
+    resp = request_repo_info(URL_CHOCO_PACKAGE)
+    html_txt = str(resp.read())
+    return html_txt
+
+
+def get_latest_blender_version() -> list:
+    html_txt = get_choco_package_info()
+    return re.findall(RE_BLENDER_VERSION_MIN_MAJ_PAT, html_txt)
+
+
+URL_IFCOS_RELEASES = "https://github.com/IfcOpenShell/IfcOpenShell/releases"
+URL_CHOCO_PACKAGE  = "https://community.chocolatey.org/packages/blender"
+URL_BLENDER_CMAKE  = "https://raw.githubusercontent.com/blender/blender/{}/build_files/cmake/Modules/FindPythonLibsUnix.cmake"
+RE_BLENDER_VERSION_MIN_MAJ        = r"Latest Version.+<span>Blender (\d+\.\d+)\..+</span>"
+RE_BLENDER_VERSION_MIN_MAJ_PAT    = r"Latest Version.+<span>Blender (\d+\.\d+\.\d+)</span>"
+RE_BLENDER_PYTHON_VERSION_MAJ_MIN = r"(?:set|SET)\(_PYTHON_VERSION_SUPPORTED (\d+\.\d+)\)"
+
+
 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)
+    resp = request_repo_info(URL_IFCOS_RELEASES)
     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="")
+    latest_blender_version = get_latest_blender_version()
+    if latest_blender_version:
+        print(latest_blender_version[0], end="")
+    else:
+        print("[ERROR] could not determine blender_version_min_maj_pat")
+        quit(1)
 
 
 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="")
+    html_txt = get_choco_package_info()
+    blender_version_min_maj = re.findall(RE_BLENDER_VERSION_MIN_MAJ, html_txt)
+    if blender_version_min_maj:
+        print(blender_version_min_maj[0], end="")
+    else:
+        print("[ERROR] could not determine blender_version_min_maj")
+        quit(1)
 
 
 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)
+    latest_blender_version = get_latest_blender_version()
+    if latest_blender_version:
+        latest_blender_version_tag = f"v{latest_blender_version[0]}"
+        resp = request_repo_info(URL_BLENDER_CMAKE.format(latest_blender_version_tag))
         html_txt = str(resp.read())
-        found = re.findall(re_blender_python_version_maj_min, html_txt)
+        found = re.findall(RE_BLENDER_PYTHON_VERSION_MAJ_MIN, html_txt)
         if found:
             print(found[0], end="")
+        else:
+            print("[ERROR] could not determine blender_python_version_maj_min")
+            quit(1)
 
 
 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)
+    latest_blender_version = get_latest_blender_version()
+    if latest_blender_version:
+        latest_blender_version_tag = f"v{latest_blender_version[0]}"
+        resp = request_repo_info(URL_BLENDER_CMAKE.format(latest_blender_version_tag))
         html_txt = str(resp.read())
-        found = re.findall(re_blender_python_version_maj_min, html_txt)
+        found = re.findall(RE_BLENDER_PYTHON_VERSION_MAJ_MIN, html_txt)
         if found:
             print(f"py{found[0].replace('.', '')}", end="")
+        else:
+            print("[ERROR] could not determine pyver")
+            quit(1)
 

cmake/cmake_uninstall.cmake.in

@@ -0,0 +1,43 @@
+################################################################################
+#                                                                              #
+# This file is part of IfcOpenShell.                                           #
+#                                                                              #
+# IfcOpenShell is free software: you can redistribute it and/or modify         #
+# it under the terms of the Lesser GNU General Public License as published by  #
+# the Free Software Foundation, either version 3.0 of the License, or          #
+# (at your option) any later version.                                          #
+#                                                                              #
+# IfcOpenShell 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                 #
+# Lesser GNU General Public License for more details.                          #
+#                                                                              #
+# You should have received a copy of the Lesser GNU General Public License     #
+# along with this program. If not, see <http://www.gnu.org/licenses/>.         #
+#                                                                              #
+################################################################################
+
+if(NOT EXISTS "@CMAKE_BINARY_DIR@/install_manifest.txt")
+    message(FATAL_ERROR "Cannot find install manifest: @CMAKE_BINARY_DIR@/install_manifest.txt")
+endif()
+
+file(READ "@CMAKE_BINARY_DIR@/install_manifest.txt" files)
+string(REGEX REPLACE "\n" ";" files "${files}")
+
+foreach(file ${files})
+    message(STATUS "Uninstalling $ENV{DESTDIR}${file}")
+
+    if(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
+        exec_program(
+            "@CMAKE_COMMAND@" ARGS "-E remove \"$ENV{DESTDIR}${file}\""
+            OUTPUT_VARIABLE rm_out
+            RETURN_VALUE rm_retval
+        )
+
+        if(NOT "${rm_retval}" STREQUAL 0)
+            message(FATAL_ERROR "Problem when removing $ENV{DESTDIR}${file}")
+        endif()
+    else(IS_SYMLINK "$ENV{DESTDIR}${file}" OR EXISTS "$ENV{DESTDIR}${file}")
+        message(STATUS "File $ENV{DESTDIR}${file} does not exist.")
+    endif()
+endforeach()

conda/Makefile

@@ -1,8 +0,0 @@
-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

@@ -4,6 +4,7 @@ set MY_PY_VER=%PY_VER:.=%
 set LIBXML2="%LIBRARY_PREFIX%/lib/libxml2.lib"
 
 cmake -G "Ninja" ^
+ -D SCHEMA_VERSIONS="2x3;4;4x1;4x3;4x3_add1" ^
  -D CMAKE_BUILD_TYPE:STRING=Release ^
  -D CMAKE_INSTALL_PREFIX:FILEPATH="%LIBRARY_PREFIX%" ^
  -D CMAKE_PREFIX_PATH:FILEPATH="%LIBRARY_PREFIX%" ^

conda/build.sh

@@ -13,6 +13,7 @@ if [ `uname` == Darwin ]; then
 fi
 
 cmake -G Ninja \
+ -DSCHEMA_VERSIONS="2x3;4;4x1;4x3;4x3_add1" \
  -DCMAKE_BUILD_TYPE=Release \
  -DCMAKE_INSTALL_PREFIX=$PREFIX \
   ${CMAKE_PLATFORM_FLAGS[@]} \
@@ -41,4 +42,4 @@ cmake -G Ninja \
 
 ninja
 
-ninja install
+ninja install -j 1

conda/conda_build_config.yaml

@@ -1,2 +1,6 @@
 CONDA_BUILD_SYSROOT:
-  - /opt/MacOSX10.13.sdk       # [osx]
+  - /opt/MacOSX10.13.sdk       # [osx]
+
+variant:
+  - novtk
+  - all

conda/environment.yml

@@ -1,14 +0,0 @@
-name: conda-build
-channels:
-  - conda-forge
-dependencies:
-  - conda-build
-  - conda-verify
-  - anaconda-client
-  - ninja
-  - doxygen
-  - ripgrep
-  - pip
-  - pip:
-      - --extra-index-url https://lief.s3-website.fr-par.scw.cloud/latest
-      - lief==0.13.0.dev0

conda/meta.yaml

@@ -1,8 +1,10 @@
 {% set name = "ifcopenshell" %}
 {% set version = "0.7.0" %}
-{% set occt_version = "7.6.2" %}
-{% set cgal_cpp_version = "5.3" %}
-{% set hdf5_version = "1.12.1" %}
+{% set build = 1 %}
+
+# Higher number -> Always prioritize "novtk" variant over "all" variant
+{% set build = build + 200 %}   # [variant == "novtk"]
+{% set build = build + 100 %}   # [variant == "all"]
 
 package:
   name: {{ name }}
@@ -12,7 +14,9 @@ source:
   path: ..
 
 build:
+  string: py{{ CONDA_PY }}_{{ variant }}_h{{ PKG_HASH }}_{{ build }}
   binary_relocation: false [osx]
+  number: {{ build }}
 
 requirements:
   build:
@@ -20,12 +24,12 @@ requirements:
     - {{ compiler('cxx') }}
     - ninja >=1.10.2
     - cmake
-    - swig >=4.0.2
+    - swig 4.1.1
 
   host:
     - python
-    - boost-cpp <=1.74.0
-    - occt
+    - boost-cpp
+    - occt 7.7.2 *{{ variant }}*
     - libxml2
     - cgal-cpp
     - hdf5
@@ -33,30 +37,32 @@ requirements:
     - gmp  # [unix]
     - mpir  # [win]
     - nlohmann_json
+    - zlib
 
   run:
     - python
-    - boost-cpp <=1.74.0
-    - occt
+    - occt 7.7.2 *{{ variant }}*
+    - {{ pin_compatible('cgal-cpp', max_pin='x.x.x') }}
+    - {{ pin_compatible('boost-cpp', max_pin='x.x.x') }}
+    - {{ pin_compatible('hdf5', 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
+  home: https://ifcopenshell.org
   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/
+  doc_url: https://ifcopenshell.org/
   dev_url: https://github.com/IfcOpenShell/IfcOpenShell

docs/cmake/FindSphinx.cmake

@@ -1,11 +0,0 @@
-#Look for an executable called sphinx-build
-find_program(SPHINX_EXECUTABLE
-             NAMES sphinx-build
-             DOC "Path to sphinx-build executable")
-
-include(FindPackageHandleStandardArgs)
-
-#Handle standard arguments to find_package like REQUIRED and QUIET
-find_package_handle_standard_args(Sphinx
-                                  "Failed to find sphinx-build executable"
-                                  SPHINX_EXECUTABLE)

docs/cmake/SphinxConfig.cmake

@@ -1,11 +0,0 @@
-#Look for an executable called sphinx-build
-find_program(SPHINX_EXECUTABLE
-             NAMES sphinx-build
-             DOC "Path to sphinx-build executable")
-
-include(FindPackageHandleStandardArgs)
-
-#Handle standard arguments to find_package like REQUIRED and QUIET
-find_package_handle_standard_args(Sphinx
-                                  "Failed to find sphinx-build executable"
-                                  SPHINX_EXECUTABLE)

docs/cpp-api/README.md

@@ -0,0 +1,33 @@
+# IfcOpenShell C++ API documentation
+
+This folder contains the setup to build the IfcOpenShell C++ API documentation from the source code.
+
+## Generating the documentation
+
+> Prerequisites:
+> 
+> Make sure to have [Doxygen](https://www.doxygen.nl) and [Graphviz](https://graphviz.org) installed into your `$PATH` variable.
+> 
+> The documentation also use the [doxygen-awesome](https://jothepro.github.io/doxygen-awesome-css) theme as a git submodule.
+
+Build with the command (from within the `/docs/cpp-api` folder):
+
+```shell
+$ doxygen
+```
+
+To include the current git commit hash into the build documentation, use the following command:
+
+```shell
+$ PROJECT_NUMBER=$(git rev-parse --short HEAD) doxygen
+```
+
+This will extract the current commit hash in short version and sets the propper ENV variable used by doxygen.
+
+The generation of the documentation might take a while depending on your systems hardware, as it is configured to generate the Class graphs using .
+
+The resulting documentation is located unter `/cpp-api/output/html` and can be directly accessed with your browser:
+
+```shell
+$ open ./output/html/index.html
+```

docs/geom/settings.md

@@ -1,240 +0,0 @@
-APPLY_DEFAULT_MATERIALS
------------------------
-
-Given the command invocation:
-
-    Duplex_A_20110907_optimized.ifc d.dae -yv --include attribute GlobalId 3bXiCStxP6Fgxdej$yc50U
-
-You will find log messages along the lines of
-
-    [Warning] {3bXiCStxP6Fgxdej$yc50U} No material and surface styles for:
-    #333=IfcCovering('3bXiCStxP6Fgxdej$yc50U',#1,'Compound Ceiling:Gypsum Board:187483',$,'Compound Ceiling:Gypsum Board',#17840,#17052,'187483',.CEILING.)
-
-This means that there is no IfcStyledItem associated to the representation items and that the element does not have an IfcMaterial association with IfcMaterialRepresentation from which we can derive a style (colour) for the element.
-
-The interactive session below shows how with this setting enabled you will get a default generated material from the IFC element entity type and material indices of 0 pointing to that. With this setting disabled the material index would be -1 to indicate a missing style. Note that there is one material index for every triangle in the list of `shp.geometry.faces`.
-
-    >>> import ifcopenshell, ifcopenshell.geom
-    >>> f = ifcopenshell.open("Duplex_A_20110907_optimized.ifc")
-    >>> s = ifcopenshell.geom.settings()
-    >>> c = f["3bXiCStxP6Fgxdej$yc50U"]
-    >>>
-    >>> shp = ifcopenshell.geom.create_shape(s, c)
-    >>> shp.geometry.material_ids
-    (-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1)
-    >>> [(m.name, m.diffuse) for m in shp.geometry.materials]
-    []
-    >>>
-    >>> s.set(s.APPLY_DEFAULT_MATERIALS, True)
-    >>> shp = ifcopenshell.geom.create_shape(s, c)
-    >>> shp.geometry.material_ids
-    (0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
-    >>> [(m.name, m.diffuse) for m in shp.geometry.materials]
-    [('IfcCovering', (0.7, 0.7, 0.7))]
-
-This is enabled by default for the IfcConvert serializers as they will not gracefully handle -1 material indices and allows users to quickly assign colours based on entity types in their modelling applications.
-
-APPLY_LAYERSETS
----------------
-
-This setting is available in IfcConvert as `--enable-layerset-slicing`.
-
-For IfcWall and IfcSlab elements, takes the associated IfcMaterialLayerSet and builds a set of surfaces to segment the building element geometry.
-
-Note that enabling this settings is computationally intensive as it involves 3D Boolean operations.
-
-    Duplex_A_20110907_optimized.ifc d1.dae -yv --include attribute GlobalId 2O2Fr$t4X7Zf8NOew3FNr2
-    
-![Image of d1.dae](images/settings-1.png)
-    
-    Duplex_A_20110907_optimized.ifc d2.dae --enable-layerset-slicing -yv --include attribute GlobalId 2O2Fr$t4X7Zf8NOew3FNr2
-    
-![Image of d2.dae](images/settings-2.png)
-
-BUILDING_LOCAL_PLACEMENT
-------------------------
-
-This setting is available in IfcConvert using `--building-local-placement`.
-
-In the typical IfcSite > IfcBuilding > IfcBuildingStorey > ... hierarchy of elements, don't incorporate the ObjectPlacement of the IfcBuilding and above in the placement of elements in the output. This is useful when there is a large offset in this placement that reduces precision in further processing.
-
-CONVERT_BACK_UNITS
-------------------
-
-This setting is available in IfcConvert using `--convert-back-units`.
-
-Internally IfcOpenShell uses meters as the global length unit to do calculations. This setting restores the coordinate positions after conversion by multiplying the factor of the IfcUnit with UnitType=LENGTHUNIT into the output geometry coordinate values.
-
-DISABLE_OPENING_SUBTRACTIONS
-----------------------------
-
-This setting is available in IfcConvert using `--disable-opening-subtraction`.
-
-As in most viewer applications, IfcOpeningElement geometry is subtracted from their host elements. This setting disables this behavior.
-
-    Duplex_A_20110907_optimized.ifc d1.dae -yv --include attribute GlobalId 2O2Fr$t4X7Zf8NOew3FNr2
-    
-![Image of d1.dae](images/settings-1.png)
-    
-    Duplex_A_20110907_optimized.ifc d3.dae --disable-opening-subtraction -yv --include attribute GlobalId 2O2Fr$t4X7Zf8NOew3FNr2
-    
-![Image of d3.dae](images/settings-3.png)
-
-Note that disabling this settings will reduce processing time and improve robustness as it involves 3D Boolean operations.
-
-DISABLE_TRIANGULATION
----------------------
-
-To be used in conjunction with `USE_BREP_DATA`. Do not apply the triangulation and - when `USE_BREP_DATA` is set - return a OpenCASCADE serialized TopoDS_Shape from `create_shape()` and `iterator`.
-
-    >>> import ifcopenshell, ifcopenshell.geom
-    >>> s = ifcopenshell.geom.settings()
-    >>> s.set(s.DISABLE_TRIANGULATION, True)
-    >>> s.set(s.USE_BREP_DATA, True)
-    >>> f = ifcopenshell.open("Duplex_A_20110907_optimized.ifc")
-    >>> c = f["3bXiCStxP6Fgxdej$yc50U"]
-    >>> shp = ifcopenshell.geom.create_shape(s, c)
-    >>> print(shp.geometry.brep_data)
-
-    CASCADE Topology V1, (c) Matra-Datavision
-    Locations 0
-    Curve2ds 0
-    Curves 12
-    1 4.6750000000000034 -8.0749999999999904 2.657 -2.0455514041918775e-15 -1 0
-    1 4.6750000000000034 -8.0749999999999904 2.657 1 -3.435893306383461e-15 0
-    1 6.2260000000000044 -8.0749999999999957 2.657 -2.0455514041918724e-15 -1 0
-    1 6.226 -10.246000000000031 2.657 -1 6.8717866127669219e-15 0
-    ...
-
-EDGE_ARROWS
------------
-
-When `INCLUDE_CURVES` is true and geometric elements include curves (such as the wall axis), add arrow heads to the edges to indicate direction of the curve.
-
-    Duplex_A_20110907_optimized.ifc d4.dae --model --plan --edge-arrows -yv --include attribute GlobalId 2O2Fr$t4X7Zf8NOew3FNr2
-    
-![Image of d4.dae](images/settings-4.png)
-
-EXCLUDE_SOLIDS_AND_SURFACES
----------------------------
-
-Exclude faces, shells and solids from geometrical output. Implied when using `--plan` without `--model` in IfcConvert.
-
-FASTER_BOOLEANS
----------------
-
-NOTE: Only applicable when using OCCT 6.9 and earlier.
-
-This setting is available in IfcConvert using `--merge-boolean-operands`.
-
-Fuse the collection of all boolean operands into a single union before applying the boolean subtraction, as opposed to doing individual subtractions. This likely improves performance. From OCCT 7.0 onwards the boolean operations with multiple arguments is used.
-
-GENERATE_UVS
-------------
-
-This setting is available in IfcConvert using `--generate-uvs`.
-
-Applies a box projection on the generated geometry for the element to obtain UV coordinates. This is purely generated, it does not involve texture coordinates stored in the IFC model.
-
-    Duplex_A_20110907_optimized.ifc d5.dae --generate-uvs -yv --include attribute GlobalId 2O2Fr$t4X7Zf8NOew3FNr2
-
-![Image of d5.dae with a UV grid applied in Blender](images/settings-5.png)
-
-INCLUDE_CURVES
---------------
-
-This setting is available in IfcConvert using `--plan`.
-
-Include edge and wire geometries in the geometric output.
-
-LAYERSET_FIRST
---------------
-
-This setting is available in IfcConvert using `--layerset-first`.
-
-When not using APPLY_LAYERSETS, take the first material layer from the set to use as the material for the overall element.
-
-NO_NORMALS
-----------
-
-This setting is available in IfcConvert using `--no-normals`.
-
-Do not emit normals on geometric output
-
-SEARCH_FLOOR
-------------
-
-Note: Only applicable to Collada .DAE output when used from IfcConvert.
-
-This setting is available in IfcConvert using `--use-element-hierarchy`.
-
-Include the spatial hierarchy in the elements.
-
-SEW_SHELLS
-----------
-
-This setting is available in IfcConvert using `--orient-shells`.
-
-Re-orient or sew connected face sets to have a consistent outwards orientation.
-
-SITE_LOCAL_PLACEMENT
---------------------
-
-This setting is available in IfcConvert using `--site-local-placement`.
-
-See `BUILDING_LOCAL_PLACEMENT`, but exclude also the ObjectPlacement of the IfcSite.
-
-USE_BREP_DATA
--------------
-
-See `DISABLE_TRIANGULATION`.
-
-USE_PYTHON_OPENCASCADE
-----------------------
-
-Note: Only available when an import of `OCC.Core.BRepTools` or `OCC.BRepTools` succeeds.
-
-This implies `USE_WORLD_COORDS` `USE_BREP_DATA` and `DISABLE_TRIANGULATION`. The serialized TopoDS_Shape of `USE_BREP_DATA` is deserialized by Python OpenCASCADE.
-
-USE_WORLD_COORDS
-----------------
-
-Apply the ObjectPlacement of the building elements to the geometric output. This is implied when using the Wavefront .OBJ output in IfcConvert. Note that this also eliminates the possibility for geometric elements to point to the same interpreted geometry result.
-
-VALIDATE_QUANTITIES
--------------------
-
-This setting is available in IfcConvert using `--validate`.
-
-Running IfcConvert with `--validate` will set a non-zero exit code when ever a log message with severity equal or greater than ERROR has been emitted.
-
-Currently for internal use only. For every building element geometry converted, looks for an associated quantity set where the OwnerHistory's organization name is IfcOpenShell. And looks for the quantities "Total Surface Area", "Volume", "Shape Validation Properties.Surface Genus" and validates these according to the interpreted geometry definition. Emit Logger::Error when calculated values are outside of the tolerance range for the value stored in the model.
-
-WELD_VERTICES
--------------
-
-Note: In Python, this setting is *on* by default.
-
-Note: This setting only affects triangulated output.
-
-This setting is available in IfcConvert using `--weld-vertices`.
-
-Discards normals and joins vertices solely based on position. This is useful when output is to be modified in a modeling application.
-
-    >>> import ifcopenshell, ifcopenshell.geom
-    >>> s = ifcopenshell.geom.settings()
-    >>> s.set(s.WELD_VERTICES, False)
-    >>> f = ifcopenshell.open("Duplex_A_20110907_optimized.ifc")
-    >>> c = f["3bXiCStxP6Fgxdej$yc50U"]
-    >>> shp = ifcopenshell.geom.create_shape(s, c)
-    >>> shp.geometry.verts
-    (4.675000000000003, -8.07499999999999, 2.657, 4.674999999999999, -10.24600000000002, 2.657, 6.226000000000004, -8.074999999999996, 2.657, 6.226, -10.24600000000003, 2.657, 4.675000000000003, -8.07499999999999, 2.6, 4.674999999999999, -10.24600000000002, 2.6, 6.226000000000004, -8.074999999999996, 2.6, 6.226, -10.24600000000003, 2.6, 4.674999999999999, -10.24600000000002, 2.657, 4.674999999999999, -10.24600000000002, 2.6, 4.675000000000003, -8.07499999999999, 2.657, 4.675000000000003, -8.07499999999999, 2.6, 6.226, -10.24600000000003, 2.657, 4.674999999999999, -10.24600000000002, 2.657, 6.226, -10.24600000000003, 2.6, 4.674999999999999, -10.24600000000002, 2.6, 6.226000000000004, -8.074999999999996, 2.657, 6.226, -10.24600000000003, 2.657, 6.226000000000004, -8.074999999999996, 2.6, 6.226, -10.24600000000003, 2.6, 4.675000000000003, -8.07499999999999, 2.657, 4.675000000000003, -8.07499999999999, 2.6, 6.226000000000004, -8.074999999999996, 2.657, 6.226000000000004, -8.074999999999996, 2.6)
-    >>> shp.geometry.normals
-    (3.059754518198021e-17, 0.0, -1.0, 3.059754518198021e-17, 0.0, -1.0, 3.059754518198021e-17, 0.0, -1.0, 3.059754518198021e-17, 0.0, -1.0, 2.110175529791737e-16, 0.0, -1.0, 2.110175529791737e-16, 0.0, -1.0, 2.110175529791737e-16, 0.0, -1.0, 2.110175529791737e-16, 0.0, -1.0, -1.0, 1.79434333701042e-15, 0.0, -1.0, 1.79434333701042e-15, 0.0, -1.0, 1.79434333701042e-15, 0.0, -1.0, 1.79434333701042e-15, 0.0, 6.8717866127669046e-15, 1.0, 0.0, 6.8717866127669046e-15, 1.0, 0.0, 6.8717866127669046e-15, 1.0, 0.0, 6.8717866127669046e-15, 1.0, 0.0, -1.0, 1.79434333701042e-15, 0.0, -1.0, 1.79434333701042e-15, 0.0, -1.0, 1.79434333701042e-15, 0.0, -1.0, 1.79434333701042e-15, 0.0, 3.4358933063834523e-15, 1.0, 0.0, 3.4358933063834523e-15, 1.0, 0.0, 3.4358933063834523e-15, 1.0, 0.0, 3.4358933063834523e-15, 1.0, 0.0)
-    >>>
-    >>> s.set(s.WELD_VERTICES, True)
-    >>> shp = ifcopenshell.geom.create_shape(s, c)
-    >>> shp.geometry.verts
-    (4.675000000000003, -8.07499999999999, 2.657, 4.674999999999999, -10.24600000000002, 2.657, 6.226000000000004, -8.074999999999996, 2.657, 6.226, -10.24600000000003, 2.657, 4.675000000000003, -8.07499999999999, 2.6, 4.674999999999999, -10.24600000000002, 2.6, 6.226000000000004, -8.074999999999996, 2.6, 6.226, -10.24600000000003, 2.6)
-    >>> shp.geometry.normals
-    ()

nix/build-all.py

@@ -26,7 +26,7 @@
 #     * cmake * git * bzip2 * tar * c(++) compilers * autoconf                #
 #                                                                             #
 #   if building with USE_OCCT additionally:                                   #
-#     * freetype * glx.h                                                      #
+#     * glx.h                                                                 #
 #                                                                             #
 #   if building with OCCT 7.4.0 additionally:                                 #
 #     * libfontconfig1-dev                                                    #
@@ -39,14 +39,14 @@
 #                                                                             #
 #     on debian 7.8 these can be obtained with:                               #
 #          $ apt-get install git gcc g++ autoconf bison bzip2 cmake           #
-#            libfreetype6-dev mesa-common-dev libffi-dev libfontconfig1-dev   #
+#            mesa-common-dev libffi-dev libfontconfig1-dev                    #
 #                                                                             #
 #     on ubuntu 14.04:                                                        #
 #          $ apt-get install git gcc g++ autoconf bison make cmake            #
-#            libfreetype6-dev mesa-common-dev libffi-dev libfontconfig1-dev   #
+#            mesa-common-dev libffi-dev libfontconfig1-dev                    #
 #                                                                             #
 #     on OS X El Capitan with homebrew:                                       #
-#          $ brew install git bison autoconf automake freetype libffi cmake   #
+#          $ brew install git bison autoconf automake libffi cmake            #
 #                                                                             #
 ###############################################################################
 import logging
@@ -59,6 +59,10 @@ import multiprocessing
 import platform
 import sysconfig
 
+# @todo temporary for expired mpfr.org certificate on 2023-04-08
+import ssl
+ssl._create_default_https_context = ssl._create_unverified_context
+
 from urllib.request import urlretrieve
 
 
@@ -72,11 +76,11 @@ PROJECT_NAME = "IfcOpenShell"
 USE_CURRENT_PYTHON_VERSION = os.getenv("USE_CURRENT_PYTHON_VERSION")
 ADD_COMMIT_SHA = os.getenv("ADD_COMMIT_SHA")
 
-PYTHON_VERSIONS = ["3.6.14", "3.7.13", "3.8.13", "3.9.11", "3.10.3"]
+PYTHON_VERSIONS = ["3.9.11", "3.10.3", "3.11.8", "3.12.1"]
 JSON_VERSION = "v3.6.1"
 OCE_VERSION = "0.18.3"
 OCCT_VERSION = "7.5.3"
-BOOST_VERSION = "1.71.0"
+BOOST_VERSION = "1.80.0"
 PCRE_VERSION = "8.41"
 LIBXML2_VERSION = "2.9.11"
 SWIG_VERSION = "4.0.2"
@@ -103,6 +107,9 @@ curl = "curl"
 wget = "wget"
 strip = "strip"
 
+explicit_targets = [s for s in sys.argv[1:] if not s.startswith("-")]
+flags = set(s.lstrip('-') for s in sys.argv[1:] if s.startswith("-"))
+
 # Helper function for coloured printing
 
 NO_COLOR = "\033[0m" # <ref>http://stackoverflow.com/questions/5947742/how-to-change-the-output-color-of-echo-in-linux</ref>
@@ -135,9 +142,11 @@ if platform.system() == "Darwin":
 
 IFCOS_NUM_BUILD_PROCS = os.getenv("IFCOS_NUM_BUILD_PROCS", multiprocessing.cpu_count() + 1)
 
-CMAKE_DIR = os.path.realpath(os.path.join("..", "cmake"))
+CMAKE_DIR = os.path.realpath(os.path.join(os.path.dirname(__file__), "..", "cmake"))
 
-path = ["..", "build", platform.system(), platform.machine()]
+build_dir = os.environ.get("BUILD_DIR", os.path.join(os.path.dirname(__file__), "..", "build"))
+
+path = [build_dir, platform.system(), "wasm" if "wasm" in flags else platform.machine()]
 if TOOLSET:
     path.append(TOOLSET)
 DEFAULT_DEPS_DIR = os.path.realpath(os.path.join(*path))
@@ -186,11 +195,12 @@ dependency_tree = {
     'boost': (),
     'libxml2': (),
     'python': (),
-    'occ': (),
+    'occ': ('freetype',),
     'pcre': (),
     'json': (),
     'hdf5': (),
-    'cgal': ()
+    'cgal': (),
+    'freetype': (),
 }
 
 def v(dep):
@@ -199,10 +209,12 @@ def v(dep):
      for x in v(d):
        yield x
 
-tgts = [s for s in sys.argv[1:] if not s.startswith("-")]
-flags = set(s for s in sys.argv[1:] if s.startswith("-"))
+if "v" in flags:
+    logger.setLevel(logging.DEBUG)
+else:
+    logger.setLevel(logging.INFO)
 
-BUILD_STATIC = not "-shared" in flags
+BUILD_STATIC = "shared" not in flags
 ENABLE_FLAG = "--enable-static" if BUILD_STATIC else "--enable-shared"
 DISABLE_FLAG = "--disable-shared" if BUILD_STATIC else "--disable-static"
 LINK_TYPE = "static" if BUILD_STATIC else "shared"
@@ -210,10 +222,15 @@ LINK_TYPE_UCFIRST = LINK_TYPE[0].upper() + LINK_TYPE[1:]
 LIBRARY_EXT = "a" if BUILD_STATIC else "so"
 PIC = "-fPIC" if BUILD_STATIC else ""
 
-if len(tgts):
-    targets = set(sum((list(v(target)) for target in tgts), []))
+if any(f.startswith("py-") for f in flags):
+    PYTHON_VERSIONS = [pyv for pyv in PYTHON_VERSIONS if "py-%s" % "".join(pyv.split('.')[0:2]) in flags]
+
+if len(explicit_targets):
+    targets = set(sum((list(v(target)) for target in explicit_targets), []))
 else:
     targets = set(dependency_tree.keys())
+    
+targets = set(t for t in targets if 'without-%s' % t.lower() not in flags)
 
 print("Building:", *sorted(targets, key=lambda t: len(list(v(t)))))
 
@@ -237,7 +254,12 @@ if not os.path.exists(LOG_FILE):
     open(LOG_FILE, "w").close()
 logger.info(f"using command log file '{LOG_FILE}'")
 
-def run(cmds, cwd=None):
+# Causing havoc in python 3.11 build
+try:
+    del os.environ['__PYVENV_LAUNCHER__']
+except: pass
+
+def run(cmds, cwd=None, can_fail=False):
 
     """
     Wraps `subprocess.Popen.communicate()` and logs the command being executed,
@@ -254,7 +276,7 @@ def run(cmds, cwd=None):
     log_file_handle.close()
     logger.debug(f"command returned {proc.returncode}")
 
-    if proc.returncode != 0:
+    if proc.returncode != 0 and not can_fail:
         print("-" * 70)
         print(stderr)
         print("-" * 70)
@@ -266,6 +288,10 @@ if platform.system() == "Darwin":
     if run(["sw_vers", "-productVersion"]) >= "11.":
         # Apparently not supported
         PYTHON_VERSIONS = [pv for pv in PYTHON_VERSIONS if tuple(map(int, pv.split("."))) >= (3, 7)]
+    if run(["sw_vers", "-productVersion"]) < "10.16":
+        # This is now solved with the '__PYVENV_LAUNCHER__' hack
+        # PYTHON_VERSIONS = [pv for pv in PYTHON_VERSIONS if tuple(map(int, pv.split("."))) < (3, 11)]
+        pass
 
 BOOST_VERSION_UNDERSCORE = BOOST_VERSION.replace(".", "_")
 
@@ -281,7 +307,12 @@ def run_autoconf(arg1, configure_args, cwd):
         run([bash, "./autogen.sh"], cwd=os.path.realpath(os.path.join(cwd, ".."))) # only run autogen.sh in the directory it is located and use cwd to achieve that in order to not mess up things
     # Using `sh` over `bash` fixes issues with building swig 
     prefix = os.path.realpath(f"{DEPS_DIR}/install/{arg1}")
-    run(["/bin/sh", "../configure"] + configure_args + [f"--prefix={prefix}"], cwd=cwd)
+
+    wasm = []
+    if "wasm" in flags:
+        wasm.append("emconfigure")
+
+    run([*wasm, "/bin/sh", "../configure"] + configure_args + [f"--prefix={prefix}"], cwd=cwd)
 
 
 def run_cmake(arg1, cmake_args, cmake_dir=None, cwd=None):
@@ -289,7 +320,12 @@ def run_cmake(arg1, cmake_args, cmake_dir=None, cwd=None):
         P = ".."
     else:
         P = cmake_dir
-    run(["cmake", P] + cmake_args + [f"-DCMAKE_BUILD_TYPE={BUILD_CFG}"], cwd=cwd)
+        
+    wasm = []
+    if "wasm" in flags:
+        wasm.append("emcmake")
+        
+    run([*wasm, "cmake", P, *cmake_args, f"-DCMAKE_BUILD_TYPE={BUILD_CFG}"], cwd=cwd)
 
 
 def git_clone_or_pull_repository(clone_url, target_dir, revision=None):
@@ -371,12 +407,15 @@ def build_dependency(name, mode, build_tool_args, download_url, download_name, d
             urlretrieve(url, os.path.join(extract_dir, path))
             
     if patch is not None:
-        patch_abs = os.path.abspath(os.path.join(os.path.dirname(__file__), patch))
-        if os.path.exists(patch_abs):
-            try: run(["patch", "-p1", "--batch", "--forward", "-i", patch_abs], cwd=extract_dir)
-            except Exception as e:
-                # Assert that the patch has already been applied
-                run(["patch", "-p1", "--batch", "--reverse", "--dry-run", "-i", patch_abs], cwd=extract_dir)
+        if isinstance(patch, str):
+            patch = [patch]
+        for p in patch:
+            patch_abs = os.path.abspath(os.path.join(os.path.dirname(__file__), p))
+            if os.path.exists(patch_abs):
+                try: run(["patch", "-p1", "--batch", "--forward", "-i", patch_abs], cwd=extract_dir)
+                except Exception as e:
+                    # Assert that the patch has already been applied
+                    run(["patch", "-p1", "--batch", "--reverse", "--dry-run", "-i", patch_abs], cwd=extract_dir)
     
     if mode == "ctest":
         run(["ctest", "-S", "HDF5config.cmake,BUILD_GENERATOR=Unix", "-C", BUILD_CFG, "-V", "-O", "hdf5.log"], cwd=extract_dir)
@@ -407,7 +446,7 @@ def build_dependency(name, mode, build_tool_args, download_url, download_name, d
         logger.info(f"\rConfiguring {name}...")
         run([bash, "./bootstrap.sh"], cwd=extract_dir)
         logger.info(f"\rBuilding {name}...   ")
-        run(["./b2", f"-j{IFCOS_NUM_BUILD_PROCS}"] + build_tool_args, cwd=extract_dir)
+        run(["./b2", f"-j{IFCOS_NUM_BUILD_PROCS}"] + build_tool_args, cwd=extract_dir, can_fail="wasm" in flags)
         logger.info(f"\rInstalling {name}... ")
         shutil.copytree(os.path.join(extract_dir, "boost"), os.path.join(DEPS_DIR, "install", f"boost-{BOOST_VERSION}", "boost"))
         logger.info(f"\rInstalled {name}     \n")
@@ -418,11 +457,13 @@ cecho("Collecting dependencies:", GREEN)
 # TODO: This is untested
 
 ADDITIONAL_ARGS = []
-BOOST_ADDRESS_MODEL = []
 
 if platform.system() == "Darwin":
     ADDITIONAL_ARGS = [f"-mmacosx-version-min={TOOLSET}"] + ADDITIONAL_ARGS
 
+if "wasm" in flags:
+    ADDITIONAL_ARGS.extend(("-sWASM_BIGINT", "-fexceptions"))
+
 # If the linker supports GC sections, set it up to reduce binary file size
 # -fPIC is required for the shared libraries to work
 
@@ -431,7 +472,7 @@ CFLAGS = os.environ.get("CFLAGS", "")
 LDFLAGS = os.environ.get("LDFLAGS", "")
 
 ADDITIONAL_ARGS_STR = " ".join(ADDITIONAL_ARGS)
-if sp.call([bash, "-c", "ld --gc-sections 2>&1 | grep -- --gc-sections &> /dev/null"]) != 0:
+if "wasm" not in flags and sp.call([bash, "-c", "ld --gc-sections 2>&1 | grep -- --gc-sections &> /dev/null"]) != 0:
     CXXFLAGS_MINIMAL = f"{CXXFLAGS} {PIC} {ADDITIONAL_ARGS_STR}"
     CFLAGS_MINIMAL = f"{CFLAGS} {PIC} {ADDITIONAL_ARGS_STR}"
     if BUILD_STATIC:
@@ -501,8 +542,27 @@ if "swig" in targets:
         download_tool=download_tool_git,
         revision=f"rel-{SWIG_VERSION}"
     )
+    
+if "freetype" in targets:
+    build_dependency(
+        name=f"freetype",
+        mode="cmake",
+        build_tool_args=[
+            f"-DCMAKE_INSTALL_PREFIX={DEPS_DIR}/install/freetype"
+        ],
+        download_url = "https://github.com/freetype/freetype",
+        download_name = "freetype2",
+        download_tool=download_tool_git,
+    )
 
 if USE_OCCT and "occ" in targets:
+    patches = []
+    if OCCT_VERSION < "7.4":
+        patches.append("./patches/occt/enable-exception-handling.patch")
+    
+    if "wasm" in flags:
+        patches.append("./patches/occt/no_em_js.patch")
+
     build_dependency(
         name=f"occt-{OCCT_VERSION}",
         mode="cmake",
@@ -510,12 +570,13 @@ if USE_OCCT and "occ" in targets:
             f"-DINSTALL_DIR={DEPS_DIR}/install/occt-{OCCT_VERSION}",
             f"-DBUILD_LIBRARY_TYPE={LINK_TYPE_UCFIRST}",
             "-DBUILD_MODULE_Draw=0",
-            "-DBUILD_RELEASE_DISABLE_EXCEPTIONS=Off"
+            "-DBUILD_RELEASE_DISABLE_EXCEPTIONS=Off",
+            f"-D3RDPARTY_FREETYPE_DIR={DEPS_DIR}/install/freetype"
         ],
         download_url = "https://github.com/Open-Cascade-SAS/OCCT",
         download_name = "occt",
         download_tool=download_tool_git,
-        patch=None if OCCT_VERSION >= "7.4" else "./patches/occt/enable-exception-handling.patch",
+        patch=patches,
         revision="V" + OCCT_VERSION.replace('.', '_')
     )
 elif "occ" in targets:
@@ -552,6 +613,15 @@ if "libxml2" in targets:
     )
     
 if "OpenCOLLADA" in targets:
+    patches = ["./patches/opencollada/pr622_and_disable_subdirs.patch"]
+
+    if "wasm" in flags:
+        # This is necessary for the WASM build, because recent versions of
+        # clang don't have the tr1:: namespace anymore. However, it breaks
+        # some versions of gcc (9.4.0 at least) due to specializing std::hash
+        # outside of the std:: namespace.
+        patches.append("./patches/opencollada/remove_tr1.patch")
+
     build_dependency(
         "OpenCOLLADA",
         "cmake",
@@ -566,11 +636,11 @@ if "OpenCOLLADA" in targets:
         download_url="https://github.com/KhronosGroup/OpenCOLLADA.git",
         download_name="OpenCOLLADA",
         download_tool=download_tool_git,
-        patch="./patches/opencollada/pr622_and_disable_subdirs.patch",
+        patch=patches,
         revision=OPENCOLLADA_VERSION
     )
 
-if "python" in targets and not USE_CURRENT_PYTHON_VERSION:
+if "python" in targets and not USE_CURRENT_PYTHON_VERSION and "wasm" not in flags:
     # Python should not be built with -fvisibility=hidden, from experience that introduces segfaults
     OLD_CXX_FLAGS = os.environ["CXXFLAGS"]
     OLD_C_FLAGS = os.environ["CFLAGS"]
@@ -609,6 +679,9 @@ if "python" in targets and not USE_CURRENT_PYTHON_VERSION:
 
 if "boost" in targets:
     str_concat = lambda prefix: lambda postfix: "" if postfix.strip() == "" else "=".join((prefix, postfix.strip()))
+    toolset = []
+    if "wasm" in flags:
+        toolset.append("toolset=emscripten")
     build_dependency(
         f"boost-{BOOST_VERSION}",
         mode="bjam",
@@ -620,21 +693,30 @@ if "boost" in targets:
             "--with-thread",
             "--with-date_time",
             "--with-iostreams",
-            f"link={LINK_TYPE}"
-                                                                         ] + \
-            BOOST_ADDRESS_MODEL                                            + \
-            list(map(str_concat("cxxflags"), CXXFLAGS.strip().split(' '))) + \
-            list(map(str_concat("linkflags"), LDFLAGS.strip().split(' '))) + \
-            ["stage", "-s", "NO_BZIP2=1"],
+            f"link={LINK_TYPE}",
+            *toolset,
+            *map(str_concat("cxxflags"), CXXFLAGS.strip().split(' ')),
+            *map(str_concat("linkflags"), LDFLAGS.strip().split(' ')),
+            "stage", "-s", "NO_BZIP2=1"],
         download_url=BOOST_LOCATION,
+        patch="./patches/boost/boostorg_regex_62.patch",
         download_name=f"boost_{BOOST_VERSION_UNDERSCORE}.tar.bz2"
     )
+    if "wasm" in flags:
+        # only supported on nix for now
+        run(("find", ".", "-name", "*.bc", "-exec", "bash", "-c", "emar q ${1%.bc}.a $1", "bash", "{}", ";"), cwd=f"{DEPS_DIR}/install/boost-{BOOST_VERSION}/lib")
     
 if "cgal" in targets:
+    gmp_args = []
+    mpfr_args = []
+    if "wasm" in flags:
+        gmp_args.extend(("--disable-assembly", "--host", "none", "--enable-cxx"))
+        mpfr_args.extend(("--host", "none"))
+
     build_dependency(
         name=f"gmp-{GMP_VERSION}",
         mode="autoconf",
-        build_tool_args=[ENABLE_FLAG, DISABLE_FLAG, "--with-pic"],
+        build_tool_args=[ENABLE_FLAG, DISABLE_FLAG, "--with-pic", *gmp_args],
         download_url="https://ftp.gnu.org/gnu/gmp/",
         download_name=f"gmp-{GMP_VERSION}.tar.bz2"
     )
@@ -642,7 +724,7 @@ if "cgal" in targets:
     build_dependency(
         name=f"mpfr-{MPFR_VERSION}",
         mode="autoconf",
-        build_tool_args=[ENABLE_FLAG, DISABLE_FLAG, f"--with-gmp={DEPS_DIR}/install/gmp-{GMP_VERSION}"],
+        build_tool_args=[ENABLE_FLAG, DISABLE_FLAG, *mpfr_args, f"--with-gmp={DEPS_DIR}/install/gmp-{GMP_VERSION}"],
         download_url=f"http://www.mpfr.org/mpfr-{MPFR_VERSION}/",
         download_name=f"mpfr-{MPFR_VERSION}.tar.bz2"
     )
@@ -676,18 +758,8 @@ os.makedirs(IFCOS_DIR, exist_ok=True)
 executables_dir = os.path.join(IFCOS_DIR, "executables")
 os.makedirs(executables_dir, exist_ok=True)
 
-logger.info("\rConfiguring executables...")
-
 OFF_ON = ["OFF", "ON"]
 
-exec_args = [
-    "-DBUILD_IFCGEOM="                 +OFF_ON["IfcGeom" in targets],
-    "-DBUILD_GEOMSERVER="              +OFF_ON["IfcGeomServer" in targets],
-    "-DBUILD_CONVERT="                 +OFF_ON["IfcConvert" in targets],
-    "-DBUILD_IFCPYTHON="               "OFF",
-    "-DCMAKE_INSTALL_PREFIX="          f"{DEPS_DIR}/install/ifcopenshell",
-]
-
 cmake_args = [
     "-DUSE_MMAP="                      "OFF",
     "-DBUILD_EXAMPLES="                "OFF",
@@ -699,6 +771,11 @@ cmake_args = [
     "-DADD_COMMIT_SHA="              +("On" if ADD_COMMIT_SHA else "Off")
 ]
 
+if "wasm" in flags:
+    # Boost is built by the build script so should not be found
+    # inside of the sysroot set by the emscriptem toolchain
+    cmake_args.append("-DWASM_BUILD=On")
+
 if "cgal" in targets:
     cmake_args.extend([
         "-DCGAL_INCLUDE_DIR="          f"{DEPS_DIR}/install/cgal-{CGAL_VERSION}/include",
@@ -750,20 +827,36 @@ if "hdf5" in targets:
         "-DHDF5_INCLUDE_DIR="          f"{DEPS_DIR}/install/hdf5-{HDF5_VERSION}/include",
         "-DHDF5_LIBRARY_DIR="          f"{DEPS_DIR}/install/hdf5-{HDF5_VERSION}/lib"
     ])
+else:
+    cmake_args.append("-DHDF5_SUPPORT=Off")
 
-run_cmake("", exec_args + cmake_args, cmake_dir=CMAKE_DIR, cwd=executables_dir)
+if not explicit_targets or {"IfcGeom", "IfcConvert", "IfcGeomServer"} & set(explicit_targets):
+    logger.info("\rConfiguring executables...")
 
-logger.info("\rBuilding executables...   ")
+    exec_args = [
+        "-DBUILD_IFCGEOM="                 +OFF_ON["IfcGeom" in targets],
+        "-DBUILD_GEOMSERVER="              +OFF_ON["IfcGeomServer" in targets],
+        "-DBUILD_CONVERT="                 +OFF_ON["IfcConvert" in targets],
+        "-DBUILD_IFCPYTHON="               "OFF",
+        "-DCMAKE_INSTALL_PREFIX="          f"{DEPS_DIR}/install/ifcopenshell",
+    ]
+    
+    run_cmake("", exec_args + cmake_args, cmake_dir=CMAKE_DIR, cwd=executables_dir)
 
-run([make, f"-j{IFCOS_NUM_BUILD_PROCS}"], cwd=executables_dir)
-run([make, "install/strip" if BUILD_CFG == "Release" else "install"], cwd=executables_dir)
+    logger.info("\rBuilding executables...   ")
+
+    run([make, f"-j{IFCOS_NUM_BUILD_PROCS}"], cwd=executables_dir)
+    run([make, "install/strip" if BUILD_CFG == "Release" else "install"], cwd=executables_dir)
 
 if "IfcOpenShell-Python" in targets:
     # On OSX the actual Python library is not linked against.
     ADDITIONAL_ARGS = ""
     if platform.system() == "Darwin":
         ADDITIONAL_ARGS = "-Wl,-flat_namespace,-undefined,suppress"
-
+        
+    if "wasm" in flags:
+        ADDITIONAL_ARGS = f"-Wl,-undefined,suppress -sSIDE_MODULE=2 -sEXPORTED_FUNCTIONS=_PyInit__ifcopenshell_wrapper"
+        
     os.environ["CXXFLAGS"] = f"{CXXFLAGS_MINIMAL} {ADDITIONAL_ARGS}"
     os.environ["CFLAGS"] = f"{CFLAGS_MINIMAL} {ADDITIONAL_ARGS}"
     os.environ["LDFLAGS"] = f"{LDFLAGS} {ADDITIONAL_ARGS}"
@@ -780,36 +873,58 @@ if "IfcOpenShell-Python" in targets:
 
         os.environ["PYTHON_LIBRARY_BASENAME"] = os.path.basename(python_library)
 
+        swig_when_built = []
+        if "swig" in targets:
+            swig_when_built.append(f"-DSWIG_EXECUTABLE={DEPS_DIR}/install/swig/bin/swig")
+
         run_cmake("",
             cmake_args + [
                 "-DPYTHON_LIBRARY="          +python_library,
-                "-DPYTHON_EXECUTABLE="       +python_executable,
+                *([f"-DPYTHON_EXECUTABLE={python_executable}"] if python_executable else []),
+                # *([f"-DPYTHON_MODULE_INSTALL_DIR={os.environ['PYTHONPATH']}/ifcopenshell"] if "wasm" in flags else []),
+                *(["-DPYTHON_MODULE_INSTALL_DIR="+os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "package"))] if "wasm" in flags else []),
                 "-DPYTHON_INCLUDE_DIR="      +python_include,
-                "-DSWIG_EXECUTABLE="         f"{DEPS_DIR}/install/swig/bin/swig",
                 "-DCMAKE_INSTALL_PREFIX="    f"{DEPS_DIR}/install/ifcopenshell/tmp",
-                "-DUSERSPACE_PYTHON_PREFIX=" +["Off", "On"][os.environ.get("PYTHON_USER_SITE", "").lower() in {"1", "on", "true"}]
-            ], cmake_dir=CMAKE_DIR, cwd=python_dir)
+                "-DUSERSPACE_PYTHON_PREFIX=" +["Off", "On"][os.environ.get("PYTHON_USER_SITE", "").lower() in {"1", "on", "true"}],
+                *swig_when_built],
+            cmake_dir=CMAKE_DIR, cwd=python_dir)
 
         logger.info(f"\rBuilding python {python_version} wrapper...   ")
 
         run([make, f"-j{IFCOS_NUM_BUILD_PROCS}", "_ifcopenshell_wrapper"], cwd=python_dir)
         run([make, "install/local"], cwd=os.path.join(python_dir, "ifcwrap"))
 
-        module_dir = os.path.dirname(run([python_executable, "-c", "import inspect, ifcopenshell; print(inspect.getfile(ifcopenshell))"]))
+        if python_executable:
+            module_dir = os.path.dirname(run([python_executable, "-c", "import inspect, ifcopenshell; print(inspect.getfile(ifcopenshell))"]))
 
-        if platform.system() != "Darwin":
-            # TODO: This symbol name depends on the Python version?
-            run([strip, "-s", "-K", "PyInit__ifcopenshell_wrapper", "_ifcopenshell_wrapper.so"], cwd=module_dir)
-        return module_dir
+            if platform.system() != "Darwin":
+                if BUILD_CFG == "Release":
+                    # TODO: This symbol name depends on the Python version?
+                    run([strip, "-s", "-K", "PyInit__ifcopenshell_wrapper", "_ifcopenshell_wrapper.so"], cwd=module_dir)
 
+            return module_dir
 
-    if USE_CURRENT_PYTHON_VERSION:
-        python_info = sysconfig.get_paths()
-        python_lib = os.path.join(
-            sysconfig.get_config_var('LIBDIR'), 
-            sysconfig.get_config_var('multiarchsubdir').replace("/", ""), 
-            sysconfig.get_config_var("INSTSONAME")
+    if "wasm" in flags:
+        compile_python_wrapper(
+            f"{os.environ['PYMAJOR']}.{os.environ['PYMINOR']}.{os.environ['PYMICRO']}",
+            f"{os.environ['TARGETINSTALLDIR']}/lib/libpython{os.environ['PYMAJOR']}.{os.environ['PYMINOR']}.a",
+            os.environ['PYTHONINCLUDE'],
+            None
         )
+    
+    elif USE_CURRENT_PYTHON_VERSION:
+        python_info = sysconfig.get_paths()
+
+        py_path_components = [
+            sysconfig.get_config_var('LIBDIR'),
+            sysconfig.get_config_var("INSTSONAME")
+        ]
+
+        if sysconfig.get_config_var('multiarchsubdir'):
+            py_path_components.insert(1, sysconfig.get_config_var('multiarchsubdir').replace("/", ""))
+
+        python_lib = os.path.join(*py_path_components)
+
         compile_python_wrapper(platform.python_version(), python_lib, python_info["include"], sys.executable)
     else:
         for python_version in PYTHON_VERSIONS:

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/CITATION.cff

@@ -0,0 +1,20 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: bcf
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - name: "IfcOpenShell contributors"
+repository-code: >-
+  https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.7.0/src/bcf
+abstract: >-
+  Library to read and write BCF-XML and query OpenCDE
+  BCF-API modules
+keywords:
+  - BCF
+  - IFC
+license: LGPL-3.0-or-later

src/bcf/Makefile

@@ -0,0 +1,30 @@
+VERSION:=`date '+%y%m%d'`
+SED:=sed -i
+ifeq ($(UNAME_S),Darwin)
+SED:=sed -i '' -e
+endif
+
+.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: dist
+dist:
+	rm -rf dist
+	$(SED) "s/999999/$(VERSION)/" pyproject.toml
+	python -m build
+	$(SED) "s/$(VERSION)/999999/" pyproject.toml
+
+# .PHONY
+# api:
+#     openapi-python-client generate --url https://api.swaggerhub.com/apis/buildingSMART/BCF/3.0

src/bcf/README.md

@@ -1,101 +1,5 @@
 # bcf
 
-A simple Python implementation of BCF. The data model is described in `data.py`.
-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.
-
-## bcfxml
-
-The `bcfxml` module lets you interact with the BCF-XML standard.
-
-```python
-from bcf import bcfxml
-
-
-# Load a project
-bcfxml = bcfxml.load("/path/to/file.bcf")
-
-
-# The project is also stored in the module
-# project == bcfxml.project
-project=bcfxml.get_project()
-print(project.name)
-
-# To edit a project, just modify the object directly
-bcfxml.project.name = "New name"
-bcfxml.edit_project()
-
-# The BCF file is extracted to this temporary directory
-print(bcfxml.filepath)
-
-# Get a dictionary of topics
-topics = bcfxml.get_topics()
-
-# 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)
-
-    # Fetch extra data about a topic
-    header = bcfxml.get_header(guid)
-    comments = bcfxml.get_comments(guid)
-    viewpoints = bcfxml.get_viewpoints(guid)
-
-    # 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)
-```
-
-## bcfapi
-
-The `bcfapi` module lets you interact with the BCF-API standard.
-
-```python
-from bcf.v3.bcfapi import FoundationClient, BcfClient
-
-foundation_client = FoundationClient("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "OPENCDE_BASEURL")
-auth_methods = foundation_client.get_auth_methods()
-
-# Our library currently only implements the authorization_code flow
-if "authorization_code" in auth_methods:
-    foundation_client.login()
-
-bcf_client = BcfClient(foundation_client)
-
-versions = foundation_client.get_versions()
-for version in versions:
-if "3.0" in versions:
-    if version["api_id"] == "bcf" and version["version_id"] == "3.0":
-        bcf_client.set_version(version)
-
-data = bcf_client.get_projects()
-print(data)
-project_id = data[0]["project_id"]
-print(project_id)
-data = bcf_client.get_project(project_id)
-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.
+A simple Python implementation of the BCF standard. Manipulation of BCF-XML is
+available via `bcfxml.py` and manipulation of BCF-API is available via
+`bcfapi.py`.

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"]
+dependencies = [
+    "xsdata",
+    "numpy",
+    "ifcopenshell",
+]
+version = "0.0.999999"
+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,306 @@
+"""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)
+        return 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)
+        return 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.filename = ""
-        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"