Metadata-Version: 2.4
Name: tracebook-sim
Version: 0.6.0
Summary: Compatibility facade for Tracebook simulation, replay, profiling, and visualization tools
Author-email: Taz33m <tazeemmahashin@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Taz33m/tracebook
Project-URL: Changelog, https://github.com/Taz33m/tracebook/blob/main/CHANGELOG.md
Project-URL: Continuous Integration, https://github.com/Taz33m/tracebook/actions/workflows/ci.yml
Project-URL: Documentation, https://github.com/Taz33m/tracebook/tree/main/docs
Project-URL: Issues, https://github.com/Taz33m/tracebook/issues
Project-URL: Security, https://github.com/Taz33m/tracebook/blob/main/SECURITY.md
Project-URL: Source, https://github.com/Taz33m/tracebook
Keywords: order-book,matching-engine,market-microstructure,benchmarking,profiling,simulation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tracebook-conformance==0.6.0
Requires-Dist: numpy>=2.2.6
Requires-Dist: psutil>=7.2.2
Provides-Extra: analysis
Requires-Dist: h5py>=3.16.0; extra == "analysis"
Requires-Dist: matplotlib>=3.10.9; extra == "analysis"
Requires-Dist: pandas>=2.3.3; extra == "analysis"
Requires-Dist: plotly>=6.8.0; extra == "analysis"
Requires-Dist: pyarrow>=24.0.0; extra == "analysis"
Requires-Dist: seaborn>=0.13.2; extra == "analysis"
Requires-Dist: tables>=3.10.1; extra == "analysis"
Provides-Extra: capture
Requires-Dist: websockets>=16.1; extra == "capture"
Provides-Extra: dashboard
Requires-Dist: dash>=4.3.0; extra == "dashboard"
Requires-Dist: pandas>=2.3.3; extra == "dashboard"
Requires-Dist: plotly>=6.8.0; extra == "dashboard"
Dynamic: license-file

# tracebook-sim

`tracebook-sim` is the compatibility distribution for Tracebook's simulation,
benchmarking, replay, corpus, profiling, and visualization commands.

Beginning with version 0.6.0, this distribution contains no importable Python
packages. It depends on the exact matching `tracebook-conformance` release,
which owns the `tracebook` package and the `tracebook-conformance` command.
This facade owns only the established non-conformance console entry points:

- `tracebook-sim`
- `tracebook-benchmark`
- `tracebook-dashboard`
- `tracebook-web`
- `tracebook-replay`
- `tracebook-coinbase`
- `tracebook-corpus`

Install it in a fresh environment when you use the simulator or broader local
tooling:

If this environment contains `tracebook-sim` 0.5.x, do not run either 0.6.0
install yet. Remove the legacy package owner first:

```bash
python -m pip uninstall -y tracebook-sim
```

```bash
python -m pip install "tracebook-sim==0.6.0"
```

## Required Upgrade Step From 0.5.x

Do not directly upgrade an environment containing `tracebook-sim` 0.5.x. That
release owned the entire `tracebook` package; its uninstall record can remove
files newly installed by `tracebook-conformance` 0.6.0.

After removing the legacy owner as shown above, install the new facade:

```bash
python -m pip install "tracebook-sim==0.6.0"
```

If a direct upgrade already left `tracebook` unimportable, repair the new
source owner:

```bash
python -m pip install --force-reinstall --no-deps "tracebook-conformance==0.6.0"
python -m pip check
```

NumPy and psutil remain mandatory dependencies of this compatibility
distribution so an ordinary `tracebook-sim` installation preserves the
pre-0.6 simulator experience. Users who only need matching-engine conformance
can instead install the lightweight source-owning distribution:

```bash
python -m pip install "tracebook-conformance==0.6.0"
```

The existing runtime extras remain available:

- `tracebook-sim[analysis]` adds dataframe, plotting, and columnar analysis
  dependencies.
- `tracebook-sim[capture]` adds live WebSocket capture support.
- `tracebook-sim[dashboard]` adds the interactive dashboard dependencies.

Project documentation and source are maintained at
<https://github.com/Taz33m/tracebook>.
