Skip to content

docs(readme): restructure for improved readability #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bxvtr merged 1 commit into from
May 15, 2026
Merged

docs(readme): restructure for improved readability #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 35 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,40 +24,6 @@ simulation, Live trading, Venue Adapters, and infrastructure around you change.

<img src="https://img.spacergif.org/spacer.gif" width="1" height="32"/>

## Internally wired vs externally supplied

The clean Core Pipeline is always the same shape; some pieces run inside Core
when you call step APIs, and others must be supplied by your Runtime or tests.

### Internally wired (always part of Core when you call step APIs)

- `process_event_entry` / `process_canonical_event` and canonical reducers
- Candidate combination, dominance, and reconciliation (`combine_candidate_intent_records`)
- Policy admission **mechanism** when `CorePolicyAdmissionContext` is provided
- Execution Control plan/apply **mechanism** when policy + apply contexts are provided
- `CoreStepResult` / `CoreStepDecision` production

### Externally supplied extension points

- **Strategy evaluator** — `CoreStepStrategyEvaluator` or `CoreWakeupStrategyEvaluator`
- **Policy evaluator** — any object implementing `PolicyIntentEvaluator` (passed via `CorePolicyAdmissionContext`)
- **Execution Control** — `ExecutionControl` instance (passed via `CoreExecutionControlApplyContext`)
- **Configuration** — optional `CoreConfiguration` for positioned market reduction
- **Event bus** — `StrategyState` requires an `EventBus`; use `NullEventBus` for standalone Core/tests

### Convenience implementations (optional; not wired by default)

- **Risk Engine** (`RiskEngine`) — provided `PolicyIntentEvaluator` with built-in policy gates
- **`ExecutionControl`** — provided queue/rate/inflight implementation
- **`NullEventBus`** — discards observability events for tests and examples

The minimal quickstart uses an inline allow-all policy to stay small. That does
**not** mean the Risk Engine is unused or dead. Use `RiskEngine` when you want the
built-in Risk Engine policy behavior. See `examples/core_step_quickstart.py` (minimal) and
`examples/core_step_with_risk_engine.py` (Risk Engine variant).

<img src="https://img.spacergif.org/spacer.gif" width="1" height="32"/>

## Why it is relevant

Trading systems often drift when Backtesting logic, Live logic, policy limits, and
Expand Down Expand Up @@ -225,6 +191,40 @@ Runtime dispatches Intents into Orders

<img src="https://img.spacergif.org/spacer.gif" width="1" height="32"/>

## Internally wired vs externally supplied

The clean Core Pipeline is always the same shape; some pieces run inside Core
when you call step APIs, and others must be supplied by your Runtime or tests.

### Internally wired (always part of Core when you call step APIs)

- `process_event_entry` / `process_canonical_event` and canonical reducers
- Candidate combination, dominance, and reconciliation (`combine_candidate_intent_records`)
- Policy admission **mechanism** when `CorePolicyAdmissionContext` is provided
- Execution Control plan/apply **mechanism** when policy + apply contexts are provided
- `CoreStepResult` / `CoreStepDecision` production

### Externally supplied extension points

- **Strategy evaluator** — `CoreStepStrategyEvaluator` or `CoreWakeupStrategyEvaluator`
- **Policy evaluator** — any object implementing `PolicyIntentEvaluator` (passed via `CorePolicyAdmissionContext`)
- **Execution Control** — `ExecutionControl` instance (passed via `CoreExecutionControlApplyContext`)
- **Configuration** — optional `CoreConfiguration` for positioned market reduction
- **Event bus** — `StrategyState` requires an `EventBus`; use `NullEventBus` for standalone Core/tests

### Convenience implementations (optional; not wired by default)

- **Risk Engine** (`RiskEngine`) — provided `PolicyIntentEvaluator` with built-in policy gates
- **`ExecutionControl`** — provided queue/rate/inflight implementation
- **`NullEventBus`** — discards observability events for tests and examples

The minimal quickstart uses an inline allow-all policy to stay small. That does
**not** mean the Risk Engine is unused or dead. Use `RiskEngine` when you want the
built-in Risk Engine policy behavior. See `examples/core_step_quickstart.py` (minimal) and
`examples/core_step_with_risk_engine.py` (Risk Engine variant).

<img src="https://img.spacergif.org/spacer.gif" width="1" height="32"/>

## Input / Core / Output / Not Owned By Core

- Input: `EventStreamEntry` values with canonical Events and Event Stream position.
Expand All @@ -247,9 +247,7 @@ Runtime dispatches Intents into Orders
| Execution Control | Kubernetes/deployment |
| `CoreStepResult` decision contract | Runtime lifecycle glue |

<img src="https://img.spacergif.org/spacer.gif" width="1" height="32"/>

## Control time and scheduling (Core)
### Control time and scheduling

`ControlSchedulingObligation` is a **non-canonical**, time-dependent hint produced
when Execution Control **apply** defers for **rate limits**. **Inflight** gating is
Expand Down
Loading