pyhyperiso 1.0.0

Hyperiso Python binding (C++ backend via pybind11)

HyperIso core and Python package

This directory contains the buildable HyperIso package:

• core/ - C++20 backend, CMake build system, CLI and tests;
• pyhyperiso/ - Python package wrapping the C++ backend;
• examples_cpp/ - C++ examples built against an installed HyperIso package;
• examples_python/ - Python examples using pyhyperiso;
• pyproject.toml - Python packaging entry point based on scikit-build-core.

Build the C++ core

From the repository root:

cmake -S Hyperiso/Hyperiso/core -B build \
  -G Ninja \
  -DCMAKE_BUILD_TYPE=Release \
  -DBUILD_WITH_CLI=ON

cmake --build build -j
cmake --install build --prefix "$HOME/.local"

Useful options:

Option	Default	Purpose
ENABLE_TESTS	OFF	Build CTest tests.
BUILD_WITH_APP	OFF	Build development and benchmark executables.
BUILD_WITH_CLI	OFF	Build the hyperiso-ui command-line executable.
BUILD_WITH_PYTHON	OFF	Build the Python extension from the CMake tree.
BUILD_WITH_MARTY	OFF	Enable MARTY integration.
BUILD_WITH_SOFTSUSY	OFF	Enable bundled SOFTSUSY fallback; Python/C++ can also use a runtime softpoint.x path.
ENABLE_CLANG_TIDY	OFF	Run clang-tidy during the build.
ENABLE_ADDRESS_SANITIZER	OFF	Enable AddressSanitizer.
ENABLE_UNDEFINED_SANITIZER	OFF	Enable UndefinedBehaviorSanitizer.

Run tests

cmake -S Hyperiso/Hyperiso/core -B build \
  -G Ninja \
  -DCMAKE_BUILD_TYPE=Debug \
  -DENABLE_TESTS=ON

cmake --build build -j
ctest --test-dir build --output-on-failure

Labels can be used to select a subset:

ctest --test-dir build -L common --output-on-failure
ctest --test-dir build -L database --output-on-failure
ctest --test-dir build -L statistic --output-on-failure

Heavy validation/comparison tests are opt-in:

cmake -S Hyperiso/Hyperiso/core -B build-comparison \
  -DENABLE_TESTS=ON \
  -DHYPERISO_BUILD_COMPARISON_TESTS=ON

Install the Python package

python -m pip install --upgrade pip
python -m pip install ./Hyperiso/Hyperiso

Editable development install:

python -m pip install -e ./Hyperiso/Hyperiso

Complete development environment:

python -m pip install -e "./Hyperiso/Hyperiso[test,dev]"

HyperIso uses pybind11; the PyPI package named pybind is unrelated.

Run Python tests:

python -m pip install -e "./Hyperiso/Hyperiso[test]"
python -m pytest Hyperiso/Hyperiso/pyhyperiso/test

Build examples against an installed package

cmake -S Hyperiso/Hyperiso/examples_cpp -B build-examples \
  -G Ninja \
  -DCMAKE_PREFIX_PATH="$HOME/.local"

cmake --build build-examples -j

Public interfaces

Interface	Entry point
C++ API	headers and CMake targets exported by the C++ install.
Python API	pyhyperiso.Common, pyhyperiso.Core, pyhyperiso.Wilson, pyhyperiso.Observable, pyhyperiso.Statistic; pyhyperiso.Core.DatabaseWriter exports the initialized database.
CLI	hyperiso-ui, built with -DBUILD_WITH_CLI=ON.
Dash GUI	GHyperiso/HyperisoDashGUI.

Versioning

The C++ project, Python package and release tag should use the same semantic version. For example:

CMake project version: 1.0.0
Python package version: 1.0.0
Git tag: v1.0.0

Update all version locations in the same pull request.