libraryfemtherm 0.18.0__tar.gz

libraryfemtherm-0.18.0/.clang-format

@@ -0,0 +1,86 @@
+AccessModifierOffset: -4
+AlignAfterOpenBracket: 'Align'
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: 'Left'
+AlignOperands: true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: 'None'
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: 'None'
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: true
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+  AfterClass: true
+  AfterControlStatement: true
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  AfterExternBlock: true
+  BeforeCatch: true
+  BeforeElse: true
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+BreakBeforeBinaryOperators: 'NonAssignment' 
+BreakBeforeBraces: 'Custom'
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true 
+BreakConstructorInitializers: 'AfterColon'
+ColumnLimit: 120
+#CommentPragmas: '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 2
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat: false 
+FixNamespaceComments: true
+#****************** This may break the builds a lot because of include order issues*******************
+#IncludeBlocks: 'Regroup' 
+#IncludeCategories: 
+#  - Regex: 'stdafx\.h'
+#    Priority: '-1'
+#****************** END INCLUDE ORDER STRUCTURE*******************************************************
+IndentCaseLabels: true 
+IndentPPDirectives: 'AfterHash' 
+IndentWrappedFunctionNames: true  
+IndentWidth: 4
+KeepEmptyLinesAtTheStartOfBlocks: false
+Language: 'Cpp' 
+MaxEmptyLinesToKeep: 2
+PointerAlignment: 'Middle'   
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true 
+#SpaceBeforeCtorInitializerColon: true #gives error when trying to run
+#SpaceBeforeInheritanceColon: true #gives error when trying to run
+SpaceBeforeParens: 'Never' 
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 3
+SpacesInAngles: false
+#SpaceBeforeRangeBasedForLoopColon: false #gives error when trying to run
+SpacesInCStyleCastParentheses: false 
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false     
+
+SortIncludes: false  # Setting this to true may break the builds because of include order issues
+SortUsingDeclarations: false
+
+UseTab: Never
+
+
+NamespaceIndentation: 'All'
+
+Standard: Cpp11

libraryfemtherm-0.18.0/.github/workflows/build.yml

@@ -0,0 +1,133 @@
+name: Build and test
+
+on: [push, pull_request]
+
+env:
+  BUILD_TYPE: Release
+
+jobs:
+  windows:
+    name: ${{ matrix.os }}-${{ matrix.arch }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-2022]
+        arch: [x86, x64]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        if: matrix.arch == 'x64'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install pytest
+        if: matrix.arch == 'x64'
+        run: pip install pytest
+
+      - name: Configure CMake (with Python bindings)
+        if: matrix.arch == 'x64'
+        run: >
+          cmake -B ${{github.workspace}}/build
+          -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+          -DBUILD_PYTHON_BINDINGS=ON
+          -DPython3_EXECUTABLE=${{ env.pythonLocation }}/python
+
+      - name: Configure CMake (C++ only)
+        if: matrix.arch != 'x64'
+        run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+      - name: Test
+        working-directory: ${{github.workspace}}/build
+        run: ctest -C RELEASE -V
+
+  mac:
+    name: ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install pytest
+        run: pip install pytest
+
+      - name: Configure CMake
+        run: >
+          cmake -B ${{github.workspace}}/build
+          -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+          -DBUILD_PYTHON_BINDINGS=ON
+          -DPython3_EXECUTABLE=${{ env.pythonLocation }}/python
+
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+      - name: Test
+        working-directory: ${{github.workspace}}/build
+        run: ctest -C RELEASE -V
+
+  linux:
+    name: ${{ matrix.os }}-${{ matrix.arch }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04]
+        arch: [x86_64, aarch64]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install QEMU for aarch64 emulation
+        uses: docker/setup-qemu-action@v2
+        with:
+          platforms: all
+
+      - name: Upgrade gcc
+        run: sudo apt-get install -y gcc g++
+
+      - name: Set up Python
+        if: matrix.arch == 'x86_64'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install pytest
+        if: matrix.arch == 'x86_64'
+        run: pip install pytest
+
+      - name: Configure CMake (with Python bindings)
+        if: matrix.arch == 'x86_64'
+        run: >
+          cmake -B ${{github.workspace}}/build
+          -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+          -DBUILD_PYTHON_BINDINGS=ON
+          -DPython3_EXECUTABLE=${{ env.pythonLocation }}/python
+
+      - name: Configure CMake (C++ only)
+        if: matrix.arch != 'x86_64'
+        run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+      - name: Test
+        working-directory: ${{github.workspace}}/build
+        run: ctest -C RELEASE -V

