Skip to content

Installation

Package

Use Python 3.11 or 3.12 on Linux x86-64 or Linux inside Windows WSL2. These are the Python versions exercised by the existing complete release gate. Keep a separate environment from OpenFIQA and QualSight because the canonical runtime pins intentionally differ.

python -m pip install ofiqpy

The 0.2.0 numerical profile uses these runtime dependency versions:

Package Version
numpy >=1.23,<2
opencv-python-headless ==4.5.5.64
onnxruntime ==1.18.1

The supported numerical profile uses CPU execution. Initializing the pipeline disables OpenCV's process-wide optimized kernels to match the tested OFIQ OpenCV 4.5.5 CPU path; see Architecture before sharing a process with another OpenCV workload.

Exact OFIQ v1.1.0 data profile

Models are not bundled. For an already authorized local profile, no C++ toolchain or download is required:

export OFIQPY_OFIQ_DATA="$AUTHORIZED_OFIQ_DATA"
python -m ofiqpy.config

To acquire the upstream profile explicitly, review its model licenses first. The following model-only route uses the URL and layout in the pinned OFIQ build without compiling the native reference. It needs git, curl, and unzip.

git clone --branch v1.1.0 https://github.com/BSI-OFIQ/OFIQ-Project.git ../OFIQ-Project
curl --fail --location --output OFIQ-MODELS.zip \
  https://standards.iso.org/iso-iec/29794/-5/ed-1/en/OFIQ-MODELS.zip
unzip -n OFIQ-MODELS.zip -d ../OFIQ-Project/data
export OFIQPY_OFIQ_ROOT="$(cd ../OFIQ-Project && pwd)"
export OFIQPY_OFIQ_DATA="$OFIQPY_OFIQ_ROOT/data"
python -m ofiqpy.config

Initialization verifies the canonical config SHA-256 and twelve model SHA-256/size pairs. It fails closed for a newer OFIQ checkout, a locally edited JAXN file, a partial download, or substituted weights.

Runtime check on a real BSI image

Obtain the BSI images separately under their terms before this example:

curl --fail --location --output OFIQ-IMAGES.zip \
  https://standards.iso.org/iso-iec/29794/-5/ed-1/en/OFIQ-IMAGES.zip
unzip -n OFIQ-IMAGES.zip -d "$OFIQPY_OFIQ_DATA/tests"
python -c "import ofiqpy; print(ofiqpy.__version__)"
ofiqpy \
  -i "$OFIQPY_OFIQ_DATA/tests/images/r-01-frontal.png" \
  -o assessment.csv

Only the strict live-C++ comparison needs the native reference build: (cd "$OFIQPY_OFIQ_ROOT/scripts" && sh build.sh). Follow Conformance for that separate gate and upstream build prerequisites. No pandas dependency is required. Model configuration checks are not new conformance evidence. Version 0.2.2 changes build metadata and contract tests, not this runtime profile. Release artifacts require the complete real-data CI gate.