# Citing tradefloor

Source: https://docs.tradefloor.dev/cite.html

> How to cite tradefloor in a paper: the BibTeX entry, the version and preset to name, and what to publish beside a result so a reader can rebuild the market.

Cite the version you ran and name the preset. One version can run any shipped preset, and your results depend on which one you used.

```
@software{tradefloor,
  author  = {Coombes, Simon},
  title   = {tradefloor: a deterministic market simulator with a limit order book},
  version = {0.11.0},
  year    = {2026},
  url     = {https://github.com/simoncoombes/tradefloor},
  doi     = {10.5281/zenodo.23091410},
  note    = {Model preset pt-v22}
}
```

tradefloor's DOI on Zenodo is [10.5281/zenodo.23091410](https://doi.org/10.5281/zenodo.23091410). It always resolves to the latest release, and each release also has a DOI of its own on Zenodo that pins that exact version. GitHub's "Cite this repository" button gives the author, title and version from `CITATION.cff` in the repository.

In the text, name the model too, for example: "tradefloor 0.11.0, preset pt-v22, specified in its docs/MODEL.md". [How prices are made](https://docs.tradefloor.dev/how-prices-are-made.html) describes that model.

## Details to publish with a result

To let a reader rebuild your market, also report:
- the tradefloor version and the preset name
- the seeds
- the universe: the `Universe.random(n, seed=...)` call or the roster file, and its fingerprint
- the economy on day zero, if you set one
- any scenario file, and its digest

A [RunManifest](https://docs.tradefloor.dev/reproducibility.html#saving-a-run) records all of these and replays the market to check it, but it holds no score. If you want readers to check a score, publish the agent's code, the `tf.evaluate` or `tf.rank` call and the seeds as well. [Reproducibility](https://docs.tradefloor.dev/reproducibility.html) says what each of these inputs fixes.

## License

tradefloor is open source under the MIT license or the Apache License 2.0, at your option.
