qs-dmss 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- qs_dmss-0.1.0/LICENSE +201 -0
- qs_dmss-0.1.0/MANIFEST.in +7 -0
- qs_dmss-0.1.0/PKG-INFO +223 -0
- qs_dmss-0.1.0/README.md +203 -0
- qs_dmss-0.1.0/RELEASE.md +55 -0
- qs_dmss-0.1.0/configs/demo.yaml +51 -0
- qs_dmss-0.1.0/pyproject.toml +45 -0
- qs_dmss-0.1.0/schemas/run_config.schema.json +267 -0
- qs_dmss-0.1.0/setup.cfg +4 -0
- qs_dmss-0.1.0/src/qs_dmss/__init__.py +5 -0
- qs_dmss-0.1.0/src/qs_dmss/app.py +177 -0
- qs_dmss-0.1.0/src/qs_dmss/assets/__init__.py +1 -0
- qs_dmss-0.1.0/src/qs_dmss/assets/configs/demo.yaml +51 -0
- qs_dmss-0.1.0/src/qs_dmss/assets/schemas/run_config.schema.json +267 -0
- qs_dmss-0.1.0/src/qs_dmss/cli.py +293 -0
- qs_dmss-0.1.0/src/qs_dmss/cockpit/__init__.py +1 -0
- qs_dmss-0.1.0/src/qs_dmss/cockpit/api.py +673 -0
- qs_dmss-0.1.0/src/qs_dmss/cockpit/server.py +17 -0
- qs_dmss-0.1.0/src/qs_dmss/cockpit/static/app.js +1143 -0
- qs_dmss-0.1.0/src/qs_dmss/cockpit/static/index.html +566 -0
- qs_dmss-0.1.0/src/qs_dmss/cockpit/static/styles.css +1140 -0
- qs_dmss-0.1.0/src/qs_dmss/core/__init__.py +1 -0
- qs_dmss-0.1.0/src/qs_dmss/core/solver.py +146 -0
- qs_dmss-0.1.0/src/qs_dmss/decision.py +473 -0
- qs_dmss-0.1.0/src/qs_dmss/evidence/__init__.py +1 -0
- qs_dmss-0.1.0/src/qs_dmss/evidence/bundle.py +417 -0
- qs_dmss-0.1.0/src/qs_dmss/evidence/verify.py +104 -0
- qs_dmss-0.1.0/src/qs_dmss/experiment.py +909 -0
- qs_dmss-0.1.0/src/qs_dmss/io/__init__.py +1 -0
- qs_dmss-0.1.0/src/qs_dmss/io/config.py +508 -0
- qs_dmss-0.1.0/src/qs_dmss/paths.py +67 -0
- qs_dmss-0.1.0/src/qs_dmss/run/__init__.py +1 -0
- qs_dmss-0.1.0/src/qs_dmss/run/ledger.py +156 -0
- qs_dmss-0.1.0/src/qs_dmss.egg-info/PKG-INFO +223 -0
- qs_dmss-0.1.0/src/qs_dmss.egg-info/SOURCES.txt +44 -0
- qs_dmss-0.1.0/src/qs_dmss.egg-info/dependency_links.txt +1 -0
- qs_dmss-0.1.0/src/qs_dmss.egg-info/entry_points.txt +2 -0
- qs_dmss-0.1.0/src/qs_dmss.egg-info/requires.txt +12 -0
- qs_dmss-0.1.0/src/qs_dmss.egg-info/top_level.txt +1 -0
- qs_dmss-0.1.0/tests/test_campaign.py +94 -0
- qs_dmss-0.1.0/tests/test_cli_campaigns.py +26 -0
- qs_dmss-0.1.0/tests/test_cli_experiments.py +48 -0
- qs_dmss-0.1.0/tests/test_cockpit_api.py +285 -0
- qs_dmss-0.1.0/tests/test_decision.py +127 -0
- qs_dmss-0.1.0/tests/test_packaging.py +20 -0
- qs_dmss-0.1.0/tests/test_run_smoke.py +72 -0
qs_dmss-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
qs_dmss-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: qs-dmss
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Evidence-first reference package for the QuantumScalar Dark Matter Simulation Suite.
|
|
5
|
+
Author: AI Bio Synergy Holdings LLC
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Requires-Python: >=3.10
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Requires-Dist: fastapi>=0.116
|
|
11
|
+
Requires-Dist: numpy>=1.26
|
|
12
|
+
Requires-Dist: PyYAML>=6.0
|
|
13
|
+
Requires-Dist: uvicorn>=0.35
|
|
14
|
+
Provides-Extra: dev
|
|
15
|
+
Requires-Dist: httpx>=0.28; extra == "dev"
|
|
16
|
+
Requires-Dist: pytest>=8.0; extra == "dev"
|
|
17
|
+
Requires-Dist: tomli>=2.0; python_version < "3.11" and extra == "dev"
|
|
18
|
+
Requires-Dist: twine>=6.0; extra == "dev"
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# QS-DMSS
|
|
22
|
+
|
|
23
|
+
QS-DMSS is a deterministic, evidence-first reference build of the QuantumScalar
|
|
24
|
+
Dark Matter Simulation Suite. This repository now ships the productization spine
|
|
25
|
+
needed to move from prototype scripts into a reproducible package:
|
|
26
|
+
|
|
27
|
+
- Installable Python package
|
|
28
|
+
- Bundled demo assets for installed-package smoke testing
|
|
29
|
+
- Config-driven simulation CLI
|
|
30
|
+
- Local-first run cockpit and JSON API
|
|
31
|
+
- Parameter sweeps and multi-run comparison in the cockpit
|
|
32
|
+
- Experiment registry with saved comparison reports and bundles
|
|
33
|
+
- Objective-driven decision profiles with ranked recommendations
|
|
34
|
+
- Template-defined decision campaigns across multi-parameter search grids
|
|
35
|
+
- Run ledger with stable run IDs and config digests
|
|
36
|
+
- Evidence bundle with artifacts, metrics, manifest, and HTML report
|
|
37
|
+
- Replay and verification commands for reproducibility checks
|
|
38
|
+
- GitHub Actions CI and containerized runtime
|
|
39
|
+
|
|
40
|
+
## What This Build Includes
|
|
41
|
+
|
|
42
|
+
The current reference implementation focuses on the backbone needed for
|
|
43
|
+
productization:
|
|
44
|
+
|
|
45
|
+
- A NumPy-based split-step Schrodinger-Poisson solver
|
|
46
|
+
- YAML configuration loading with explicit validation
|
|
47
|
+
- Structured run outputs under `runs/<run_id>/`
|
|
48
|
+
- Structured experiment outputs under `experiments/<experiment_id>/`
|
|
49
|
+
- A local cockpit for launch, inspection, verification, replay, and bundle download
|
|
50
|
+
- Sweep support for exploring one parameter across multiple deterministic runs
|
|
51
|
+
- Decision campaign support for expanding a template into a multi-parameter grid automatically
|
|
52
|
+
- Comparison tooling for energy drift, norm drift, density, and runtime deltas
|
|
53
|
+
- Decision profiles that score runs against an explicit objective, constraint set, and ranking policy
|
|
54
|
+
- Durable experiment exports with copied run evidence, comparison JSON, report HTML, manifest, and bundle ZIP
|
|
55
|
+
- Evidence artifacts:
|
|
56
|
+
- `config.yaml`
|
|
57
|
+
- `run.json`
|
|
58
|
+
- `metrics.json`
|
|
59
|
+
- `energy.csv`
|
|
60
|
+
- `environment.lock.json`
|
|
61
|
+
- `artifacts/final_density.npy`
|
|
62
|
+
- `artifacts/final_state.npz`
|
|
63
|
+
- `report.html`
|
|
64
|
+
- `manifest.sha256.json`
|
|
65
|
+
- `evidence_bundle.zip`
|
|
66
|
+
- Verification tooling for manifests and config digests
|
|
67
|
+
- Replay support for deterministic reruns
|
|
68
|
+
|
|
69
|
+
## Quickstart
|
|
70
|
+
|
|
71
|
+
Create a virtual environment and install the package in editable mode:
|
|
72
|
+
|
|
73
|
+
```powershell
|
|
74
|
+
python -m venv .venv
|
|
75
|
+
.\.venv\Scripts\Activate.ps1
|
|
76
|
+
python -m pip install --upgrade pip
|
|
77
|
+
python -m pip install -e .[dev]
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Run the checked-in demo config:
|
|
81
|
+
|
|
82
|
+
```powershell
|
|
83
|
+
qs-dmss run configs/demo.yaml
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Run the bundled demo config from any installed build:
|
|
87
|
+
|
|
88
|
+
```powershell
|
|
89
|
+
qs-dmss run-demo
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Start the local cockpit:
|
|
93
|
+
|
|
94
|
+
```powershell
|
|
95
|
+
qs-dmss cockpit --host 127.0.0.1 --port 8001
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Then open [http://127.0.0.1:8001](http://127.0.0.1:8001) in a browser.
|
|
99
|
+
|
|
100
|
+
Inside the cockpit you can:
|
|
101
|
+
|
|
102
|
+
- Launch a single run from a checked-in or edited config
|
|
103
|
+
- Launch a parameter sweep across interaction strength, timestep, step count, amplitude, width, or seed
|
|
104
|
+
- Launch a template-defined decision campaign that expands into a reproducible multi-parameter run matrix
|
|
105
|
+
- Compare multiple runs side by side with shared experiment metadata
|
|
106
|
+
- Save a comparison into the experiment registry and reopen it later with report and bundle downloads
|
|
107
|
+
- Load an objective-driven template and see the recommended winner directly in the comparison view
|
|
108
|
+
|
|
109
|
+
Verify the generated evidence bundle:
|
|
110
|
+
|
|
111
|
+
```powershell
|
|
112
|
+
qs-dmss verify runs\<run_id>
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Replay a prior run using the captured config:
|
|
116
|
+
|
|
117
|
+
```powershell
|
|
118
|
+
qs-dmss replay runs\<run_id>
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Persist a saved experiment bundle from two or more runs:
|
|
122
|
+
|
|
123
|
+
```powershell
|
|
124
|
+
qs-dmss experiments export <run_id> <run_id> --label "comparison bundle"
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
List saved experiment artifacts:
|
|
128
|
+
|
|
129
|
+
```powershell
|
|
130
|
+
qs-dmss experiments list
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Launch the decision campaign defined by a template:
|
|
134
|
+
|
|
135
|
+
```powershell
|
|
136
|
+
qs-dmss campaigns run configs/demo.yaml
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Or launch the bundled installed-package demo campaign:
|
|
140
|
+
|
|
141
|
+
```powershell
|
|
142
|
+
qs-dmss campaigns run-demo
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
The checked-in demo template now includes a decision profile:
|
|
146
|
+
|
|
147
|
+
- `objective`
|
|
148
|
+
- `constraints`
|
|
149
|
+
- `ranking`
|
|
150
|
+
- `campaign`
|
|
151
|
+
|
|
152
|
+
That means sweeps, experiment exports, and template-driven campaigns can now return a replayable recommendation instead of only raw metric tables.
|
|
153
|
+
|
|
154
|
+
## Container Runtime
|
|
155
|
+
|
|
156
|
+
Build the container image:
|
|
157
|
+
|
|
158
|
+
```powershell
|
|
159
|
+
docker build -t qs-dmss .
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
Run the cockpit in Docker:
|
|
163
|
+
|
|
164
|
+
```powershell
|
|
165
|
+
docker run --rm -p 8001:8001 qs-dmss
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
The image installs the built wheel, starts `qs-dmss cockpit --host 0.0.0.0 --port 8001`,
|
|
169
|
+
and exposes the health endpoint at `http://127.0.0.1:8001/api/health`.
|
|
170
|
+
|
|
171
|
+
## Project Layout
|
|
172
|
+
|
|
173
|
+
```text
|
|
174
|
+
configs/ Checked-in example configs
|
|
175
|
+
schemas/ JSON schema for run configs
|
|
176
|
+
src/qs_dmss/ Package source
|
|
177
|
+
tests/ Smoke and reproducibility tests
|
|
178
|
+
runs/ Run ledger outputs (generated)
|
|
179
|
+
experiments/ Saved comparison artifacts (generated)
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## Development
|
|
183
|
+
|
|
184
|
+
Run the smoke tests:
|
|
185
|
+
|
|
186
|
+
```powershell
|
|
187
|
+
pytest
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
CI lives in [.github/workflows/ci.yml](.github/workflows/ci.yml) and validates:
|
|
191
|
+
|
|
192
|
+
- the editable install and test suite across Python 3.10 through 3.13
|
|
193
|
+
- static cockpit JavaScript syntax
|
|
194
|
+
- source distribution and wheel build metadata
|
|
195
|
+
- installed-wheel `run-demo` smoke test
|
|
196
|
+
- Docker build plus live `/api/health` and `/api/configs` probes
|
|
197
|
+
|
|
198
|
+
Release-candidate versioning and distribution artifact rules live in
|
|
199
|
+
[RELEASE.md](RELEASE.md).
|
|
200
|
+
|
|
201
|
+
## Current Scope
|
|
202
|
+
|
|
203
|
+
This branch intentionally focuses on the package/evidence/reproducibility spine
|
|
204
|
+
first. Optional accelerator backends, UI layers, plugin expansion, and broader
|
|
205
|
+
enterprise modules can now build on a stable execution loop:
|
|
206
|
+
|
|
207
|
+
`configure -> run -> measure -> bundle -> verify -> replay`
|
|
208
|
+
|
|
209
|
+
The cockpit adds the first browser-native product layer on top of that loop:
|
|
210
|
+
|
|
211
|
+
`configure -> launch -> inspect -> verify -> replay -> download`
|
|
212
|
+
|
|
213
|
+
The experiment registry now makes comparison durable too:
|
|
214
|
+
|
|
215
|
+
`select runs -> compare -> save -> report -> bundle -> reopen`
|
|
216
|
+
|
|
217
|
+
The decision layer adds recommendation semantics to that flow:
|
|
218
|
+
|
|
219
|
+
`select template -> launch campaign -> score runs -> recommend winner -> export evidence`
|
|
220
|
+
|
|
221
|
+
The campaign layer now automates the search plan too:
|
|
222
|
+
|
|
223
|
+
`select template -> expand campaign -> run matrix -> score variants -> recommend winner -> reopen bundle`
|
qs_dmss-0.1.0/README.md
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
# QS-DMSS
|
|
2
|
+
|
|
3
|
+
QS-DMSS is a deterministic, evidence-first reference build of the QuantumScalar
|
|
4
|
+
Dark Matter Simulation Suite. This repository now ships the productization spine
|
|
5
|
+
needed to move from prototype scripts into a reproducible package:
|
|
6
|
+
|
|
7
|
+
- Installable Python package
|
|
8
|
+
- Bundled demo assets for installed-package smoke testing
|
|
9
|
+
- Config-driven simulation CLI
|
|
10
|
+
- Local-first run cockpit and JSON API
|
|
11
|
+
- Parameter sweeps and multi-run comparison in the cockpit
|
|
12
|
+
- Experiment registry with saved comparison reports and bundles
|
|
13
|
+
- Objective-driven decision profiles with ranked recommendations
|
|
14
|
+
- Template-defined decision campaigns across multi-parameter search grids
|
|
15
|
+
- Run ledger with stable run IDs and config digests
|
|
16
|
+
- Evidence bundle with artifacts, metrics, manifest, and HTML report
|
|
17
|
+
- Replay and verification commands for reproducibility checks
|
|
18
|
+
- GitHub Actions CI and containerized runtime
|
|
19
|
+
|
|
20
|
+
## What This Build Includes
|
|
21
|
+
|
|
22
|
+
The current reference implementation focuses on the backbone needed for
|
|
23
|
+
productization:
|
|
24
|
+
|
|
25
|
+
- A NumPy-based split-step Schrodinger-Poisson solver
|
|
26
|
+
- YAML configuration loading with explicit validation
|
|
27
|
+
- Structured run outputs under `runs/<run_id>/`
|
|
28
|
+
- Structured experiment outputs under `experiments/<experiment_id>/`
|
|
29
|
+
- A local cockpit for launch, inspection, verification, replay, and bundle download
|
|
30
|
+
- Sweep support for exploring one parameter across multiple deterministic runs
|
|
31
|
+
- Decision campaign support for expanding a template into a multi-parameter grid automatically
|
|
32
|
+
- Comparison tooling for energy drift, norm drift, density, and runtime deltas
|
|
33
|
+
- Decision profiles that score runs against an explicit objective, constraint set, and ranking policy
|
|
34
|
+
- Durable experiment exports with copied run evidence, comparison JSON, report HTML, manifest, and bundle ZIP
|
|
35
|
+
- Evidence artifacts:
|
|
36
|
+
- `config.yaml`
|
|
37
|
+
- `run.json`
|
|
38
|
+
- `metrics.json`
|
|
39
|
+
- `energy.csv`
|
|
40
|
+
- `environment.lock.json`
|
|
41
|
+
- `artifacts/final_density.npy`
|
|
42
|
+
- `artifacts/final_state.npz`
|
|
43
|
+
- `report.html`
|
|
44
|
+
- `manifest.sha256.json`
|
|
45
|
+
- `evidence_bundle.zip`
|
|
46
|
+
- Verification tooling for manifests and config digests
|
|
47
|
+
- Replay support for deterministic reruns
|
|
48
|
+
|
|
49
|
+
## Quickstart
|
|
50
|
+
|
|
51
|
+
Create a virtual environment and install the package in editable mode:
|
|
52
|
+
|
|
53
|
+
```powershell
|
|
54
|
+
python -m venv .venv
|
|
55
|
+
.\.venv\Scripts\Activate.ps1
|
|
56
|
+
python -m pip install --upgrade pip
|
|
57
|
+
python -m pip install -e .[dev]
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Run the checked-in demo config:
|
|
61
|
+
|
|
62
|
+
```powershell
|
|
63
|
+
qs-dmss run configs/demo.yaml
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Run the bundled demo config from any installed build:
|
|
67
|
+
|
|
68
|
+
```powershell
|
|
69
|
+
qs-dmss run-demo
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Start the local cockpit:
|
|
73
|
+
|
|
74
|
+
```powershell
|
|
75
|
+
qs-dmss cockpit --host 127.0.0.1 --port 8001
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Then open [http://127.0.0.1:8001](http://127.0.0.1:8001) in a browser.
|
|
79
|
+
|
|
80
|
+
Inside the cockpit you can:
|
|
81
|
+
|
|
82
|
+
- Launch a single run from a checked-in or edited config
|
|
83
|
+
- Launch a parameter sweep across interaction strength, timestep, step count, amplitude, width, or seed
|
|
84
|
+
- Launch a template-defined decision campaign that expands into a reproducible multi-parameter run matrix
|
|
85
|
+
- Compare multiple runs side by side with shared experiment metadata
|
|
86
|
+
- Save a comparison into the experiment registry and reopen it later with report and bundle downloads
|
|
87
|
+
- Load an objective-driven template and see the recommended winner directly in the comparison view
|
|
88
|
+
|
|
89
|
+
Verify the generated evidence bundle:
|
|
90
|
+
|
|
91
|
+
```powershell
|
|
92
|
+
qs-dmss verify runs\<run_id>
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Replay a prior run using the captured config:
|
|
96
|
+
|
|
97
|
+
```powershell
|
|
98
|
+
qs-dmss replay runs\<run_id>
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Persist a saved experiment bundle from two or more runs:
|
|
102
|
+
|
|
103
|
+
```powershell
|
|
104
|
+
qs-dmss experiments export <run_id> <run_id> --label "comparison bundle"
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
List saved experiment artifacts:
|
|
108
|
+
|
|
109
|
+
```powershell
|
|
110
|
+
qs-dmss experiments list
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Launch the decision campaign defined by a template:
|
|
114
|
+
|
|
115
|
+
```powershell
|
|
116
|
+
qs-dmss campaigns run configs/demo.yaml
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Or launch the bundled installed-package demo campaign:
|
|
120
|
+
|
|
121
|
+
```powershell
|
|
122
|
+
qs-dmss campaigns run-demo
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
The checked-in demo template now includes a decision profile:
|
|
126
|
+
|
|
127
|
+
- `objective`
|
|
128
|
+
- `constraints`
|
|
129
|
+
- `ranking`
|
|
130
|
+
- `campaign`
|
|
131
|
+
|
|
132
|
+
That means sweeps, experiment exports, and template-driven campaigns can now return a replayable recommendation instead of only raw metric tables.
|
|
133
|
+
|
|
134
|
+
## Container Runtime
|
|
135
|
+
|
|
136
|
+
Build the container image:
|
|
137
|
+
|
|
138
|
+
```powershell
|
|
139
|
+
docker build -t qs-dmss .
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Run the cockpit in Docker:
|
|
143
|
+
|
|
144
|
+
```powershell
|
|
145
|
+
docker run --rm -p 8001:8001 qs-dmss
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
The image installs the built wheel, starts `qs-dmss cockpit --host 0.0.0.0 --port 8001`,
|
|
149
|
+
and exposes the health endpoint at `http://127.0.0.1:8001/api/health`.
|
|
150
|
+
|
|
151
|
+
## Project Layout
|
|
152
|
+
|
|
153
|
+
```text
|
|
154
|
+
configs/ Checked-in example configs
|
|
155
|
+
schemas/ JSON schema for run configs
|
|
156
|
+
src/qs_dmss/ Package source
|
|
157
|
+
tests/ Smoke and reproducibility tests
|
|
158
|
+
runs/ Run ledger outputs (generated)
|
|
159
|
+
experiments/ Saved comparison artifacts (generated)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## Development
|
|
163
|
+
|
|
164
|
+
Run the smoke tests:
|
|
165
|
+
|
|
166
|
+
```powershell
|
|
167
|
+
pytest
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
CI lives in [.github/workflows/ci.yml](.github/workflows/ci.yml) and validates:
|
|
171
|
+
|
|
172
|
+
- the editable install and test suite across Python 3.10 through 3.13
|
|
173
|
+
- static cockpit JavaScript syntax
|
|
174
|
+
- source distribution and wheel build metadata
|
|
175
|
+
- installed-wheel `run-demo` smoke test
|
|
176
|
+
- Docker build plus live `/api/health` and `/api/configs` probes
|
|
177
|
+
|
|
178
|
+
Release-candidate versioning and distribution artifact rules live in
|
|
179
|
+
[RELEASE.md](RELEASE.md).
|
|
180
|
+
|
|
181
|
+
## Current Scope
|
|
182
|
+
|
|
183
|
+
This branch intentionally focuses on the package/evidence/reproducibility spine
|
|
184
|
+
first. Optional accelerator backends, UI layers, plugin expansion, and broader
|
|
185
|
+
enterprise modules can now build on a stable execution loop:
|
|
186
|
+
|
|
187
|
+
`configure -> run -> measure -> bundle -> verify -> replay`
|
|
188
|
+
|
|
189
|
+
The cockpit adds the first browser-native product layer on top of that loop:
|
|
190
|
+
|
|
191
|
+
`configure -> launch -> inspect -> verify -> replay -> download`
|
|
192
|
+
|
|
193
|
+
The experiment registry now makes comparison durable too:
|
|
194
|
+
|
|
195
|
+
`select runs -> compare -> save -> report -> bundle -> reopen`
|
|
196
|
+
|
|
197
|
+
The decision layer adds recommendation semantics to that flow:
|
|
198
|
+
|
|
199
|
+
`select template -> launch campaign -> score runs -> recommend winner -> export evidence`
|
|
200
|
+
|
|
201
|
+
The campaign layer now automates the search plan too:
|
|
202
|
+
|
|
203
|
+
`select template -> expand campaign -> run matrix -> score variants -> recommend winner -> reopen bundle`
|
qs_dmss-0.1.0/RELEASE.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# QS-DMSS Release Policy
|
|
2
|
+
|
|
3
|
+
This policy keeps release builds, Python package metadata, and GitHub release
|
|
4
|
+
artifacts aligned before tags are published.
|
|
5
|
+
|
|
6
|
+
Current release target: `v0.1.0` / `0.1.0`. Published release-candidate tags
|
|
7
|
+
such as `v0.1.0-rc.1` and `v0.1.0-rc.2` remain immutable; do not move or
|
|
8
|
+
replace them.
|
|
9
|
+
|
|
10
|
+
## Version Alignment
|
|
11
|
+
|
|
12
|
+
- GitHub release-candidate tags use SemVer-style names such as `v0.1.0-rc.1`.
|
|
13
|
+
- Python package metadata uses the equivalent PEP 440 form, such as
|
|
14
|
+
`0.1.0rc1`.
|
|
15
|
+
- Final releases use matching final versions: Git tag `v0.1.0` and package
|
|
16
|
+
version `0.1.0`.
|
|
17
|
+
- `pyproject.toml`, `qs_dmss.__version__`, and installed package metadata must
|
|
18
|
+
agree before a release tag is cut.
|
|
19
|
+
- CI enforces version alignment through `tests/test_packaging.py`.
|
|
20
|
+
|
|
21
|
+
## Distribution Artifacts
|
|
22
|
+
|
|
23
|
+
- Release candidates are GitHub prereleases intended for reviewer validation.
|
|
24
|
+
- Build artifacts are generated from a clean tag using `python -m build --sdist
|
|
25
|
+
--wheel`.
|
|
26
|
+
- Every wheel and source distribution must pass `python -m twine check dist/*`
|
|
27
|
+
before publication.
|
|
28
|
+
- Source distributions must include `RELEASE.md`, checked-in demo configs, and
|
|
29
|
+
checked-in JSON schemas.
|
|
30
|
+
- Wheels must include the bundled demo config and schema package assets used by
|
|
31
|
+
`qs-dmss run-demo`.
|
|
32
|
+
- Runtime evidence bundles under `runs/` and `experiments/` are reproducibility
|
|
33
|
+
outputs, not package distribution artifacts.
|
|
34
|
+
- Docker images are validation artifacts for this phase; publish a registry image
|
|
35
|
+
only after a registry namespace, tagging policy, and retention policy are chosen.
|
|
36
|
+
- Do not publish to PyPI until package-name ownership, final metadata, and
|
|
37
|
+
support expectations are explicitly approved.
|
|
38
|
+
|
|
39
|
+
## Final `v0.1.0` Promotion Checklist
|
|
40
|
+
|
|
41
|
+
1. Resolve reviewer feedback against the latest release-candidate branch.
|
|
42
|
+
2. Bump package metadata from the current prerelease version to `0.1.0`.
|
|
43
|
+
Completed for this branch.
|
|
44
|
+
3. Run the full local validation suite:
|
|
45
|
+
|
|
46
|
+
```powershell
|
|
47
|
+
.\.venv\Scripts\python.exe -m pytest -q
|
|
48
|
+
.\.venv\Scripts\python.exe -m build --sdist --wheel
|
|
49
|
+
.\.venv\Scripts\python.exe -m twine check dist/*
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
4. Merge through a green PR and wait for `main` CI to pass.
|
|
53
|
+
5. Tag the merge commit as `v0.1.0`.
|
|
54
|
+
6. Create a GitHub release from that tag and attach only approved distribution
|
|
55
|
+
artifacts.
|