alphaengine 0.6.0__tar.gz → 0.7.0__tar.gz

{alphaengine-0.6.0 → alphaengine-0.7.0}/AGENTS.md

@@ -3,7 +3,8 @@
 ## Cursor Cloud specific instructions
 
 AlphaEngine is a pure-Python CLI + library (`alphaengine`) for validated quant
-research. There is no GUI; all interaction is via the terminal or
+research. There is no windowed GUI: the product is a terminal session (an
+animated parameter-surface canvas at boot and while Working) plus
 `import alphaengine`.
 
 ### Environment
@@ -29,12 +30,20 @@ research. There is no GUI; all interaction is via the terminal or
 - **Three rungs.** `demo` and the importable library are fully offline. Workflow
   CLI verbs (`diagnose`, `screen`, …, `run <workflow>`) need a portal
   `ae_live_` key (`QUANTOS_API_KEY`). Plain-English mode also needs a **model**
-  key. Any OpenAI-compatible key works: Anthropic, OpenAI (`OPENAI_BASE_URL` for
+  key. In a session: `login` (QuantOS) or `login anthropic`. `key` is the same
+  verb. Any OpenAI-compatible key works: Anthropic, OpenAI (`OPENAI_BASE_URL` for
   gateways), Gemini, Groq, OpenRouter, Azure, or
   `ALPHAENGINE_API_KEY`+`ALPHAENGINE_BASE_URL`. `alphaengine models` lists what
   this machine can actually use. Keys may persist in
   `~/.config/alphaengine/credentials.json` (mode 0600) if the user says yes at
-  `key <provider>`; env always wins. LLM keys are never sent to QuantOS.
+  `login`; env always wins. LLM keys are never sent to QuantOS.
+- **One data verb.** `load prices.csv` / `load research.momentum` / `load sp500`
+  unifies `--data` / `--project` / `--universe`. The old verbs still work.
+- **Motion is a real TTY.** Boot and `Working` paint a tall parameter-surface
+  canvas. Tests that monkeypatch `_tty` get colour without frame sleeps
+  (`_live_tty` gates motion). Do not add `time.sleep` on the `_tty()` path.
+  This image often has `NO_COLOR=1`; unset it to see the canvas
+  (`env -u NO_COLOR COLORTERM=truecolor TERM=xterm-256color`).
 - **A stop / `marginal` verdict exits 0.** Only a step that could not execute
   exits non-zero. Unauthenticated workflow calls exit 2.
 - **Data never leaves.** Executor and study-report guards refuse lists longer
@@ -45,10 +54,15 @@ research. There is no GUI; all interaction is via the terminal or
   keys. `alphaengine trace` reads the local dump.
 - **Goldens are a public contract.** Do not "fix" a golden to land a speedup;
   that is a version bump (`_version.py`).
-- **New compute ops** (`backtest`, `score_backtest`, `cpcv`, `factors`, `pairs`,
-  `cointegrated_pairs`, `walk_forward`, `book_overlap`) are on the executor.
-  The portal must offer them in a workflow graph or they sit unused; the CLI
-  remains useful without them.
+- **Compute ops on the executor** include the 0.6 workflow set (`backtest`,
+  `score_backtest`, `cpcv`, `factors`, `pairs`, `cointegrated_pairs`,
+  `walk_forward`, `book_overlap`) and the 0.7 CS / book set
+  (`panel_transform`, `signal_icir`, `fama_macbeth`, `quantile_book`,
+  `ewma_cov`, `denoise_cov`, `hrp`, `risk_parity`, `vol_target`). Panels and
+  covariance matrices stay in the workspace; figures go over the wire. The
+  portal must offer an op in a workflow graph or it sits unused; the CLI
+  remains useful without them. Short names in a panel are skipped and counted,
+  they do not shrink the rest of the book.
 - `sweep(..., jobs=N)` defaults to 1. Greater than 1 is opt-in and must keep
   trial index identity, including failures.
 - The `connectors` extra is lazy: parquet via `pyarrow`, HTTP via `httpx` to a

{alphaengine-0.6.0 → alphaengine-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: alphaengine
-Version: 0.6.0
+Version: 0.7.0
 Summary: Validated research tooling for investment strategies: deflation, overfitting detection, and honest trial counts.
 Project-URL: Homepage, https://github.com/quantOSC/alphaengine
 Project-URL: Documentation, https://github.com/quantOSC/alphaengine#readme
@@ -40,17 +40,50 @@ Provides-Extra: factors
 Requires-Dist: statsmodels>=0.14; extra == 'factors'
 Description-Content-Type: text/markdown
 
-# AlphaEngine
+<p align="center">
+  <img src="docs/assets/banner.png" alt="AlphaEngine: the research loop, on your machine" width="100%">
+</p>
 
-**The research loop, on your machine.** Ask what is worth looking at, whether it
-holds up, how much to hold, and whether anything has crossed a line. Your data
-never leaves.
+<h1 align="center">AlphaEngine</h1>
+
+<p align="center">
+  <strong>The research loop, on your machine.</strong><br>
+  Ask what is worth looking at, whether it holds up, how much to hold,<br>
+  and whether anything has crossed a line. Your data never leaves.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/alphaengine/"><img src="https://img.shields.io/pypi/v/alphaengine.svg?style=flat-square&color=1B7A7A" alt="PyPI"></a>
+  <a href="https://pypi.org/project/alphaengine/"><img src="https://img.shields.io/pypi/pyversions/alphaengine.svg?style=flat-square" alt="Python 3.10+"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-0B1220?style=flat-square" alt="Apache 2.0"></a>
+  <a href="https://github.com/quantOSC/alphaengine/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/quantOSC/alphaengine/ci.yml?branch=main&style=flat-square&label=CI" alt="CI"></a>
+  <img src="https://img.shields.io/badge/deps-numpy%20%2B%20scipy-C4893A?style=flat-square" alt="Two dependencies: numpy and scipy">
+</p>
+
+<p align="center">
+  <img src="docs/assets/mark.png" alt="AlphaEngine mark" width="96">
+</p>
 
 ```bash
 pip install alphaengine
 alphaengine demo          # the whole offline half, no account, no data of your own
 ```
 
+<p align="center">
+  <img src="docs/assets/session.png" alt="The session canvas: a living parameter surface, then demo, login, load" width="92%">
+</p>
+
+The session is the product. Sign in, load something, then ask:
+
+```bash
+alphaengine
+❯ login
+❯ load prices.csv
+❯ screen
+```
+
+---
+
 ## What it answers
 
 Eight questions, in the order a research week actually asks them. The command
@@ -84,7 +117,7 @@ Or say it in plain English and let your own model pick:
 
 ```bash
 alphaengine
-> which of my names are overbought on RSI?
+❯ which of my names are overbought on RSI?
 ```
 
 That second path is EXPLORATORY: the model chooses a workflow and then chooses
@@ -92,27 +125,48 @@ each step from what the server permits. Two runs of the same question may
 differ, and the run says so. `run <workflow>` is SCRIPTED and reproducible.
 Both are legitimate; presenting one as the other is not.
 
+---
+
 ## The three rungs
 
-Each is useful without the one above it. The boot screen shows which are lit.
+Each is useful without the one above it. `login` lights the next one.
 
 | Rung | What you need | What you get |
 |---|---|---|
 | **The maths** | nothing | Every statistic, offline, forever. No account. |
-| **Workflows** | a QuantOS `ae_live_` key | The loop end to end, with the record. |
-| **Ask anything** | your OWN model key | Plain English in. Runs under your account, not ours. |
+| **Workflows** | a QuantOS `ae_live_` key (`login`) | The loop end to end, with the record. |
+| **Ask anything** | your OWN model key (`login anthropic`) | Plain English in. Runs under your account, not ours. |
 
 Nothing here stores a model key: it is read from your environment at call time
 and handed to the provider's own client. There is no field to put one in.
 
+```mermaid
+flowchart LR
+  A["demo / import<br/>offline maths"] --> B["login<br/>QuantOS key"]
+  B --> C["login anthropic<br/>your model"]
+  A -.->|"no account"| D["DSR · PBO · ICIR · HRP"]
+  B -.->|"ae_live_"| E["screen · validate · runs"]
+  C -.->|"BYOK"| F["plain English in"]
+```
+
+---
+
 ## Getting your data in
 
-Three doors, and nothing is ever fetched on your behalf.
+One verb, three shapes. Nothing is ever fetched on your behalf.
+
+```bash
+load prices.csv              # a local CSV
+load sp500                   # registered in the portal, with the closes you stored
+load research.momentum       # a module of yours (the only door that can carry a simulator)
+```
+
+From a shell the same doors are flags, for scripts:
 
 ```bash
-alphaengine run screen_universe --data prices.csv          # a local CSV
-alphaengine run screen_universe --universe sp500           # registered in the portal
-alphaengine run validate_study --project research.momentum # a module of yours
+alphaengine screen --data prices.csv
+alphaengine screen --universe sp500
+alphaengine validate --project research.momentum
 ```
 
 `--data` reads three shapes, decided by the header and nothing else:
@@ -136,6 +190,39 @@ for the scores it measures — while the rest run on prices alone.
 upload decrypted back to your own account, not us fetching market data, and the
 distinction is the whole of the data boundary below.
 
+<p align="center">
+  <img src="docs/assets/data_boundary.png" alt="Your machine holds prices and notebooks; only figures cross to the QuantOS record" width="92%">
+</p>
+
+---
+
+## What's new in 0.7.0
+
+The daily modelling morning, and the overnight book, without a third
+dependency. Existing goldens (deflated Sharpe, PBO, performance, screen) are
+byte-identical. New figures are a public contract from this release.
+
+| You have | You get | Module |
+|---|---|---|
+| A raw factor panel | Cross-sectional rank, z-score, winsorize, neutralize | `core.panel` |
+| A signal and prices | ICIR, Newey-West t-stat, Fama-MacBeth λ, quantile book with one-way turnover | `core.signals`, `core.cross_section` |
+| A return panel | EWMA / Ledoit-Wolf / Marchenko-Pastur covariance, HRP, risk parity, vol target | `core.covariance`, `core.allocate` |
+
+The session is slimmer too: `login` lights a rung, `load` is the one data verb,
+and boot paints the parameter surface this tool actually judges rather than a
+command encyclopedia.
+
+```python
+from alphaengine.core import cs_zscore, signal_icir, hrp_weights, fama_macbeth
+
+z = cs_zscore(factor_panel)          # skipped names are counted, not dropped
+ic = signal_icir(signal, prices)     # Spearman ICIR; Pearson is opt-in
+fm = fama_macbeth(signal, prices)    # λ_mean, t-stat, Newey-West
+w = hrp_weights(cov, names=names)    # no matrix inverse; weights sum to one
+```
+
+---
+
 ## Command reference
 
 `alphaengine commands` prints this directory in the terminal, and
@@ -154,7 +241,8 @@ distinction is the whole of the data boundary below.
 | `gaps` | what your record says is UNANSWERED, and what closes each one | shell + session |
 | `tonight [--budget N]` | what would run unattended tonight, without running any of it | shell + session |
 | `workflows` | what the server offers, what each needs, and which reproduce | shell + session |
-| `key [quantos \| anthropic \| openai \| gemini \| groq \| azure \| openrouter \| gateway]` | enter a credential now, or see which rungs are unlocked | session |
+| `login [quantos \| anthropic \| openai \| gemini \| groq \| azure \| openrouter \| gateway]` | sign in, or login anthropic for a model key | shell + session |
+| `key [quantos \| anthropic \| openai \| gemini \| groq \| azure \| openrouter \| gateway]` | same as login: enter a credential, or see which rungs are lit | session |
 | `commands [verb]` | this directory, or one command in full | shell + session |
 | `models` | which model providers this machine can actually use | shell + session |
 | `model [<provider[:name]>]` | pin the model for this session, or show the pin | session |
@@ -181,9 +269,10 @@ distinction is the whole of the data boundary below.
 | Command | Does | Where |
 |---|---|---|
 | `book [<name> \| status]` | show or load sleeves on the multi-strategy book | session |
-| `universe <name>` | load a universe you registered in the portal, with its closes | session |
-| `data <file>` | load a local CSV or parquet without leaving the session | session |
-| `project <module>` | load `data` and `backtest_fn` from a module of yours | session |
+| `load <file \| module \| universe>` | a CSV, a project module, or a portal universe | session |
+| `universe <name>` | same as load: a universe registered in the portal | session |
+| `data <file>` | same as load: a local CSV or parquet | session |
+| `project <module>` | same as load: a module with data and backtest_fn | session |
 
 ### Session
 
@@ -191,7 +280,7 @@ distinction is the whole of the data boundary below.
 |---|---|---|
 | `logout` | remove stored credentials from this machine | shell + session |
 | `version` | print the version | shell |
-| `help` | the short list | session |
+| `help` | the short list: demo, login, load, then a question | session |
 | `quit` | leave the session | session |
 
 ### Data flags
@@ -237,6 +326,7 @@ alphaengine gaps
 alphaengine tonight
 alphaengine tonight --budget 5
 alphaengine workflows
+alphaengine login
 alphaengine commands
 alphaengine run screen_universe --universe sp500
 alphaengine run size_position --data returns.csv
@@ -329,7 +419,12 @@ diffable, and versioned so it still parses in two years.
 
 | Module | Contents |
 |---|---|
-| `alphaengine.core` | deflated Sharpe, PSR, PBO via CSCV, CPCV, minimum track record length, performance and risk statistics |
+| `alphaengine.core` | deflated Sharpe, PSR, PBO via CSCV, CPCV, minimum track record length, performance and risk |
+| `alphaengine.core.panel` | cross-sectional rank, z-score, winsorize, neutralize |
+| `alphaengine.core.signals` | IC, ICIR, quantile returns, decay |
+| `alphaengine.core.cross_section` | Fama-MacBeth, quantile book with turnover |
+| `alphaengine.core.covariance` | EWMA, Ledoit-Wolf, Marchenko-Pastur denoise, detone |
+| `alphaengine.core.allocate` | HRP, risk parity, vol target |
 | `alphaengine.sweep` | the grid runner and the sensitivity surface |
 | `alphaengine.study` | the study artifact and its schema |
 | `alphaengine.client` | the workflow client and the step executor |
@@ -401,12 +496,28 @@ Probability of Backtest Overfitting." *Journal of Computational Finance* 20(4),
 López de Prado, M. (2018). *Advances in Financial Machine Learning.* Wiley,
 chapters 7 and 12.
 
+**Hierarchical Risk Parity**
+López de Prado, M. (2016). "Building Diversified Portfolios that Outperform
+Out of Sample." *Journal of Portfolio Management* 42(4), 59 to 69.
+
+**Covariance shrinkage and spectral denoising**
+Ledoit, O., and Wolf, M. (2004). "A Well-Conditioned Estimator for
+Large-Dimensional Covariance Matrices." *Journal of Multivariate Analysis*
+88(2), 365 to 411.
+Laloux, L., Cizeau, P., Bouchaud, J.-P., and Potters, M. (1999). "Noise
+Dressing of Financial Correlation Matrices." *Physical Review Letters* 83(7),
+1467 to 1470.
+
 **Multiple testing in asset pricing**
 Harvey, C. R., Liu, Y., and Zhu, H. (2016). "... and the Cross-Section of
 Expected Returns." *Review of Financial Studies* 29(1), 5 to 68.
 Harvey, C. R., and Liu, Y. (2015). "Backtesting." *Journal of Portfolio
 Management* 42(1), 13 to 28.
 
+**Fama-MacBeth**
+Fama, E. F., and MacBeth, J. D. (1973). "Risk, Return, and Equilibrium:
+Empirical Tests." *Journal of Political Economy* 81(3), 607 to 636.
+
 **Downside deviation**
 Sortino, F. A., and Price, L. N. (1994). "Performance Measurement in a Downside
 Risk Framework." *Journal of Investing* 3(3), 59 to 64.

{alphaengine-0.6.0 → alphaengine-0.7.0}/README.md

@@ -1,14 +1,47 @@
-# AlphaEngine
-
-**The research loop, on your machine.** Ask what is worth looking at, whether it
-holds up, how much to hold, and whether anything has crossed a line. Your data
-never leaves.
+<p align="center">
+  <img src="docs/assets/banner.png" alt="AlphaEngine: the research loop, on your machine" width="100%">
+</p>
+
+<h1 align="center">AlphaEngine</h1>
+
+<p align="center">
+  <strong>The research loop, on your machine.</strong><br>
+  Ask what is worth looking at, whether it holds up, how much to hold,<br>
+  and whether anything has crossed a line. Your data never leaves.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/alphaengine/"><img src="https://img.shields.io/pypi/v/alphaengine.svg?style=flat-square&color=1B7A7A" alt="PyPI"></a>
+  <a href="https://pypi.org/project/alphaengine/"><img src="https://img.shields.io/pypi/pyversions/alphaengine.svg?style=flat-square" alt="Python 3.10+"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-0B1220?style=flat-square" alt="Apache 2.0"></a>
+  <a href="https://github.com/quantOSC/alphaengine/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/quantOSC/alphaengine/ci.yml?branch=main&style=flat-square&label=CI" alt="CI"></a>
+  <img src="https://img.shields.io/badge/deps-numpy%20%2B%20scipy-C4893A?style=flat-square" alt="Two dependencies: numpy and scipy">
+</p>
+
+<p align="center">
+  <img src="docs/assets/mark.png" alt="AlphaEngine mark" width="96">
+</p>
 
 ```bash
 pip install alphaengine
 alphaengine demo          # the whole offline half, no account, no data of your own
 ```
 
+<p align="center">
+  <img src="docs/assets/session.png" alt="The session canvas: a living parameter surface, then demo, login, load" width="92%">
+</p>
+
+The session is the product. Sign in, load something, then ask:
+
+```bash
+alphaengine
+❯ login
+❯ load prices.csv
+❯ screen
+```
+
+---
+
 ## What it answers
 
 Eight questions, in the order a research week actually asks them. The command
@@ -42,7 +75,7 @@ Or say it in plain English and let your own model pick:
 
 ```bash
 alphaengine
-> which of my names are overbought on RSI?
+❯ which of my names are overbought on RSI?
 ```
 
 That second path is EXPLORATORY: the model chooses a workflow and then chooses
@@ -50,27 +83,48 @@ each step from what the server permits. Two runs of the same question may
 differ, and the run says so. `run <workflow>` is SCRIPTED and reproducible.
 Both are legitimate; presenting one as the other is not.
 
+---
+
 ## The three rungs
 
-Each is useful without the one above it. The boot screen shows which are lit.
+Each is useful without the one above it. `login` lights the next one.
 
 | Rung | What you need | What you get |
 |---|---|---|
 | **The maths** | nothing | Every statistic, offline, forever. No account. |
-| **Workflows** | a QuantOS `ae_live_` key | The loop end to end, with the record. |
-| **Ask anything** | your OWN model key | Plain English in. Runs under your account, not ours. |
+| **Workflows** | a QuantOS `ae_live_` key (`login`) | The loop end to end, with the record. |
+| **Ask anything** | your OWN model key (`login anthropic`) | Plain English in. Runs under your account, not ours. |
 
 Nothing here stores a model key: it is read from your environment at call time
 and handed to the provider's own client. There is no field to put one in.
 
+```mermaid
+flowchart LR
+  A["demo / import<br/>offline maths"] --> B["login<br/>QuantOS key"]
+  B --> C["login anthropic<br/>your model"]
+  A -.->|"no account"| D["DSR · PBO · ICIR · HRP"]
+  B -.->|"ae_live_"| E["screen · validate · runs"]
+  C -.->|"BYOK"| F["plain English in"]
+```
+
+---
+
 ## Getting your data in
 
-Three doors, and nothing is ever fetched on your behalf.
+One verb, three shapes. Nothing is ever fetched on your behalf.
+
+```bash
+load prices.csv              # a local CSV
+load sp500                   # registered in the portal, with the closes you stored
+load research.momentum       # a module of yours (the only door that can carry a simulator)
+```
+
+From a shell the same doors are flags, for scripts:
 
 ```bash
-alphaengine run screen_universe --data prices.csv          # a local CSV
-alphaengine run screen_universe --universe sp500           # registered in the portal
-alphaengine run validate_study --project research.momentum # a module of yours
+alphaengine screen --data prices.csv
+alphaengine screen --universe sp500
+alphaengine validate --project research.momentum
 ```
 
 `--data` reads three shapes, decided by the header and nothing else:
@@ -94,6 +148,39 @@ for the scores it measures — while the rest run on prices alone.
 upload decrypted back to your own account, not us fetching market data, and the
 distinction is the whole of the data boundary below.
 
+<p align="center">
+  <img src="docs/assets/data_boundary.png" alt="Your machine holds prices and notebooks; only figures cross to the QuantOS record" width="92%">
+</p>
+
+---
+
+## What's new in 0.7.0
+
+The daily modelling morning, and the overnight book, without a third
+dependency. Existing goldens (deflated Sharpe, PBO, performance, screen) are
+byte-identical. New figures are a public contract from this release.
+
+| You have | You get | Module |
+|---|---|---|
+| A raw factor panel | Cross-sectional rank, z-score, winsorize, neutralize | `core.panel` |
+| A signal and prices | ICIR, Newey-West t-stat, Fama-MacBeth λ, quantile book with one-way turnover | `core.signals`, `core.cross_section` |
+| A return panel | EWMA / Ledoit-Wolf / Marchenko-Pastur covariance, HRP, risk parity, vol target | `core.covariance`, `core.allocate` |
+
+The session is slimmer too: `login` lights a rung, `load` is the one data verb,
+and boot paints the parameter surface this tool actually judges rather than a
+command encyclopedia.
+
+```python
+from alphaengine.core import cs_zscore, signal_icir, hrp_weights, fama_macbeth
+
+z = cs_zscore(factor_panel)          # skipped names are counted, not dropped
+ic = signal_icir(signal, prices)     # Spearman ICIR; Pearson is opt-in
+fm = fama_macbeth(signal, prices)    # λ_mean, t-stat, Newey-West
+w = hrp_weights(cov, names=names)    # no matrix inverse; weights sum to one
+```
+
+---
+
 ## Command reference
 
 `alphaengine commands` prints this directory in the terminal, and
@@ -112,7 +199,8 @@ distinction is the whole of the data boundary below.
 | `gaps` | what your record says is UNANSWERED, and what closes each one | shell + session |
 | `tonight [--budget N]` | what would run unattended tonight, without running any of it | shell + session |
 | `workflows` | what the server offers, what each needs, and which reproduce | shell + session |
-| `key [quantos \| anthropic \| openai \| gemini \| groq \| azure \| openrouter \| gateway]` | enter a credential now, or see which rungs are unlocked | session |
+| `login [quantos \| anthropic \| openai \| gemini \| groq \| azure \| openrouter \| gateway]` | sign in, or login anthropic for a model key | shell + session |
+| `key [quantos \| anthropic \| openai \| gemini \| groq \| azure \| openrouter \| gateway]` | same as login: enter a credential, or see which rungs are lit | session |
 | `commands [verb]` | this directory, or one command in full | shell + session |
 | `models` | which model providers this machine can actually use | shell + session |
 | `model [<provider[:name]>]` | pin the model for this session, or show the pin | session |
@@ -139,9 +227,10 @@ distinction is the whole of the data boundary below.
 | Command | Does | Where |
 |---|---|---|
 | `book [<name> \| status]` | show or load sleeves on the multi-strategy book | session |
-| `universe <name>` | load a universe you registered in the portal, with its closes | session |
-| `data <file>` | load a local CSV or parquet without leaving the session | session |
-| `project <module>` | load `data` and `backtest_fn` from a module of yours | session |
+| `load <file \| module \| universe>` | a CSV, a project module, or a portal universe | session |
+| `universe <name>` | same as load: a universe registered in the portal | session |
+| `data <file>` | same as load: a local CSV or parquet | session |
+| `project <module>` | same as load: a module with data and backtest_fn | session |
 
 ### Session
 
@@ -149,7 +238,7 @@ distinction is the whole of the data boundary below.
 |---|---|---|
 | `logout` | remove stored credentials from this machine | shell + session |
 | `version` | print the version | shell |
-| `help` | the short list | session |
+| `help` | the short list: demo, login, load, then a question | session |
 | `quit` | leave the session | session |
 
 ### Data flags
@@ -195,6 +284,7 @@ alphaengine gaps
 alphaengine tonight
 alphaengine tonight --budget 5
 alphaengine workflows
+alphaengine login
 alphaengine commands
 alphaengine run screen_universe --universe sp500
 alphaengine run size_position --data returns.csv
@@ -287,7 +377,12 @@ diffable, and versioned so it still parses in two years.
 
 | Module | Contents |
 |---|---|
-| `alphaengine.core` | deflated Sharpe, PSR, PBO via CSCV, CPCV, minimum track record length, performance and risk statistics |
+| `alphaengine.core` | deflated Sharpe, PSR, PBO via CSCV, CPCV, minimum track record length, performance and risk |
+| `alphaengine.core.panel` | cross-sectional rank, z-score, winsorize, neutralize |
+| `alphaengine.core.signals` | IC, ICIR, quantile returns, decay |
+| `alphaengine.core.cross_section` | Fama-MacBeth, quantile book with turnover |
+| `alphaengine.core.covariance` | EWMA, Ledoit-Wolf, Marchenko-Pastur denoise, detone |
+| `alphaengine.core.allocate` | HRP, risk parity, vol target |
 | `alphaengine.sweep` | the grid runner and the sensitivity surface |
 | `alphaengine.study` | the study artifact and its schema |
 | `alphaengine.client` | the workflow client and the step executor |
@@ -359,12 +454,28 @@ Probability of Backtest Overfitting." *Journal of Computational Finance* 20(4),
 López de Prado, M. (2018). *Advances in Financial Machine Learning.* Wiley,
 chapters 7 and 12.
 
+**Hierarchical Risk Parity**
+López de Prado, M. (2016). "Building Diversified Portfolios that Outperform
+Out of Sample." *Journal of Portfolio Management* 42(4), 59 to 69.
+
+**Covariance shrinkage and spectral denoising**
+Ledoit, O., and Wolf, M. (2004). "A Well-Conditioned Estimator for
+Large-Dimensional Covariance Matrices." *Journal of Multivariate Analysis*
+88(2), 365 to 411.
+Laloux, L., Cizeau, P., Bouchaud, J.-P., and Potters, M. (1999). "Noise
+Dressing of Financial Correlation Matrices." *Physical Review Letters* 83(7),
+1467 to 1470.
+
 **Multiple testing in asset pricing**
 Harvey, C. R., Liu, Y., and Zhu, H. (2016). "... and the Cross-Section of
 Expected Returns." *Review of Financial Studies* 29(1), 5 to 68.
 Harvey, C. R., and Liu, Y. (2015). "Backtesting." *Journal of Portfolio
 Management* 42(1), 13 to 28.
 
+**Fama-MacBeth**
+Fama, E. F., and MacBeth, J. D. (1973). "Risk, Return, and Equilibrium:
+Empirical Tests." *Journal of Political Economy* 81(3), 607 to 636.
+
 **Downside deviation**
 Sortino, F. A., and Price, L. N. (1994). "Performance Measurement in a Downside
 Risk Framework." *Journal of Investing* 3(3), 59 to 64.

{alphaengine-0.6.0 → alphaengine-0.7.0}/src/alphaengine/_version.py

@@ -56,4 +56,19 @@ is what a changed figure costs. The API may still move underneath it.
 # A new published wheel is a new thing people `pip install`. While the leading
 # digit is 0 the MINOR position carries that, the same way 0.5.0 carried a
 # surface change that left every figure byte-identical.
-__version__ = "0.6.0"
+#
+# 0.6.1 IS THE SCREEN, NOT THE MATHS. No computed value moved. The session is a
+# transcript now: a hue-cycling wait-star over a travelling plateau, cards for
+# what a step found, a composer instead of a dashboard. Same rungs, same
+# doors, same refusals. The published artefact is a new wheel because 0.6.0
+# already left the building.
+#
+# 0.7.0 IS NEW PUBLIC FIGURES, AND A SIMPLER OS AROUND THEM. Existing DSR /
+# PBO / performance / screen goldens stay byte-identical. The artefact grew
+# the daily cross-section (rank, z-score, winsorize, neutralize, ICIR,
+# Fama-MacBeth, quantile book with turnover) and the overnight book
+# (EWMA / Ledoit-Wolf / Marchenko-Pastur covariance, HRP, risk parity, vol
+# target), plus a living parameter-surface canvas and one-verb `login` /
+# `load`. New numbers are a public contract from this release; old numbers
+# did not move.
+__version__ = "0.7.0"