Get started

Install

git clone https://github.com/SuperconducTED/superconducted-noise-engine.git
cd superconducted-noise-engine
python -m venv .venv

Activate the environment: on Windows .venv\Scripts\activate, on macOS and Linux source .venv/bin/activate. Then install the pinned dependencies and the engine itself:

pip install -r requirements.txt -r requirements-dev.txt
pip install -e . --no-deps

Run the tests

The suite has 859 NC-021 tests and needs no IBM account.

pytest

Poll IBM calibrations

superconducted-poll archives calibration snapshots from an IBM backend. It needs an IBM Quantum token.

cp .env.example .env
superconducted-poll --backend ibm_fez

• Where the token goes: in .env, as IBM_QUANTUM_TOKEN.
• Never commit it. git ignores .env; keep it that way.
• If polling fails, the engine’s README lists the failure modes and their fixes.

Read the design

• Architecture: the seven-stage pipeline and how it meets Qiskit Aer.
• Decision record: every architectural decision, with its status.
• Numerical-claims register: where every figure the project states comes from.

Take part

• Questions and ideas: the engine’s Discussions.
• Bugs: its issues.
• A larger change: open an issue first, so you and the team agree on the approach before the work starts. The code is under the MIT licence.