libraryfemtherm-0.18.0/.github/workflows/workflow.yml

@@ -0,0 +1,69 @@
+name: Build and publish
+
+on:
+  push:
+    tags:
+      - "Version_*"
+  workflow_dispatch:
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, windows-2022, macos-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v2.21
+        env:
+          CIBW_BUILD_FRONTEND: build[uv]
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish:
+    name: Publish to PyPI
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-24.04
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

libraryfemtherm-0.18.0/CMakeLists.txt

@@ -0,0 +1,159 @@
+cmake_minimum_required(VERSION 3.8)
+
+option(BUILD_PYTHON_BINDINGS "Build Python bindings via pybind11" OFF)
+
+# Python extensions require /MD (dynamic CRT); static library uses /MT
+if(BUILD_PYTHON_BINDINGS)
+    set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+endif()
+
+project(LibraryFEMTHERM VERSION 0.18.0 LANGUAGES CXX)
+set(target_name LibraryFEMTHERM)
+
+include(cmake/LibraryFEMTHERMProjectMacros.cmake)
+include(cmake/LibraryFEMTHERMinternal_utils.cmake)
+include(cmake/LibraryFEMTHERMCompilerFlags.cmake)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+
+set(GLOBAL_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
+
+# Sets global output directory for single configuration
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${GLOBAL_OUTPUT_PATH})
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${GLOBAL_OUTPUT_PATH})
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${GLOBAL_OUTPUT_PATH})
+
+# google test will not be created by this project if this is not the main project. Main project is expected to handle google test.
+get_directory_property(hasParent PARENT_DIRECTORY)
+
+if(hasParent)
+    set(BUILD_LibraryFEMTHERM_TESTING OFF)
+    set(DOWNLOAD_GTEST OFF)
+    if(BUILD_TESTING STREQUAL ON) # Parent testing is ON
+        set(BUILD_KeffC_TESTING ON)
+    endif()
+else()
+    option(BUILD_LibraryFEMTHERM_TESTING "Build testing targets" ON)
+    set(DOWNLOAD_GTEST ON)
+endif()
+
+# Download external projects automatically
+option(BUILD_FileParse_tests "Build the FileParse tests" OFF)
+
+include(FetchContent)
+
+set(LBNLCPPCommon_Branch "v0.15")
+
+if(NOT TARGET LBNLCPPCommon)
+    FetchContent_Declare(
+            LBNLCPPCommon
+            GIT_REPOSITORY https://github.com/LBNL-ETA/LBNLCPPCommon.git
+            GIT_TAG ${LBNLCPPCommon_Branch}
+    )
+    FetchContent_MakeAvailable(LBNLCPPCommon)
+endif()
+FetchContent_GetProperties(LBNLCPPCommon)
+
+set(FileParse_Branch "Version_1.1.2")
+
+if(NOT TARGET FileParse)
+    FetchContent_Declare(
+        FileParse
+        GIT_REPOSITORY https://github.com/LBNL-ETA/FileParse.git
+        GIT_TAG ${FileParse_Branch}
+    )
+    FetchContent_MakeAvailable(FileParse)
+endif()
+FetchContent_GetProperties(FileParse)
+
+set(miniz_Branch "89d7a5f6c3ce8893ea042b0a9d2a2d9975589ac9")
+
+if(NOT TARGET miniz)
+    FetchContent_Declare(
+        miniz
+        GIT_REPOSITORY https://github.com/richgel999/miniz
+        GIT_TAG ${miniz_Branch}
+    )
+    FetchContent_MakeAvailable(miniz)
+endif()
+
+if(BUILD_PYTHON_BINDINGS)
+    find_package(Python3 REQUIRED COMPONENTS Interpreter Development.Module)
+    FetchContent_Declare(pybind11
+        GIT_REPOSITORY https://github.com/pybind/pybind11.git
+        GIT_TAG v2.13.6)
+    FetchContent_MakeAvailable(pybind11)
+endif()
+
+if(DOWNLOAD_GTEST)
+    if(MSVC)
+        set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+    endif()
+    if(NOT TARGET gtest)
+        FetchContent_Declare(
+            googletest
+            GIT_REPOSITORY https://github.com/google/googletest.git
+            GIT_TAG v1.13.0
+        )
+        FetchContent_MakeAvailable(googletest)
+
+        include_directories(${gtest_SOURCE_DIR}/include)
+    endif()
+endif()
+
+# Generate dependency diagram from template
+configure_file(
+    ${CMAKE_CURRENT_SOURCE_DIR}/doc/LibraryFEMTHERM.md.in
+    ${CMAKE_CURRENT_SOURCE_DIR}/doc/LibraryFEMTHERM.md
+)
+
+file(GLOB_RECURSE SOURCES_HXX "src/*.hxx")
+file(GLOB_RECURSE SOURCES_CXX "src/*.cxx")
+LIST(APPEND SOURCES ${SOURCES_HXX} ${SOURCES_CXX})
+
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR} FILES ${SOURCES})
+
+add_library(${target_name} STATIC ${SOURCES})
+
+set_target_properties(${target_name} PROPERTIES LINKER_LANGUAGE CXX)
+
+target_include_directories(${target_name}
+        PUBLIC
+        ${CMAKE_CURRENT_SOURCE_DIR}/src
+        ${fileparse_SOURCE_DIR}/include
+        ${LBNLCPPCommon_SOURCE_DIR}/include
+)
+
+target_link_libraries(${target_name} PRIVATE FileParse LBNLCPPCommon miniz)
+
+set_property(TARGET ${target_name} PROPERTY FileParse_Branch ${FileParse_Branch})
+set_property(TARGET ${target_name} PROPERTY miniz_Branch ${miniz_Branch})
+
+enable_testing()
+
+if(BUILD_LibraryFEMTHERM_TESTING)
+    add_subdirectory(tst)
+    # Add include directories for tests if necessary
+    set(TEST_DATA_DIR "${CMAKE_CURRENT_SOURCE_DIR}/tst")
+    target_compile_definitions(LibraryFEMTHERM_tests PRIVATE TEST_DATA_DIR="${TEST_DATA_DIR}")
+endif()
+
+if(BUILD_PYTHON_BINDINGS)
+    add_subdirectory(python)
+endif()
+
+config_compiler_and_linker_LibraryFEMTHERM()
+
+if (MSVC)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /EHsc /utf-8")
+    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /utf-8")
+    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /utf-8")
+endif()
+
+# Warning levels
+if (MSVC)
+    add_compile_options(/W4)
+else()
+    add_compile_options(-Wall -Wextra -Wpedantic)
+endif()

libraryfemtherm-0.18.0/CMakePresets.json

@@ -0,0 +1,23 @@
+{
+  "version": 6,
+  "configurePresets": [
+    {
+      "name": "default",
+      "displayName": "C++ only",
+      "binaryDir": "${sourceDir}/build/${presetName}",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release"
+      }
+    },
+    {
+      "name": "python",
+      "displayName": "C++ with Python bindings",
+      "binaryDir": "${sourceDir}/build/${presetName}",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "BUILD_PYTHON_BINDINGS": "ON",
+        "BUILD_LibraryFEMTHERM_TESTING": "ON"
+      }
+    }
+  ]
+}

libraryfemtherm-0.18.0/LICENSE

@@ -0,0 +1,44 @@
+*** License Agreement ***
+
+Berkeley Lab LibraryFEMTHERM Copyright (c) 2025, The
+Regents of the University of California, through Lawrence Berkeley National
+Laboratory (subject to receipt of any required approvals from the U.S.
+Dept. of Energy).  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+(1) Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+(2) Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+(3) Neither the name of the University of California, Lawrence Berkeley
+National Laboratory, U.S. Dept. of Energy nor the names of its contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+You are under no obligation whatsoever to provide any bug fixes, patches,
+or upgrades to the features, functionality or performance of the source
+code ("Enhancements") to anyone; however, if you choose to make your
+Enhancements available either publicly, or directly to Lawrence Berkeley
+National Laboratory, without imposing a separate written license agreement
+for such Enhancements, then you hereby grant the following license: a
+non-exclusive, royalty-free perpetual license to install, use, modify,
+prepare derivative works, incorporate into other computer software,
+distribute, and sublicense such enhancements or derivative works thereof,
+in binary and source code form.

