pretium
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
The API may still move before 1.0. What will not move is a published result: anything that changes the simulated trajectory arrives as a new model preset rather than an edit to an existing one, so a run you cited last month reproduces this month.
In thirty seconds
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 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
fourteen statistics against real-market bands. At 252 days the shipped pt-v3
preset holds twelve of the fourteen in band, and holds the original eleven on
axes the calibration never saw: fresh seeds, and a fresh 60-name universe. The
two it misses are both stated as gaps: volume shocks do not persist, and names in
the same sector do not co-move more than names in different ones. Two further
presets close those on their own terms and are selectable by name, never the
default: pt-v7 gives the market industries that survive a crisis, and
pt-v8 gives the market factor's variance a memory, so correlation that rose
last month is still elevated this month and a crisis is a third more violent.
Every earlier preset keeps reproducing bit for bit.
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
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/, numbered in
reading order and executed as part of the test suite:
| what it covers | |
|---|---|
01-first-simulation |
Universe, engine, order book, determinism |
02-evaluating-a-strategy |
Specs, baselines, ranking across seeds |
03-why-did-the-price-move |
The seven factors that sum to every move |
04-how-realistic-is-this |
The realism panel and the gaps |
05-training-an-agent |
The Gymnasium environment, and what size costs |
06-execution-and-impact |
TCA and the counterfactual run |
09-a-pandemic-shaped-market |
A real 2020-21 macro path, and which fields actually transmit |
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
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, and RELEASING.md for how a version reaches PyPI and crates.io. 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, 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 and LICENSE-APACHE.
Metadata
Release files for pretium 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pretium-0.1.4.tar.gz | 491.3 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| pretium-0.1.4-cp311-abi3-win_amd64.whl | CPython 3.11 | abi3 | Windows x86-64 | Details |
| pretium-0.1.4-cp311-abi3-manylinux_2_34_x86_64.whl | CPython 3.11 | abi3 | Linux glibc 2.34+ x86-64 | Details |
| pretium-0.1.4-cp311-abi3-manylinux_2_34_aarch64.whl | CPython 3.11 | abi3 | Linux glibc 2.34+ ARM64 | Details |
| pretium-0.1.4-cp311-abi3-macosx_11_0_arm64.whl | CPython 3.11 | abi3 | macOS 11.0+ ARM64 | Details |
| pretium-0.1.4-cp311-abi3-macosx_10_12_x86_64.whl | CPython 3.11 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 4.3 MB
Release files / pretium-0.1.4.tar.gz
| Download URL | pretium-0.1.4.tar.gz |
|---|---|
| Size | 491.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
da4f5e81230a8101cc3d799188317e79c93b9089edfb2377434302014f53d52c
|
|
BLAKE2b-256 checksum How to use checksums |
d34d73a1fee2c5c53455de85d12a9d1c6d6eb2ceb5c53fb1aaf7dac38c74c4a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pretium-0.1.4-cp311-abi3-win_amd64.whl
| Download URL | pretium-0.1.4-cp311-abi3-win_amd64.whl |
|---|---|
| Size | 701.7 kB |
| Tags | CPython 3.11 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
cc653a6c234a54fab52320fced95bdb17ac8123b6dc7ae135d24e37ae049bc61
|
|
BLAKE2b-256 checksum How to use checksums |
051e58e4de8dbef92cca4e083c8f82cfec5bd111d805c3f4ac11c6175092309b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pretium-0.1.4-cp311-abi3-manylinux_2_34_x86_64.whl
| Download URL | pretium-0.1.4-cp311-abi3-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 803.7 kB |
| Tags | CPython 3.11 Linux glibc 2.34+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
3ee5fb5be18fd7a2d7c6b4bf1b8fe7d2958e8716ea6e7d4ba986f63c6e307c2f
|
|
BLAKE2b-256 checksum How to use checksums |
b0643319eb7372b721544659e21de10bc17b5ba0dfa6909fe6ac0bea455bc089
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pretium-0.1.4-cp311-abi3-manylinux_2_34_aarch64.whl
| Download URL | pretium-0.1.4-cp311-abi3-manylinux_2_34_aarch64.whl |
|---|---|
| Size | 787.6 kB |
| Tags | CPython 3.11 Linux glibc 2.34+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
9bc3f4fb9451893f1ff5f0a79978a582dcfee1b6ede05a4030f272bfd4b44b81
|
|
BLAKE2b-256 checksum How to use checksums |
c989cd29fd8106e24870e2bbb1f7c275eb5884f5e9845a54ebc243995b6a0c1b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pretium-0.1.4-cp311-abi3-macosx_11_0_arm64.whl
| Download URL | pretium-0.1.4-cp311-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 756.1 kB |
| Tags | CPython 3.11 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
299743ea8303a1cf6127d3be5af66c4ad3dcaa1310d79cbc69140992bc73d58a
|
|
BLAKE2b-256 checksum How to use checksums |
5c621fdfea8e94ca1b25b968bb1b75016e894ebd3569c9228fe3fa9fc1043873
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pretium-0.1.4-cp311-abi3-macosx_10_12_x86_64.whl
| Download URL | pretium-0.1.4-cp311-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 776.7 kB |
| Tags | CPython 3.11 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
3846c097b6e19e580acf8a4e8577e9e684a0e55af6cd2076900c35d0c5d00dc2
|
|
BLAKE2b-256 checksum How to use checksums |
d7f6b1b46857440b0133a75e85306317401be433c9d469a42f038c5d8aff19ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency log