Portable, solver-independent simulation evidence, diagnosis, and resonator analysis
Project description
QResAudit v2
QResAudit turns electromagnetic simulation and measurement evidence into portable, auditable research records. The HFSS evidence/export boundary remains the v1 foundation; real-solver validation claims remain separately gated. V2 adds solver-neutral manifests and offline research engines for diagnosis, design, digital twins, quantum-device estimates, fabrication variation, surrogates, reproducibility packages, and execution artifacts.
Architecture
qresauditis the portable core: schemas, checksums, Touchstone/CSV/HDF5 readers, semantic validation, and CLI.qresaudit_hfssis the licensed boundary: read-only project inspection and documented PyAEDT export calls.- A completed bundle contains raw vendor exports, canonical tables/HDF5, provenance, a manifest, and checksums.
Install
python -m venv .venv
.\.venv\Scripts\python -m pip install -e ".[dev]"
For a compatible AEDT/PyAEDT environment:
.\.venv\Scripts\python -m pip install -e ".[hfss]"
The package dependency currently permits PyAEDT 1.3.x, but no AEDT/PyAEDT pair is
claimed compatible until its licensed matrix passes. AEDT Student must run
graphically; set student_version: true and non_graphical: false.
Quick start
Validate a portable bundle:
qresaudit validate testdata/synthetic/valid_driven_minimal
qresaudit benchmark
qresaudit analyze path/to/real/bundle
qresaudit report path/to/real/bundle --output report
qresaudit show testdata/synthetic/valid_driven_minimal
qresaudit schema manifest
The supported Python surface is intentionally small:
from qresaudit.api import analyze_resonator, generate_report, load_bundle, validate_bundle
QResAudit runs locally and does not call an LLM or hosted inference service.
See docs/api_stability.md for compatibility guarantees.
The source distribution contains no proprietary project, geometry, solved result, or
institutional design. Researchers provide their own evidence bundles locally.
Inspect and export a solved project:
qresaudit-hfss inspect resonator.aedt --design Resonator --json
qresaudit-hfss export resonator.aedt --config examples/driven_export.yaml --output exports/run
The exporter never solves or modifies geometry, setups, ports, boundaries, or materials.
It stages to OUTPUT.partial, validates, and publishes atomically. Use --force to
replace an existing bundle; replacement keeps a recoverable backup until final
validation succeeds. Use keep_failed: true to retain failed staging data.
The default session starts and owns a new AEDT desktop. Attaching is opt-in through
project.attach_process_id. QResAudit never closes an attached AEDT desktop and closes
only projects that it opened during the current export session. Projects that were
already loaded remain open. Lock removal is forbidden.
Evidence requirements are explicit:
minimal: primary network or eigenmode evidence;standard: primary evidence plus convergence and mesh statistics;strict: standard evidence plus fields required by the solution contract.
v2 capabilities and evidence boundary
The portable v2 core supports manifest-based imports for HFSS, Palace, COMSOL, CST, Sonnet, openEMS, and Elmer; deterministic diagnosis; measurement comparison; quantum-device estimates; fabrication yield; local surrogate and inverse-design models; reproducibility packages; offline Slurm/AWS/cluster job artifacts; and benchmarks. Adapters describe capabilities and missing evidence rather than fabricating solver results. Tests do not contact solvers, cloud, or HPC systems. Reports state when only local rules were used.
The master-roadmap research layer adds a Gaussian-process active-learning engine,
correlated fabrication uncertainty and yield analysis, portable parametric CPW
designs, experiment-backed digital-twin calibration, first-order multiphysics
perturbations, citation-preserving knowledge records, deterministic natural-language
planning, guarded agent tool contracts, resumable budgeted loops, and reproducible
design reports. These are portable research APIs; proprietary solver execution still
requires an explicit adapter, user approval, a license, and validated output evidence.
See docs/v4-platform.md.
Limitations
QResAudit audits evidence; it does not prove a model is physically correct. Portable adapters ingest exported files and manifests, not proprietary solver databases. Quantum-circuit functions are documented analytic approximations, and surrogate predictions are only as credible as their training evidence. Public CI proves offline behavior and mocked lifecycle safety, not licensed HFSS or cross-solver validation.
Testing
ruff format --check .
ruff check .
mypy src
pytest tests/unit tests/offline_integration tests/physics --cov=qresaudit
qresaudit benchmark
Publishing
Production packages are built and uploaded through secretless PyPI Trusted
Publishing when a GitHub Release is published. See
docs/releasing.md for the protected-environment setup and
release checklist.
Licensed tests are marked hfss and run only on a private Windows runner with approved
fixture projects. The runner must configure QRESAUDIT_HFSS_DRIVEN_CONFIG,
QRESAUDIT_HFSS_EIGENMODE_CONFIG, and, for attachment safety,
QRESAUDIT_HFSS_EXISTING_PROCESS_ID. Missing configuration produces visible skips,
not passing evidence. No real golden bundle has been published yet, so a
research-grade solver-validation claim remains gated by
examples/golden/CONTRACT.md.
Package publication is not a claim that this independent evidence gate has passed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file qresaudit-2.0.0.tar.gz.
File metadata
- Download URL: qresaudit-2.0.0.tar.gz
- Upload date:
- Size: 165.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d8af5e51a350ecff77e99fc9a0da5edaebdb744fb37794f96bcd39448c42f04b
|
|
| MD5 |
897512d591f6100f5abf7888b63d95ca
|
|
| BLAKE2b-256 |
4ea71e7ecdeaa087d3d0c32684f77cf7b02713ee516e63eaa72b395e4c7f205c
|
Provenance
The following attestation bundles were made for qresaudit-2.0.0.tar.gz:
Publisher:
publish-pypi.yml on Ahmadh1231/QResAudit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qresaudit-2.0.0.tar.gz -
Subject digest:
d8af5e51a350ecff77e99fc9a0da5edaebdb744fb37794f96bcd39448c42f04b - Sigstore transparency entry: 2255163413
- Sigstore integration time:
-
Permalink:
Ahmadh1231/QResAudit@a13870329793bf8faacb55fc880cbe55d1e2f1bb -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Ahmadh1231
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@a13870329793bf8faacb55fc880cbe55d1e2f1bb -
Trigger Event:
workflow_run
-
Statement type:
File details
Details for the file qresaudit-2.0.0-py3-none-any.whl.
File metadata
- Download URL: qresaudit-2.0.0-py3-none-any.whl
- Upload date:
- Size: 138.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4326f31e9caa792ceed7c3c42bbdc73d592ac5a0100c29230fa1bf1b26de6e1c
|
|
| MD5 |
aa80dd20469009322dfe222142819ca7
|
|
| BLAKE2b-256 |
e95542b9ef238a080bd1a335e6a35162a10ba733d59139200cd50dc9d097d39a
|
Provenance
The following attestation bundles were made for qresaudit-2.0.0-py3-none-any.whl:
Publisher:
publish-pypi.yml on Ahmadh1231/QResAudit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
qresaudit-2.0.0-py3-none-any.whl -
Subject digest:
4326f31e9caa792ceed7c3c42bbdc73d592ac5a0100c29230fa1bf1b26de6e1c - Sigstore transparency entry: 2255163418
- Sigstore integration time:
-
Permalink:
Ahmadh1231/QResAudit@a13870329793bf8faacb55fc880cbe55d1e2f1bb -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Ahmadh1231
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@a13870329793bf8faacb55fc880cbe55d1e2f1bb -
Trigger Event:
workflow_run
-
Statement type: