Canonical docs
In the research projects
The Python project constructs execution inputs and policy directly. The Compiled project binds them through its Manifest. Their execution scenarios retain native ledgers, declared clocks, product rules and recorded funding.
What this package owns
Owns Limen's research execution, inventory/economics ledger and snapshot assumptions. Signal generation and operational account management belong to their respective callers.
Key entry points
| Entry point | Use case | Notes |
|---|---|---|
backtest_snapshot |
Vectorized evaluation across rounds | from limen.backtest import backtest_snapshot |
long_flat_strategy |
Default execution model, or a template for a new strategy | Returns an ExecutionResult; from limen.backtest import long_flat_strategy |
short_flat_strategy |
Explicit binary short/flat snapshot approximation | Import from limen.backtest.short_flat_strategy; contract |
limen.backtest.funding |
Validated funding observations and event cash flows | Uses the declared funding clocks and product |
limen.backtest.observed_costs |
Recorded retrospective cost calibration and stress comparisons | Python Research; requires the pinned calibration and benchmark |
trade_execution |
Signed exposure with actual fill costs and persistent episodes | Accepts TradeInputs and TradePolicy with a ProductSpec |
The package root exports backtest_snapshot, long_flat_strategy, ExecutionResult, trade_execution, TradeInputs, TradePolicy and ProductSpec.
Adjacent modules
limen.logusesbacktest_snapshot()to summarize experiment permutations.limen.experimentandlimen.sfdsit upstream by producing the predictions that backtests consume.
Quick orientation
| Module or family | Responsibility |
|---|---|
backtest_snapshot.py |
Vectorized snapshot evaluator (price validation + ledger) |
long_flat_strategy.py |
Default long-only execution model |
short_flat_strategy.py |
Explicit constant-notional short/flat snapshot model |
trade_contract.py / trade_execution.py |
Product, policy, event fills and inventory ledger |
funding.py / funding_presets.py |
Funding records and declared venue conventions |
observed_costs.py |
Cost calibration, dispositions and stress reports |
backtest/├── README.md├── __init__.py├── _cost_comparison.py├── _cost_history.py├── _cost_identity.py├── _cost_statistics.py├── _event_clock.py├── _event_plan.py├── _exit_evidence.py├── _explicit_exit_strategy.py├── _long_flat_tp_sl.py├── _rule_exit_state.py├── _snapshot_execution.py├── _snapshot_ledger.py├── _snapshot_signals.py├── backtest_snapshot.py├── execution_events.py├── funding_adapter.py├── funding_presets.py├── long_flat_strategy.py├── observed_costs.py├── short_flat_strategy.py├── trade_contract.py└── trade_execution.pyMerged source PR · 62d79072Package layout · Limen 6.0.1 · current package validation · package source
Things to know
- Configure tunable fixed TP/SL on the manifest; Backtest defines exits, OHLC validation, and replay requirements.
backtest_snapshot()is the standard analysis path for vectorized experiment-sweep evaluation.- Explicit
class_mappingorlabel_indexinterprets multiclass/multilabel snapshot inputs; Backtest defines the contract. - Snapshot return and cost outputs are basis-point scaled (
*_bpscolumns), matching the basis-point fee and slippage inputs.