QEnvS
Physically validated quantum control environments for reinforcement learning and optimal control.
Reusable physics. Reproducible control.
QEnvS (Quantum Environment Suite) is a model zoo of open-quantum-system control problems, quantum batteries, qubit state transfer, thermal machines, packaged so that you can plug them into an RL agent or a gradient-based optimiser in a few lines, instead of re-deriving the physics for every paper.
Every model ships with analytic reference results that run as tests (pi-pulse inversion, exponential decay, ergotropy bounds, collective-charging scaling, ...). If a model is in QEnvS, its physics has been checked against closed-form solutions and against an independent simulator (QuTiP).
Built on dynamiqs (JAX): environments are
jit-able, vmap-able across thousands of trajectories, and differentiable, so
the same model serves RL (PPO/SAC), GRAPE-style optimal control and MPC.
Install
pip install qenvs # core: jax + dynamiqs
pip install 'qenvs[gym]' # + gymnasium adapter (stable-baselines3, CleanRL, ...)
Quickstart
Functional JAX API (batch 1024 episodes on one GPU):
import jax, jax.numpy as jnp
import qenvs
env = qenvs.make("qubit/StateTransfer-v0", horizon=10, dt=0.2)
keys = jax.random.split(jax.random.PRNGKey(0), 1024)
states, ts = jax.vmap(env.reset)(keys)
actions = jnp.ones((1024, env.action_dim))
states, ts = jax.jit(jax.vmap(env.step))(states, actions)
print(ts.reward.shape, ts.info["fidelity"].shape) # (1024,) (1024,)
Gradient-based control through the same environment:
def loss(actions):
_, rewards = env.rollout(actions)
return -rewards.sum() # = -(F_final - F_initial)
grad = jax.grad(loss)(jnp.zeros((env.horizon, env.action_dim)))
Gymnasium for classic RL libraries:
from qenvs.wrappers import GymnasiumEnv
from stable_baselines3 import PPO
gym_env = GymnasiumEnv(env)
PPO("MlpPolicy", gym_env).learn(20_000)
Command line, for humans and coding agents (every command has --json;
uvx qenvs ... works without installing):
qenvs list --json
qenvs info qubit/StateTransfer-v0 --json # physics, kwargs, references, usage
qenvs run qubit/StateTransfer-v0 --policy pi-pulse --set gamma1=0.1 --json
qenvs validate # per-check error vs tolerance + versions
qenvs doctor # install / backend / optional extras check
Repository conventions for coding agents are in AGENTS.md; an LLM
index of the docs is at /llms.txt.
Models and tasks
| Task id | Model | Dissipation | Validated against | Status |
|---|---|---|---|---|
qubit/StateTransfer-v0 |
driven qubit | T1, T_phi (Lindblad) | Rabi formula, pi-pulse, T1/T_phi decay, ergotropy, energy conservation, rho constraints, solver convergence | available |
battery/TwoLevel-v0 |
open qubit battery | T1, T_phi, thermal | ergotropy/power bounds | planned |
battery/Dicke-v0 |
N qubits + cavity (Dicke / Tavis-Cummings) | cavity loss, dephasing | collective charging scaling | planned |
transfer/LambdaSTIRAP-v0 |
three-level Lambda | spontaneous emission | adiabatic STIRAP transfer | planned |
See the roadmap.
Why not X?
- qutip-qoc / GRAPE / CRAB optimise a pulse for one fixed model; QEnvS gives you the model as a reusable, tested object plus an environment interface.
- qiskit-gym, qgym are circuit-level (synthesis, routing); QEnvS is Hamiltonian/pulse-level with open-system dynamics.
- Paper repositories (e.g. ICML 2025 RL-for-quantum-control code) are reproductions of one paper; QEnvS is the shared, maintained layer under them.
Contributing
See CONTRIBUTING.md. New models must come with analytic validation tests.
Citation
See CITATION.cff. A Zenodo DOI will be attached to the first release.
License
Apache-2.0. Third-party attributions are listed in NOTICE.
Metadata
Release files for qenvs 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| qenvs-0.0.1.tar.gz | 24.5 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qenvs-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 54.4 kB
Release files / qenvs-0.0.1.tar.gz
| Download URL | qenvs-0.0.1.tar.gz |
|---|---|
| Size | 24.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dd65b5693667edd5335b540ce90439e601fd7da7a145f66edc10c46c7b2304d7
|
|
BLAKE2b-256 checksum How to use checksums |
8708f849089a2bbd2d71e3244fc74ba28f69ed5d7c084647ab8d9bf8882d3656
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency logRelease files / qenvs-0.0.1-py3-none-any.whl
| Download URL | qenvs-0.0.1-py3-none-any.whl |
|---|---|
| Size | 29.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d6b1798722658b7287cf31251144e11349b6c65f4898a3b769f595bb404a2e58
|
|
BLAKE2b-256 checksum How to use checksums |
cd1078bf22c711f789f989fb26061d8255253165c1d113ce417b5b5564734b77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency logSecurity for qenvs 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for qenvs-0.0.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.