Check a question against the realism envelope
check_envelopeCheck whether a run's horizon, statistics, presets, or scenario assumptions fall within the simulator's measured realism range before running; returns ok or refusal without running a market.
Instructions
Check whether a question falls inside the range the simulator's realism was measured for, BEFORE running it. Use it whenever a conclusion leans on a horizon longer than a year, on particular statistics, on a sector-concentrated roster, on the size of a scenario's effect or on a preset other than the default. Returns ok or a refusal that names the measurement behind it, and for a named preset that preset's measured record. Runs no market, so it answers at once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| preset | No | The preset the run uses, by name: pt-v1, pt-v2, pt-v3, pt-v4, pt-v5, pt-v6, pt-v7, pt-v8, pt-v9, pt-v10, pt-v11, pt-v12, pt-v13, pt-v14, pt-v15, pt-v16, pt-v18, pt-v19, pt-v20, pt-v21. Omit for the shipped default, pt-v21, the only preset the envelope certifies. Any other is answered as outside, with that preset's own measured record beside the answer; the measured roster mixes are granted only on pt-v19. | |
| statistics | No | Panel statistics your conclusion leans on. Known: abs_return_acf1, abs_return_acf20, abs_return_acf5, annualised_vol_pct, corr_asymmetry, corr_asymmetry_lagged, corr_persistence_acf1, cross_sectional_corr, excess_kurtosis, fear_gauge_dn1, fear_gauge_dn3, index_drift_pct, index_tail_dn3_pct, leverage_effect, return_acf1, sector_excess_corr, volume_abs_return_corr, volume_change_acf1. An unknown name is refused. | |
| horizon_days | Yes | The run length you are asking about, in trading days. The certified horizon is 252. | |
| macro_regime | No | true if the conclusion depends on the economy reaching a particular state, such as high inflation, stagflation or a policy crisis. run_stress_scenario sets this itself when a scenario drives inflation, growth or the cycle. | |
| scenario_magnitude | No | true if the conclusion depends on the SIZE of a scenario's effect rather than its direction. | |
| sector_concentrated | No | true if the roster is sector-concentrated, or the name of a measured mix: all_technology, defensive, sp500_like, tech_heavy. A mix is certified only on the preset it was measured on. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||