qenvs 0.0.1__tar.gz

qenvs-0.0.1/.gitignore

@@ -0,0 +1,15 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+site/
+.ipynb_checkpoints/
+*.log
+.DS_Store
+src/qenvs/_version.py
+.python-version

qenvs-0.0.1/CITATION.cff

@@ -0,0 +1,17 @@
+cff-version: 1.2.0
+title: "QEnvS: physically validated quantum control environments"
+message: "If you use QEnvS, please cite it using this metadata."
+type: software
+authors:
+  - family-names: Park
+    given-names: Beomdo
+    affiliation: Hanbat National University
+license: Apache-2.0
+repository-code: https://github.com/beomdo-park/QEnvS
+url: https://beomdo-park.github.io/QEnvS
+keywords:
+  - quantum control
+  - reinforcement learning
+  - quantum battery
+  - open quantum systems
+  - JAX

qenvs-0.0.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qenvs-0.0.1/NOTICE

@@ -0,0 +1,25 @@
+QEnvS (qenvs)
+Copyright 2026 Beomdo Park
+
+This product includes software developed at Hanbat National University.
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+-----------------------------------------------------------------------
+Third-party attributions
+-----------------------------------------------------------------------
+
+* Project tooling layout (pyproject/ruff/taskipy/mkdocs conventions) is
+  adapted from dynamiqs (https://github.com/dynamiqs/dynamiqs),
+  Apache License 2.0, Copyright dynamiqs developers.
+
+* The functional environment API (reset/step returning (state, timestep))
+  follows the design of Jumanji (https://github.com/instadeepai/jumanji),
+  Apache License 2.0, Copyright InstaDeep Ltd.
+
+* QuTiP (https://qutip.org) is used as a reference implementation in the
+  validation test-suite only. QuTiP is distributed under the BSD 3-Clause
+  License, Copyright QuTiP developers and contributors.
+
+No source code has been copied from projects that do not carry an
+OSI-approved license (e.g. RL4qcWpc, which has no LICENSE file).

qenvs-0.0.1/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.5
+Name: qenvs
+Version: 0.0.1
+Summary: QEnvS: physically validated quantum control environments (quantum batteries, state transfer, open systems) for RL and optimal control, built on JAX + dynamiqs.
+Project-URL: Homepage, https://github.com/beomdo-park/QEnvS
+Project-URL: Documentation, https://beomdo-park.github.io/QEnvS
+Project-URL: Repository, https://github.com/beomdo-park/QEnvS
+Project-URL: Issues, https://github.com/beomdo-park/QEnvS/issues
+Author-email: Beomdo Park <pbeomdo@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: gymnasium,jax,open quantum systems,quantum battery,quantum control,reinforcement learning
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
+Requires-Dist: dynamiqs>=0.3.6
+Requires-Dist: equinox
+Requires-Dist: jax!=0.7.0,!=0.7.1,<0.8,>=0.4.36
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: codespell; extra == 'dev'
+Requires-Dist: gymnasium>=1.0; extra == 'dev'
+Requires-Dist: optax; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: qutip>=5; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-gen-files; extra == 'docs'
+Requires-Dist: mkdocs-literate-nav; extra == 'docs'
+Requires-Dist: mkdocs-material; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Provides-Extra: gym
+Requires-Dist: gymnasium>=1.0; extra == 'gym'
+Description-Content-Type: text/markdown
+
+# QEnvS
+
+**Physically validated quantum control environments for reinforcement learning and optimal control.**
+
+*Reusable physics. Reproducible control.*
+
+[![ci](https://github.com/beomdo-park/QEnvS/actions/workflows/ci.yml/badge.svg)](https://github.com/beomdo-park/QEnvS/actions/workflows/ci.yml)
+[![docs](https://github.com/beomdo-park/QEnvS/actions/workflows/docs.yml/badge.svg)](https://beomdo-park.github.io/QEnvS)
+[![PyPI](https://img.shields.io/pypi/v/qenvs)](https://pypi.org/project/qenvs/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+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](https://github.com/dynamiqs/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
+
+```bash
+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):
+
+```python
+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:
+
+```python
+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:
+
+```python
+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):
+
+```bash
+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](AGENTS.md); an LLM
+index of the docs is at [`/llms.txt`](https://beomdo-park.github.io/QEnvS/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](docs/roadmap.md).
+
+## 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](CONTRIBUTING.md). New models must come with analytic
+validation tests.
+
+## Citation
+
+See [CITATION.cff](CITATION.cff). A Zenodo DOI will be attached to the first release.
+
+## License
+
+Apache-2.0. Third-party attributions are listed in [NOTICE](NOTICE).

qenvs-0.0.1/README.md

@@ -0,0 +1,117 @@
+# QEnvS
+
+**Physically validated quantum control environments for reinforcement learning and optimal control.**
+
+*Reusable physics. Reproducible control.*
+
+[![ci](https://github.com/beomdo-park/QEnvS/actions/workflows/ci.yml/badge.svg)](https://github.com/beomdo-park/QEnvS/actions/workflows/ci.yml)
+[![docs](https://github.com/beomdo-park/QEnvS/actions/workflows/docs.yml/badge.svg)](https://beomdo-park.github.io/QEnvS)
+[![PyPI](https://img.shields.io/pypi/v/qenvs)](https://pypi.org/project/qenvs/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+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](https://github.com/dynamiqs/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
+
+```bash
+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):
+
+```python
+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:
+
+```python
+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:
+
+```python
+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):
+
+```bash
+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](AGENTS.md); an LLM
+index of the docs is at [`/llms.txt`](https://beomdo-park.github.io/QEnvS/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](docs/roadmap.md).
+
+## 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](CONTRIBUTING.md). New models must come with analytic
+validation tests.
+
+## Citation
+
+See [CITATION.cff](CITATION.cff). A Zenodo DOI will be attached to the first release.
+
+## License
+
+Apache-2.0. Third-party attributions are listed in [NOTICE](NOTICE).

qenvs-0.0.1/pyproject.toml

@@ -0,0 +1,102 @@
+[project]
+name = "qenvs"
+description = "QEnvS: physically validated quantum control environments (quantum batteries, state transfer, open systems) for RL and optimal control, built on JAX + dynamiqs."
+authors = [{ name = "Beomdo Park", email = "pbeomdo@gmail.com" }]
+dynamic = ["version"]
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+keywords = ["quantum control", "reinforcement learning", "quantum battery", "open quantum systems", "jax", "gymnasium"]
+dependencies = [
+    # jax<0.8: dynamiqs 0.3.6 fails to import with jax>=0.8 (UnionType | str in qarray.py).
+    # Loosen once dynamiqs ships a fix.
+    "jax>=0.4.36,!=0.7.0,!=0.7.1,<0.8",
+    "dynamiqs>=0.3.6",
+    "equinox",
+    "numpy",
+]
+
+[project.scripts]
+qenvs = "qenvs.cli:main"
+
+[project.optional-dependencies]
+gym = ["gymnasium>=1.0"]
+dev = [
+    "qenvs[gym]",
+    "pytest>=8",
+    "pytest-xdist",
+    "ruff>=0.8",
+    "codespell",
+    "pre-commit",
+    "qutip>=5",          # reference implementation for validation tests
+    "optax",             # gradient baselines in examples/
+]
+docs = [
+    "mkdocs-material",
+    "mkdocstrings[python]",
+    "mkdocs-gen-files",
+    "mkdocs-literate-nav",
+]
+
+[project.urls]
+Homepage = "https://github.com/beomdo-park/QEnvS"
+Documentation = "https://beomdo-park.github.io/QEnvS"
+Repository = "https://github.com/beomdo-park/QEnvS"
+Issues = "https://github.com/beomdo-park/QEnvS/issues"
+
+[build-system]
+requires = ["hatchling>=1.27", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/qenvs/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/qenvs"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/qenvs", "tests", "README.md", "LICENSE", "NOTICE", "CITATION.cff"]
+
+# --- tooling (ruff config adapted from dynamiqs, Apache-2.0) ---
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.format]
+quote-style = "double"
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = ["F", "E", "W", "I", "UP", "B", "C4", "SIM", "RET", "ARG", "PTH", "NPY", "RUF", "D"]
+ignore = ["D100", "D102", "D104", "D105", "D107", "D203", "D213", "E741", "RUF012"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+"tests/**" = ["D", "ARG"]
+"docs/**" = ["D"]
+"examples/**" = ["D"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.codespell]
+skip = ".git,*.ipynb,uv.lock,site"
+ignore-words-list = "ket,braket,sme"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+filterwarnings = ["ignore::DeprecationWarning"]

qenvs-0.0.1/src/qenvs/__init__.py

@@ -0,0 +1,25 @@
+"""QEnvS: physically validated quantum control environments for RL and optimal control."""
+
+from qenvs import envs, models, observables, tasks, validation
+from qenvs.envs.base import Environment, EnvState, TimeStep
+from qenvs.registry import make, register, registry
+
+try:
+    from qenvs._version import __version__
+except ImportError:  # pragma: no cover - editable install without build hook
+    __version__ = "0.0.0+unknown"
+
+__all__ = [
+    "EnvState",
+    "Environment",
+    "TimeStep",
+    "__version__",
+    "envs",
+    "make",
+    "models",
+    "observables",
+    "register",
+    "registry",
+    "tasks",
+    "validation",
+]