pretium 0.1.1__tar.gz

pretium-0.1.1/LICENSE-APACHE

@@ -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.
+

pretium-0.1.1/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Simon Coombes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pretium-0.1.1/NOTICE

@@ -0,0 +1,6 @@
+pretium
+Copyright 2026 Simon Coombes
+
+This product includes software developed by Simon Coombes.
+Licensed under the terms of either the MIT license (LICENSE-MIT) or the
+Apache License, Version 2.0 (LICENSE-APACHE), at your option.

pretium-0.1.1/PKG-INFO

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: pretium
+Version: 0.1.1
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Scientific/Engineering
+Requires-Dist: pyarrow>=14 ; extra == 'arrow'
+Requires-Dist: anthropic>=0.40 ; extra == 'claude'
+Requires-Dist: pydantic>=2 ; extra == 'claude'
+Requires-Dist: mcp>=2.0 ; extra == 'mcp'
+Requires-Dist: numpy>=1.24 ; extra == 'rl'
+Requires-Dist: gymnasium>=0.29 ; extra == 'rl'
+Provides-Extra: arrow
+Provides-Extra: claude
+Provides-Extra: mcp
+Provides-Extra: rl
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+License-File: NOTICE
+Summary: Deterministic market simulation with a real limit order book.
+Keywords: simulation,finance,market,orderbook,deterministic,backtesting
+Home-Page: https://simoncoombes.github.io/pretium
+Author: Simon Coombes
+License-Expression: MIT OR Apache-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/simoncoombes/pretium/releases
+Project-URL: Documentation, https://simoncoombes.github.io/pretium
+Project-URL: Homepage, https://simoncoombes.github.io/pretium
+Project-URL: Repository, https://github.com/simoncoombes/pretium
+
+# pretium
+
+[![determinism](https://github.com/simoncoombes/pretium/actions/workflows/determinism.yml/badge.svg)](https://github.com/simoncoombes/pretium/actions/workflows/determinism.yml)
+[![licence: MIT OR Apache-2.0](https://img.shields.io/badge/licence-MIT%20OR%20Apache--2.0-blue.svg)](#licence)
+[![python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
+
+A market simulator you can run a strategy against. Rust core, Python API.
+
+Give it a seed and a set of companies and it runs a market forward: prices, a
+limit order book, fills, and an economy that advances itself daily. Your
+orders match against real depth, so trading moves the price the way it would
+anywhere else.
+
+It exists because historical data can't answer two questions. What would have
+happened if I'd traded differently, and what actually caused this price move.
+
+## Install
+
+```
+pip install pretium
+```
+
+0.1.1 is the current release, and 0.1.0 was the first. The API may still
+move before 1.0, and anything that changes the simulated trajectory arrives
+as a new model preset rather than an edit to an existing one, so a published
+result stays reproducible.
+
+## In thirty seconds
+
+```python
+import pretium as pt
+
+universe = pt.Universe.random(40, seed=111)
+
+spec = pt.StrategySpec.momentum(lookback_days=1.0, top_k=5)
+scores = pt.evaluate({"mine": spec}, seed=7, universe=universe, days=10)
+
+scores["mine"].return_pct            # what it made
+scores["mine"].impact_bps            # what its own footprint cost
+scores["mine"].strategy_fingerprint  # sha256, cite this
+```
+
+That's one market draw, which tells you as much about the seed as about the
+strategy. `pt.rank` runs many seeds and compares them with a paired sign
+test.
+
+## What makes it different
+
+**Determinism that's checked.** The crate ships its own `exp`, `log`, `sin`
+and `cos` instead of calling the platform libm. Every release builds five
+targets, runs one fixed simulation inside each, and compares digests. A
+disagreement fails the release. A WebAssembly build produces the same digest
+as the native one.
+
+**Ground truth you can read.** The simulator computed every price, so it can
+tell you why. One row per instrument per tick, with seven factor
+contributions that sum to the move and a residual around 1e-16. No historical
+dataset carries those labels. You can see that a stock fell, never that 60%
+of the fall was order-flow pressure.
+
+**Counterfactuals you can run.** The same seed runs with and without your
+orders, so every fill is priced against the market where you never traded.
+That's the number TCA vendors approximate.
+
+**Results someone else can check.** A `StrategySpec` is a declarative,
+hashable document rather than an arbitrary callable. A `RunManifest` carries
+the seed, universe, macro conditions, scenario, model and strategy together
+with the expected digest. `reproduce()` refuses on a mismatch and names the
+culprit, because a manifest that quietly reproduced a different market would
+be worse than no manifest.
+
+## Driving it from an agent
+
+```
+pip install "pretium[mcp]"
+claude mcp add pretium -- pretium-mcp
+```
+
+Eleven read-only tools over the simulator, so a coding agent can ask whether
+a momentum strategy beats buy-and-hold here, and whether the difference is
+real. Strategies, universes and scenarios are composed as data. There's no
+path from a tool argument to code execution.
+
+Every result carries computed caveats and full provenance. A model
+summarising a result has the tool output and nothing else, and will otherwise
+report `return_pct: 88.7` as "the strategy made 88.7%".
+[The MCP server](https://simoncoombes.github.io/pretium/mcp.html) has the
+tool list and the client configuration.
+
+## What it's bad at
+
+**Good results here don't predict real returns.** The price process comes
+from a known model, so a strategy that fits that model's structure will look
+excellent and teach you nothing. A strategy that fails here is more
+informative, because it broke against a live order book under honest impact
+costs.
+
+**Realism is a stated envelope, not a score.** `pt.facts.measure()` reports
+ten statistics against real-market bands. At 252 days the shipped `pt-v3`
+preset holds nine of the ten in band, and holds the same nine on axes the
+calibration never saw: fresh seeds, and a fresh 60-name universe.
+
+The tenth is the autocorrelation of volume changes, which misses by 13.7
+seed-standard-deviations. It's excluded from the calibration objective
+deliberately, because an optimiser pointed at an unreachable target doesn't
+fail cleanly, it distorts every other parameter chasing it. In practice a
+volume forecast here is never wrong twice running, so an execution algorithm
+faces an easier scheduling problem than the one it was written for.
+
+**Six gaps are measured and named rather than assumed.** The certified
+horizon is 252 days and the model doesn't hold beyond it. Volatility memory
+decays exponentially where real markets decay hyperbolically. Tails are too
+thin over multi-year windows. Scenario response is directionally right but
+not calibrated in magnitude. And certification was measured on a
+sector-balanced roster, which no real index is.
+[The realism envelope](https://simoncoombes.github.io/pretium/trust.html)
+states each gap and what it forbids. `pt.envelope.check()` refuses to certify
+a question that falls outside one.
+
+**Single venue, no latency, no strategic counterparties.** Orders arrive
+instantly, there's one book per name, and you trade against a market maker
+and aggregate flow rather than agents that adapt to you.
+
+## Worked examples
+
+Six notebooks and two scripts in [`examples/`](examples/), numbered in
+reading order and executed as part of the test suite:
+
+| | what it covers |
+|---|---|
+| [`01-first-simulation`](examples/01-first-simulation.ipynb) | Universe, engine, order book, determinism |
+| [`02-evaluating-a-strategy`](examples/02-evaluating-a-strategy.ipynb) | Specs, baselines, ranking across seeds |
+| [`03-why-did-the-price-move`](examples/03-why-did-the-price-move.ipynb) | The seven factors that sum to every move |
+| [`04-how-realistic-is-this`](examples/04-how-realistic-is-this.ipynb) | The realism panel and the gaps |
+| [`05-training-an-agent`](examples/05-training-an-agent.ipynb) | The Gymnasium environment, and what size costs |
+| [`06-execution-and-impact`](examples/06-execution-and-impact.ipynb) | TCA and the counterfactual run |
+
+Or a whole study in one file. Sweep, evaluation, TCA and replay in about five
+seconds:
+
+```
+python examples/07-research-workflow.py
+```
+
+## Documentation
+
+Full docs: [**simoncoombes.github.io/pretium**](https://simoncoombes.github.io/pretium/)
+
+Getting started and core concepts. Agents, evaluation and the RL environment.
+Scenarios and macro paths, strategy specs, model presets, checkpointing and
+forking, sharing a run, Arrow output and streaming sweeps, SEC EDGAR loading,
+transaction cost analysis, the MCP server, running in the browser, the
+realism envelope and metrics, and the conventions worth reading before you
+hit them.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). One rule shapes the rest: a change to
+the simulated trajectory is a breaking change, whatever its size. A market
+that runs differently from the same seed invalidates every published result
+that cited it.
+
+## Citing this
+
+See [CITATION.cff](CITATION.cff), or cite a specific result by its manifest.
+The seed, the universe fingerprint, the model fingerprint and the strategy
+fingerprint together identify exactly what ran.
+
+## Licence
+
+MIT OR Apache-2.0, at your option. See [LICENSE-MIT](LICENSE-MIT) and
+[LICENSE-APACHE](LICENSE-APACHE).
+

pretium-0.1.1/README.md

@@ -0,0 +1,172 @@
+# pretium
+
+[![determinism](https://github.com/simoncoombes/pretium/actions/workflows/determinism.yml/badge.svg)](https://github.com/simoncoombes/pretium/actions/workflows/determinism.yml)
+[![licence: MIT OR Apache-2.0](https://img.shields.io/badge/licence-MIT%20OR%20Apache--2.0-blue.svg)](#licence)
+[![python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
+
+A market simulator you can run a strategy against. Rust core, Python API.
+
+Give it a seed and a set of companies and it runs a market forward: prices, a
+limit order book, fills, and an economy that advances itself daily. Your
+orders match against real depth, so trading moves the price the way it would
+anywhere else.
+
+It exists because historical data can't answer two questions. What would have
+happened if I'd traded differently, and what actually caused this price move.
+
+## Install
+
+```
+pip install pretium
+```
+
+0.1.1 is the current release, and 0.1.0 was the first. The API may still
+move before 1.0, and anything that changes the simulated trajectory arrives
+as a new model preset rather than an edit to an existing one, so a published
+result stays reproducible.
+
+## In thirty seconds
+
+```python
+import pretium as pt
+
+universe = pt.Universe.random(40, seed=111)
+
+spec = pt.StrategySpec.momentum(lookback_days=1.0, top_k=5)
+scores = pt.evaluate({"mine": spec}, seed=7, universe=universe, days=10)
+
+scores["mine"].return_pct            # what it made
+scores["mine"].impact_bps            # what its own footprint cost
+scores["mine"].strategy_fingerprint  # sha256, cite this
+```
+
+That's one market draw, which tells you as much about the seed as about the
+strategy. `pt.rank` runs many seeds and compares them with a paired sign
+test.
+
+## What makes it different
+
+**Determinism that's checked.** The crate ships its own `exp`, `log`, `sin`
+and `cos` instead of calling the platform libm. Every release builds five
+targets, runs one fixed simulation inside each, and compares digests. A
+disagreement fails the release. A WebAssembly build produces the same digest
+as the native one.
+
+**Ground truth you can read.** The simulator computed every price, so it can
+tell you why. One row per instrument per tick, with seven factor
+contributions that sum to the move and a residual around 1e-16. No historical
+dataset carries those labels. You can see that a stock fell, never that 60%
+of the fall was order-flow pressure.
+
+**Counterfactuals you can run.** The same seed runs with and without your
+orders, so every fill is priced against the market where you never traded.
+That's the number TCA vendors approximate.
+
+**Results someone else can check.** A `StrategySpec` is a declarative,
+hashable document rather than an arbitrary callable. A `RunManifest` carries
+the seed, universe, macro conditions, scenario, model and strategy together
+with the expected digest. `reproduce()` refuses on a mismatch and names the
+culprit, because a manifest that quietly reproduced a different market would
+be worse than no manifest.
+
+## Driving it from an agent
+
+```
+pip install "pretium[mcp]"
+claude mcp add pretium -- pretium-mcp
+```
+
+Eleven read-only tools over the simulator, so a coding agent can ask whether
+a momentum strategy beats buy-and-hold here, and whether the difference is
+real. Strategies, universes and scenarios are composed as data. There's no
+path from a tool argument to code execution.
+
+Every result carries computed caveats and full provenance. A model
+summarising a result has the tool output and nothing else, and will otherwise
+report `return_pct: 88.7` as "the strategy made 88.7%".
+[The MCP server](https://simoncoombes.github.io/pretium/mcp.html) has the
+tool list and the client configuration.
+
+## What it's bad at
+
+**Good results here don't predict real returns.** The price process comes
+from a known model, so a strategy that fits that model's structure will look
+excellent and teach you nothing. A strategy that fails here is more
+informative, because it broke against a live order book under honest impact
+costs.
+
+**Realism is a stated envelope, not a score.** `pt.facts.measure()` reports
+ten statistics against real-market bands. At 252 days the shipped `pt-v3`
+preset holds nine of the ten in band, and holds the same nine on axes the
+calibration never saw: fresh seeds, and a fresh 60-name universe.
+
+The tenth is the autocorrelation of volume changes, which misses by 13.7
+seed-standard-deviations. It's excluded from the calibration objective
+deliberately, because an optimiser pointed at an unreachable target doesn't
+fail cleanly, it distorts every other parameter chasing it. In practice a
+volume forecast here is never wrong twice running, so an execution algorithm
+faces an easier scheduling problem than the one it was written for.
+
+**Six gaps are measured and named rather than assumed.** The certified
+horizon is 252 days and the model doesn't hold beyond it. Volatility memory
+decays exponentially where real markets decay hyperbolically. Tails are too
+thin over multi-year windows. Scenario response is directionally right but
+not calibrated in magnitude. And certification was measured on a
+sector-balanced roster, which no real index is.
+[The realism envelope](https://simoncoombes.github.io/pretium/trust.html)
+states each gap and what it forbids. `pt.envelope.check()` refuses to certify
+a question that falls outside one.
+
+**Single venue, no latency, no strategic counterparties.** Orders arrive
+instantly, there's one book per name, and you trade against a market maker
+and aggregate flow rather than agents that adapt to you.
+
+## Worked examples
+
+Six notebooks and two scripts in [`examples/`](examples/), numbered in
+reading order and executed as part of the test suite:
+
+| | what it covers |
+|---|---|
+| [`01-first-simulation`](examples/01-first-simulation.ipynb) | Universe, engine, order book, determinism |
+| [`02-evaluating-a-strategy`](examples/02-evaluating-a-strategy.ipynb) | Specs, baselines, ranking across seeds |
+| [`03-why-did-the-price-move`](examples/03-why-did-the-price-move.ipynb) | The seven factors that sum to every move |
+| [`04-how-realistic-is-this`](examples/04-how-realistic-is-this.ipynb) | The realism panel and the gaps |
+| [`05-training-an-agent`](examples/05-training-an-agent.ipynb) | The Gymnasium environment, and what size costs |
+| [`06-execution-and-impact`](examples/06-execution-and-impact.ipynb) | TCA and the counterfactual run |
+
+Or a whole study in one file. Sweep, evaluation, TCA and replay in about five
+seconds:
+
+```
+python examples/07-research-workflow.py
+```
+
+## Documentation
+
+Full docs: [**simoncoombes.github.io/pretium**](https://simoncoombes.github.io/pretium/)
+
+Getting started and core concepts. Agents, evaluation and the RL environment.
+Scenarios and macro paths, strategy specs, model presets, checkpointing and
+forking, sharing a run, Arrow output and streaming sweeps, SEC EDGAR loading,
+transaction cost analysis, the MCP server, running in the browser, the
+realism envelope and metrics, and the conventions worth reading before you
+hit them.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). One rule shapes the rest: a change to
+the simulated trajectory is a breaking change, whatever its size. A market
+that runs differently from the same seed invalidates every published result
+that cited it.
+
+## Citing this
+
+See [CITATION.cff](CITATION.cff), or cite a specific result by its manifest.
+The seed, the universe fingerprint, the model fingerprint and the strategy
+fingerprint together identify exactly what ran.
+
+## Licence
+
+MIT OR Apache-2.0, at your option. See [LICENSE-MIT](LICENSE-MIT) and
+[LICENSE-APACHE](LICENSE-APACHE).