libraryfemtherm-0.18.0/PKG-INFO

@@ -0,0 +1,185 @@
+Metadata-Version: 2.2
+Name: libraryfemtherm
+Version: 0.18.0
+Summary: Python bindings for LibraryFEMTherm – THMZ file parsing and thermal simulation data
+Author-Email: LBNL-ETA <SimonMN@lbl.gov>
+License: *** License Agreement ***
+         
+         Berkeley Lab LibraryFEMTHERM Copyright (c) 2025, The
+         Regents of the University of California, through Lawrence Berkeley National
+         Laboratory (subject to receipt of any required approvals from the U.S.
+         Dept. of Energy).  All rights reserved.
+         
+         Redistribution and use in source and binary forms, with or without
+         modification, are permitted provided that the following conditions are met:
+         
+         (1) Redistributions of source code must retain the above copyright notice,
+         this list of conditions and the following disclaimer.
+         
+         (2) Redistributions in binary form must reproduce the above copyright
+         notice, this list of conditions and the following disclaimer in the
+         documentation and/or other materials provided with the distribution.
+         
+         (3) Neither the name of the University of California, Lawrence Berkeley
+         National Laboratory, U.S. Dept. of Energy nor the names of its contributors
+         may be used to endorse or promote products derived from this software
+         without specific prior written permission.
+         
+         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+         ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+         LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+         CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+         SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+         INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+         CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+         ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+         POSSIBILITY OF SUCH DAMAGE.
+         
+         You are under no obligation whatsoever to provide any bug fixes, patches,
+         or upgrades to the features, functionality or performance of the source
+         code ("Enhancements") to anyone; however, if you choose to make your
+         Enhancements available either publicly, or directly to Lawrence Berkeley
+         National Laboratory, without imposing a separate written license agreement
+         for such Enhancements, then you hereby grant the following license: a
+         non-exclusive, royalty-free perpetual license to install, use, modify,
+         prepare derivative works, incorporate into other computer software,
+         distribute, and sublicense such enhancements or derivative works thereof,
+         in binary and source code form.
+         
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: C++
+Classifier: Topic :: Scientific/Engineering
+Project-URL: Homepage, https://github.com/LBNL-ETA/LibraryFEMTherm
+Project-URL: Repository, https://github.com/LBNL-ETA/LibraryFEMTherm
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# LibraryFEMTherm
+
+C++20 static library for reading, writing, and manipulating THERM (.thmz) files. Provides data structures and serialization for thermal models, materials, boundary conditions, gases, glazing systems, and CMA data. Optional Python bindings via pybind11.
+
+## Requirements
+
+- CMake 3.8+
+- C++20 compiler (MSVC 2022, GCC 11+, Clang 14+)
+- Ninja or Visual Studio generator
+- Python 3.11+ (only when building Python bindings)
+
+## Building
+
+### C++ only (default)
+
+```bash
+cmake --preset default
+cmake --build build/default --config Release
+```
+
+### C++ with Python bindings
+
+```bash
+cmake --preset python
+cmake --build build/python --config Release
+```
+
+### Manual configuration (Visual Studio generator)
+
+```bash
+cmake -G "Visual Studio 17 2022" -A x64 -B build -DCMAKE_BUILD_TYPE=Release
+cmake --build build --config Release
+```
+
+Add `-DBUILD_PYTHON_BINDINGS=ON` to include Python bindings.
+
+## CMake presets
+
+| Preset    | Description                  | Python bindings | C++ tests |
+|-----------|------------------------------|-----------------|-----------|
+| `default` | C++ only                     | OFF             | ON        |
+| `python`  | C++ with Python bindings     | ON              | ON        |
+
+CLion and VS Code automatically detect these presets.
+
+## Running tests
+
+```bash
+ctest --test-dir build/python -C Release -V
+```
+
+This runs both C++ Google Tests and Python pytest tests (when built with the `python` preset).
+
+## CMake options
+
+| Option                        | Default | Description                          |
+|-------------------------------|---------|--------------------------------------|
+| `BUILD_PYTHON_BINDINGS`       | OFF     | Build Python bindings via pybind11   |
+| `BUILD_LibraryFEMTHERM_TESTING` | ON   | Build C++ test targets               |
+
+## Python bindings
+
+Install from PyPI:
+
+```bash
+pip install libraryfemtherm
+```
+
+Or build from source with `BUILD_PYTHON_BINDINGS=ON` (see above).
+
+```python
+import pylibraryfemtherm as fem
+
+# Load a THMZ file
+model = fem.load_model_from_zip_file("sample-sill.thmz")
+print(f"Polygons:   {len(model.polygons)}")
+print(f"Boundaries: {len(model.boundary_conditions)}")
+
+# Save to XML string
+xml = fem.save_model_to_string(model)
+
+# Save to a new THMZ file
+fem.save_model_to_zip_file(model, "output.thmz")
+
+# Work with ZIP contents directly
+contents = fem.zip.unzip_files("sample.thmz", [fem.zip.MATERIALS_FILE_NAME])
+db = fem.MaterialsDB()
+db.load_from_string(contents[fem.zip.MATERIALS_FILE_NAME])
+```
+
+For comprehensive Python API documentation with examples, see [doc/python.md](doc/python.md).
+
+## Project structure
+
+```
+src/
+  BCSteadyState/     # Steady-state boundary conditions
+  BCTransient/       # Transient boundary conditions
+  CMA/               # CMA (Component Modeling Approach) data
+  Common/            # Shared utilities
+  Gases/             # Gas properties and mixtures
+  Materials/         # Material definitions (solid, cavity, radiation)
+  THMZ/              # ThermModel, geometry, preferences, properties, zip I/O
+  LibraryUtilities/  # Common helpers
+  Schemas/           # XML/JSON schemas
+python/
+  src/               # pybind11 binding source files
+  tests/             # pytest test suite
+tst/
+  units/             # C++ Google Test files
+  products/          # Test THMZ data files
+cmake/               # CMake macros and compiler config
+```
+
+## Dependencies (fetched automatically)
+
+- [FileParse](https://github.com/LBNL-ETA/FileParse) - XML/JSON serialization
+- [LBNLCPPCommon](https://github.com/LBNL-ETA/LBNLCPPCommon) - Common utilities
+- [miniz](https://github.com/richgel999/miniz) - ZIP compression
+- [pybind11](https://github.com/pybind/pybind11) v2.13.6 - Python bindings (optional)
+- [Google Test](https://github.com/google/googletest) v1.13.0 - Testing (optional)