asrquant 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- asrquant-1.0.0/CHANGELOG.md +82 -0
- asrquant-1.0.0/CITATION.cff +28 -0
- asrquant-1.0.0/CODE_OF_CONDUCT.md +5 -0
- asrquant-1.0.0/CONTRIBUTING.md +32 -0
- asrquant-1.0.0/LICENSE +21 -0
- asrquant-1.0.0/MANIFEST.in +11 -0
- asrquant-1.0.0/PAPER_PACKAGE_CONTRACT_v1.0.0.md +33 -0
- asrquant-1.0.0/PKG-INFO +3849 -0
- asrquant-1.0.0/PRODUCTION_READINESS_CHECKLIST.md +69 -0
- asrquant-1.0.0/PYPI_DEPLOYMENT_GUIDE_FR.md +47 -0
- asrquant-1.0.0/README.md +3772 -0
- asrquant-1.0.0/RELEASE_CHECKLIST.md +39 -0
- asrquant-1.0.0/RELEASE_NOTES.md +47 -0
- asrquant-1.0.0/SECURITY.md +74 -0
- asrquant-1.0.0/THREAT_MODEL.md +79 -0
- asrquant-1.0.0/VALIDATION_v1.0.0.txt +66 -0
- asrquant-1.0.0/benchmarks/baseline_metrics.csv +25 -0
- asrquant-1.0.0/benchmarks/baseline_timeseries.csv +1501 -0
- asrquant-1.0.0/benchmarks/binomial_validation.csv +8 -0
- asrquant-1.0.0/benchmarks/extended_validation.py +108 -0
- asrquant-1.0.0/benchmarks/fragile_implementation_audit.csv +7 -0
- asrquant-1.0.0/benchmarks/fragile_implementation_audit_diagnostics.csv +8 -0
- asrquant-1.0.0/benchmarks/implementation_audit.csv +25 -0
- asrquant-1.0.0/benchmarks/implementation_audit_diagnostics.csv +8 -0
- asrquant-1.0.0/benchmarks/martingale_validation.csv +9 -0
- asrquant-1.0.0/benchmarks/monte_carlo_validation.csv +6 -0
- asrquant-1.0.0/benchmarks/parameter_landscape.csv +17 -0
- asrquant-1.0.0/benchmarks/regression_validation.csv +4 -0
- asrquant-1.0.0/benchmarks/run_benchmarks.py +88 -0
- asrquant-1.0.0/benchmarks/runtime_scaling.csv +6 -0
- asrquant-1.0.0/deployment/evidence.template.json +31 -0
- asrquant-1.0.0/deployment/risk_policy.example.json +25 -0
- asrquant-1.0.0/docs/algorithmic_trading.md +78 -0
- asrquant-1.0.0/docs/api_catalog.md +84 -0
- asrquant-1.0.0/docs/approximation_and_sensitivities.md +101 -0
- asrquant-1.0.0/docs/data_sources.md +119 -0
- asrquant-1.0.0/docs/deployment.md +43 -0
- asrquant-1.0.0/docs/live_trading.md +160 -0
- asrquant-1.0.0/docs/methodology.md +69 -0
- asrquant-1.0.0/docs/model_catalog.md +144 -0
- asrquant-1.0.0/docs/monte_carlo_universal.md +133 -0
- asrquant-1.0.0/docs/one_import_api.md +88 -0
- asrquant-1.0.0/docs/operations_runbook.md +81 -0
- asrquant-1.0.0/docs/parameter_surfaces.md +163 -0
- asrquant-1.0.0/docs/production_readiness.md +145 -0
- asrquant-1.0.0/docs/quickstart.md +113 -0
- asrquant-1.0.0/docs/regulatory_controls.md +53 -0
- asrquant-1.0.0/docs/release_checklist.md +39 -0
- asrquant-1.0.0/docs/research_workflow.md +340 -0
- asrquant-1.0.0/docs/validation.md +23 -0
- asrquant-1.0.0/docs/visualization_catalog.md +37 -0
- asrquant-1.0.0/examples/animated_parameter_surface.py +50 -0
- asrquant-1.0.0/examples/approximation_surfaces.py +31 -0
- asrquant-1.0.0/examples/csv_end_to_end.py +15 -0
- asrquant-1.0.0/examples/custom_strategy.py +14 -0
- asrquant-1.0.0/examples/derivative_models.py +14 -0
- asrquant-1.0.0/examples/hedging_parameter_animation.py +92 -0
- asrquant-1.0.0/examples/hypothesis_to_paper_trading.py +42 -0
- asrquant-1.0.0/examples/implementation_audit.py +15 -0
- asrquant-1.0.0/examples/literature_to_decision.py +22 -0
- asrquant-1.0.0/examples/martingale_diagnostics.py +13 -0
- asrquant-1.0.0/examples/ml_walk_forward.py +24 -0
- asrquant-1.0.0/examples/multidimensional_parameter_explorer.py +58 -0
- asrquant-1.0.0/examples/options_surface.py +11 -0
- asrquant-1.0.0/examples/parameter_surface_compact.py +23 -0
- asrquant-1.0.0/examples/production_live_guarded.py +56 -0
- asrquant-1.0.0/examples/provider_data.py +14 -0
- asrquant-1.0.0/examples/quickstart.py +9 -0
- asrquant-1.0.0/examples/regression_diagnostics.py +9 -0
- asrquant-1.0.0/examples/regression_econometrics.py +19 -0
- asrquant-1.0.0/examples/sample_prices.csv +301 -0
- asrquant-1.0.0/examples/stochastic_monte_carlo.py +34 -0
- asrquant-1.0.0/examples/universal_monte_carlo.py +47 -0
- asrquant-1.0.0/paper/ASRQuant_paper.pdf +0 -0
- asrquant-1.0.0/paper/figures/asrquant_architecture_v100.png +0 -0
- asrquant-1.0.0/paper/figures/dashboard.png +0 -0
- asrquant-1.0.0/paper/figures/extended_validation_v100.png +0 -0
- asrquant-1.0.0/paper/figures/fragile_implementation_audit.png +0 -0
- asrquant-1.0.0/paper/figures/implementation_audit.png +0 -0
- asrquant-1.0.0/paper/figures/multidimensional_surface_v100.png +0 -0
- asrquant-1.0.0/paper/figures/parameter_surface.png +0 -0
- asrquant-1.0.0/paper/figures/volatility_surface.png +0 -0
- asrquant-1.0.0/paper/main.tex +1379 -0
- asrquant-1.0.0/pyproject.toml +96 -0
- asrquant-1.0.0/requirements/quality.txt +5 -0
- asrquant-1.0.0/requirements/runtime.txt +14 -0
- asrquant-1.0.0/requirements/security.txt +5 -0
- asrquant-1.0.0/scripts/bootstrap_repository.sh +27 -0
- asrquant-1.0.0/scripts/check_release.py +61 -0
- asrquant-1.0.0/scripts/check_secret_scan.py +28 -0
- asrquant-1.0.0/scripts/test_all.py +79 -0
- asrquant-1.0.0/setup.cfg +4 -0
- asrquant-1.0.0/setup.py +3 -0
- asrquant-1.0.0/src/asrquant/__init__.py +230 -0
- asrquant-1.0.0/src/asrquant/__main__.py +3 -0
- asrquant-1.0.0/src/asrquant/api.py +748 -0
- asrquant-1.0.0/src/asrquant/approximation.py +294 -0
- asrquant-1.0.0/src/asrquant/audit.py +72 -0
- asrquant-1.0.0/src/asrquant/audit_store.py +356 -0
- asrquant-1.0.0/src/asrquant/backtest.py +194 -0
- asrquant-1.0.0/src/asrquant/cli.py +394 -0
- asrquant-1.0.0/src/asrquant/config.py +117 -0
- asrquant-1.0.0/src/asrquant/data.py +192 -0
- asrquant-1.0.0/src/asrquant/derivatives.py +305 -0
- asrquant-1.0.0/src/asrquant/easy.py +252 -0
- asrquant-1.0.0/src/asrquant/fixed_income.py +149 -0
- asrquant-1.0.0/src/asrquant/literature.py +536 -0
- asrquant-1.0.0/src/asrquant/live.py +897 -0
- asrquant-1.0.0/src/asrquant/machine_learning.py +178 -0
- asrquant-1.0.0/src/asrquant/martingales.py +74 -0
- asrquant-1.0.0/src/asrquant/math.py +88 -0
- asrquant-1.0.0/src/asrquant/metrics.py +323 -0
- asrquant-1.0.0/src/asrquant/models.py +239 -0
- asrquant-1.0.0/src/asrquant/monte_carlo.py +502 -0
- asrquant-1.0.0/src/asrquant/optimization.py +223 -0
- asrquant-1.0.0/src/asrquant/production.py +475 -0
- asrquant-1.0.0/src/asrquant/provenance.py +47 -0
- asrquant-1.0.0/src/asrquant/providers.py +282 -0
- asrquant-1.0.0/src/asrquant/report.py +68 -0
- asrquant-1.0.0/src/asrquant/research.py +81 -0
- asrquant-1.0.0/src/asrquant/simulation.py +419 -0
- asrquant-1.0.0/src/asrquant/statistics.py +375 -0
- asrquant-1.0.0/src/asrquant/strategies.py +177 -0
- asrquant-1.0.0/src/asrquant/surfaces.py +803 -0
- asrquant-1.0.0/src/asrquant/trading.py +363 -0
- asrquant-1.0.0/src/asrquant/validation.py +99 -0
- asrquant-1.0.0/src/asrquant/version.py +2 -0
- asrquant-1.0.0/src/asrquant/viz/__init__.py +16 -0
- asrquant-1.0.0/src/asrquant/viz/base.py +58 -0
- asrquant-1.0.0/src/asrquant/viz/derivatives.py +182 -0
- asrquant-1.0.0/src/asrquant/viz/general.py +204 -0
- asrquant-1.0.0/src/asrquant/viz/market.py +306 -0
- asrquant-1.0.0/src/asrquant/viz/microstructure.py +137 -0
- asrquant-1.0.0/src/asrquant/viz/ml.py +159 -0
- asrquant-1.0.0/src/asrquant/viz/performance.py +171 -0
- asrquant-1.0.0/src/asrquant/viz/portfolio.py +151 -0
- asrquant-1.0.0/src/asrquant/viz/regression.py +153 -0
- asrquant-1.0.0/src/asrquant/viz/risk.py +182 -0
- asrquant-1.0.0/src/asrquant/viz/simulation.py +135 -0
- asrquant-1.0.0/src/asrquant/volatility.py +70 -0
- asrquant-1.0.0/src/asrquant/workflow.py +1074 -0
- asrquant-1.0.0/src/asrquant.egg-info/PKG-INFO +3849 -0
- asrquant-1.0.0/src/asrquant.egg-info/SOURCES.txt +165 -0
- asrquant-1.0.0/src/asrquant.egg-info/dependency_links.txt +1 -0
- asrquant-1.0.0/src/asrquant.egg-info/entry_points.txt +2 -0
- asrquant-1.0.0/src/asrquant.egg-info/requires.txt +53 -0
- asrquant-1.0.0/src/asrquant.egg-info/top_level.txt +1 -0
- asrquant-1.0.0/tests/conftest.py +28 -0
- asrquant-1.0.0/tests/data/paper_hypothesis_sample.pdf +68 -0
- asrquant-1.0.0/tests/test_approximation_rc2.py +94 -0
- asrquant-1.0.0/tests/test_audit_validation.py +28 -0
- asrquant-1.0.0/tests/test_backtest.py +47 -0
- asrquant-1.0.0/tests/test_config_data.py +34 -0
- asrquant-1.0.0/tests/test_derivatives_optimization.py +34 -0
- asrquant-1.0.0/tests/test_metrics.py +46 -0
- asrquant-1.0.0/tests/test_monte_carlo_universal_rc2.py +129 -0
- asrquant-1.0.0/tests/test_one_import_api_v040.py +53 -0
- asrquant-1.0.0/tests/test_paper_contract_v1.py +363 -0
- asrquant-1.0.0/tests/test_production_readiness_v1.py +794 -0
- asrquant-1.0.0/tests/test_research_pipeline_v050.py +151 -0
- asrquant-1.0.0/tests/test_statistics.py +34 -0
- asrquant-1.0.0/tests/test_surface_explorer_v030.py +110 -0
- asrquant-1.0.0/tests/test_surfaces.py +74 -0
- asrquant-1.0.0/tests/test_surfaces_parameterized.py +71 -0
- asrquant-1.0.0/tests/test_v020.py +241 -0
- asrquant-1.0.0/tests/test_visualizations.py +52 -0
- asrquant-1.0.0/tests/test_visualizations_extended.py +79 -0
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 1.0.0 - 2026-08-10
|
|
4
|
+
|
|
5
|
+
- First stable public-API release corresponding to manuscript v0.1.0.
|
|
6
|
+
- Added an 18-test executable paper-contract suite; total automated test count is 154.
|
|
7
|
+
- Reconciled every manuscript appendix workflow with the one-import API.
|
|
8
|
+
- Hardened fixed-income curve bootstrapping with explicit coupon-frequency and complete-grid validation.
|
|
9
|
+
- Regenerated empirical benchmarks and paper figures from the stable codebase.
|
|
10
|
+
- Stabilized release, coverage, security and PyPI workflows for the 1.0.0 distribution.
|
|
11
|
+
- Kept live-capital authorization separate and fail-closed from software release status.
|
|
12
|
+
|
|
13
|
+
## 1.0.0rc3 - 2026-08-01
|
|
14
|
+
|
|
15
|
+
### Fixed
|
|
16
|
+
|
|
17
|
+
- Restored compatibility across Matplotlib 3.8–3.11+ with a boxplot keyword fallback for `tick_labels` and legacy `labels`.
|
|
18
|
+
- Explicitly load the `pytest-cov` plugin when global pytest plugin autoload is disabled.
|
|
19
|
+
- Audit only shipped runtime dependencies instead of mixing development tooling into the blocking dependency gate, and generate the SBOM from an isolated installed-runtime environment.
|
|
20
|
+
- Removed unused imports and aligned the Ruff profile with correctness-oriented rules.
|
|
21
|
+
- Included the rc2 Monte Carlo and approximation tests in isolated CI domain groups.
|
|
22
|
+
|
|
23
|
+
### Changed
|
|
24
|
+
|
|
25
|
+
- Added bounded major-version ranges for runtime dependencies to reduce accidental breaking upgrades.
|
|
26
|
+
- Added `requirements/runtime.txt` as the canonical runtime dependency-audit input.
|
|
27
|
+
|
|
28
|
+
## 1.0.0rc2 - 2026-08-01
|
|
29
|
+
|
|
30
|
+
### Added
|
|
31
|
+
|
|
32
|
+
- Universal Monte Carlo engine implementing generate -> transform -> reduce for arbitrary scenario generators and pathwise quantities.
|
|
33
|
+
- Generic expectation, probability, variance, standard deviation, standard error, confidence interval, quantile, VaR and Expected Shortfall estimators.
|
|
34
|
+
- Inverse-transform sampling, normal sampling, Cholesky-correlated Gaussian scenarios and generic scalar/vector Euler-Maruyama simulation.
|
|
35
|
+
- Path-dependent hedging loss and proportional transaction-cost utilities.
|
|
36
|
+
- Static and animated Monte Carlo parameter surfaces.
|
|
37
|
+
- Linear and bilinear interpolation, cubic splines, Gaussian kernel regression, RBF interpolation and Gaussian-process surrogates.
|
|
38
|
+
- Controlled extrapolation, response-surface linear/polynomial/ridge/lasso regression, RMSE/MAE/R-squared validation, gradients and Hessians.
|
|
39
|
+
- Explicit AR(p) interface and high-level `QuantLab` wrappers for universal Monte Carlo, Monte Carlo surfaces, approximation, AR and GARCH.
|
|
40
|
+
|
|
41
|
+
### Changed
|
|
42
|
+
|
|
43
|
+
- `SurfaceResult` now exposes first- and second-order sensitivity surfaces through `gradient()` and `hessian()`.
|
|
44
|
+
- Release candidate advanced from rc1 to rc2 after filling the generic simulation and approximation gaps identified in the scientific audit.
|
|
45
|
+
|
|
46
|
+
## 1.0.0rc1 - 2026-08-01
|
|
47
|
+
|
|
48
|
+
### Added
|
|
49
|
+
|
|
50
|
+
- Production-readiness evidence gate and signed, expiring deployment certificates.
|
|
51
|
+
- Guarded Alpaca paper/live broker adapter.
|
|
52
|
+
- Pre-trade live risk engine, persistent kill switch, reconciliation and durable audit store.
|
|
53
|
+
- Operations, security, threat-model and regulatory-control documentation.
|
|
54
|
+
- 62 production-hardening tests, bringing the total collected suite to 126 tests.
|
|
55
|
+
|
|
56
|
+
### Changed
|
|
57
|
+
|
|
58
|
+
- Version moved from research alpha 0.5.0 to production-hardening release candidate 1.0.0rc1.
|
|
59
|
+
- Security policy and CI/release expectations expanded for live-capable deployments.
|
|
60
|
+
|
|
61
|
+
## 0.5.0 - 2026-08-01
|
|
62
|
+
|
|
63
|
+
- Added PDF paper ingestion with page-level provenance and corpus fingerprints.
|
|
64
|
+
- Added source-linked hypothesis discovery and corpus-relative novelty labels.
|
|
65
|
+
- Added the complete `ResearchProject` workflow from hypothesis through data, features, signals, econometric testing, backtesting, robustness, decisions, manifests, and reports.
|
|
66
|
+
- Added provider-assisted data-plan downloads and leakage-aware feature specifications.
|
|
67
|
+
- Added order-level paper trading, broker-neutral interfaces, order states, partial fills, cash and position accounting, and risk controls.
|
|
68
|
+
- Added CLI `papers` and `research` commands.
|
|
69
|
+
- Added literature-to-decision and algorithmic-trading guides and examples.
|
|
70
|
+
- Expanded the automated suite to 64 tests.
|
|
71
|
+
|
|
72
|
+
## 0.1.0 - 2026-07-31
|
|
73
|
+
|
|
74
|
+
Initial research release.
|
|
75
|
+
|
|
76
|
+
- Added specification-first multi-asset backtesting.
|
|
77
|
+
- Added transparent linear, nonlinear, and borrow costs.
|
|
78
|
+
- Added implementation-contract audit.
|
|
79
|
+
- Added performance, risk, regression, validation, portfolio, derivatives, and simulation modules.
|
|
80
|
+
- Added 69 user-facing visualizations.
|
|
81
|
+
- Added self-contained HTML reports and reproducibility manifests.
|
|
82
|
+
- Added 26 automated tests, examples, benchmarks, and a 24-page paper.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: "If you use ASRQuant in research, please cite the software and accompanying paper."
|
|
3
|
+
title: "ASRQuant: From Scientific Literature to Auditable Quantitative Decisions and Algorithmic Trading"
|
|
4
|
+
type: software
|
|
5
|
+
authors:
|
|
6
|
+
- family-names: "TOURE"
|
|
7
|
+
given-names: "Alpha Kabinet"
|
|
8
|
+
- name: "Alpha Stochastic Research"
|
|
9
|
+
version: 1.0.0
|
|
10
|
+
date-released: 2026-08-10
|
|
11
|
+
license: MIT
|
|
12
|
+
repository-code: "https://github.com/Alpha-Stochastic-Research/asrquant"
|
|
13
|
+
url: "https://www.asr-lab.online"
|
|
14
|
+
keywords:
|
|
15
|
+
- scientific literature
|
|
16
|
+
- economic hypotheses
|
|
17
|
+
- algorithmic trading
|
|
18
|
+
- paper trading
|
|
19
|
+
- quantitative finance
|
|
20
|
+
- stochastic processes
|
|
21
|
+
- Monte Carlo
|
|
22
|
+
- derivatives
|
|
23
|
+
- econometrics
|
|
24
|
+
- machine learning
|
|
25
|
+
- backtesting
|
|
26
|
+
- visualization
|
|
27
|
+
- implementation risk
|
|
28
|
+
- reproducibility
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Code of Conduct
|
|
2
|
+
|
|
3
|
+
Participants must communicate professionally, critique ideas rather than people, disclose conflicts of interest, respect licenses and data rights, and avoid presenting unverifiable investment claims as scientific facts. Harassment, discrimination, plagiarism, fabricated results, and manipulation of tests or benchmarks are not accepted.
|
|
4
|
+
|
|
5
|
+
Reports may be sent to research@asr-lab.online.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Contributing to ASRQuant
|
|
2
|
+
|
|
3
|
+
ASRQuant uses pull requests, automated tests, and explicit scientific review.
|
|
4
|
+
|
|
5
|
+
## Development setup
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
python -m venv .venv
|
|
9
|
+
source .venv/bin/activate
|
|
10
|
+
pip install -e ".[dev]"
|
|
11
|
+
pytest
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Requirements for a contribution
|
|
15
|
+
|
|
16
|
+
1. State the quantitative-finance use case and the formula or convention implemented.
|
|
17
|
+
2. Document timestamp and execution semantics where relevant.
|
|
18
|
+
3. Add deterministic tests, including at least one boundary case.
|
|
19
|
+
4. Return pandas objects for calculations and figure objects for plots.
|
|
20
|
+
5. Avoid implicit forward filling or silent data coercion.
|
|
21
|
+
6. Update the API catalog and changelog.
|
|
22
|
+
7. Do not claim profitability from package examples.
|
|
23
|
+
|
|
24
|
+
## Scientific changes
|
|
25
|
+
|
|
26
|
+
Changes to metrics, costs, timing, optimization, or statistical tests must include:
|
|
27
|
+
|
|
28
|
+
- mathematical definition;
|
|
29
|
+
- source or derivation;
|
|
30
|
+
- units and annualization convention;
|
|
31
|
+
- numerical test against a known result;
|
|
32
|
+
- limitations and failure modes.
|
asrquant-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Alpha Stochastic Research and Alpha Kabinet TOURE
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
include README.md LICENSE CITATION.cff CHANGELOG.md CONTRIBUTING.md CODE_OF_CONDUCT.md SECURITY.md RELEASE_NOTES.md RELEASE_CHECKLIST.md PRODUCTION_READINESS_CHECKLIST.md THREAT_MODEL.md PYPI_DEPLOYMENT_GUIDE_FR.md PAPER_PACKAGE_CONTRACT_v1.0.0.md VALIDATION_v1.0.0.txt
|
|
2
|
+
recursive-include docs *.md
|
|
3
|
+
recursive-include deployment *.json
|
|
4
|
+
recursive-include examples *.py *.csv
|
|
5
|
+
recursive-include benchmarks *.py *.csv
|
|
6
|
+
recursive-include paper *.tex *.pdf *.png
|
|
7
|
+
recursive-include scripts *.py *.sh
|
|
8
|
+
recursive-include tests *.py *.pdf
|
|
9
|
+
recursive-include requirements *.txt
|
|
10
|
+
prune **/__pycache__
|
|
11
|
+
global-exclude *.py[cod]
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# ASRQuant 1.0.0 — Paper/Package Contract
|
|
2
|
+
|
|
3
|
+
This document is the release bridge between **manuscript v0.1.0** and **ASRQuant 1.0.0**.
|
|
4
|
+
|
|
5
|
+
The rule for the stable release is simple: a capability described as implemented in the manuscript must be represented by an actual public API and an automated test. Future or specialist capabilities must be identified as limitations or roadmap items instead of being implied as implemented.
|
|
6
|
+
|
|
7
|
+
| Manuscript capability | Stable implementation | Executable evidence |
|
|
8
|
+
|---|---|---|
|
|
9
|
+
| One-import public API | `import asrquant as asr`; `open_lab`, `fit`, `simulate`, `price_option`, `visualize`, `show`, `save` | `test_one_import_polynomial_modelling_and_visualization`, `test_paper_one_import_formula_to_polynomial_model` |
|
|
10
|
+
| PDF literature ingestion and source-linked hypotheses | `asr.research.from_pdfs`, `LiteratureCorpus`, `HypothesisRegistry`, `ResearchProject` | `test_appendix_pdf_to_hypothesis_registry_real_text_pdf` |
|
|
11
|
+
| Hypothesis → data → features → signal → portfolio → test → robustness → governed decision | `ResearchProject` workflow | `test_appendix_research_project_to_governed_paper_trade` |
|
|
12
|
+
| CSV and in-memory quantitative laboratory | `QuantLab.from_csv`, `QuantLab`, `open_lab` | `test_appendix_csv_to_audited_backtest`, `test_appendix_in_memory_custom_strategy` |
|
|
13
|
+
| Provider-neutral market-data contract | provider adapters + `QuantLab.from_provider` | `test_appendix_provider_contract_without_network` |
|
|
14
|
+
| Seven core stochastic-process families | ABM, GBM, OU, CIR, Vasicek, Heston, Merton | `test_paper_seven_core_stochastic_process_families` |
|
|
15
|
+
| Monte Carlo uncertainty and martingale diagnostics | `monte_carlo.py`, simulation result objects, `martingale_diagnostics` | `test_appendix_monte_carlo_martingale_and_option_pricing` + quant suite |
|
|
16
|
+
| Derivative pricing | BSM, Bachelier, Black-76, CRR, implied vol, European/Asian MC | `test_paper_derivative_pricing_contract` |
|
|
17
|
+
| Econometrics and polynomial modelling | `asr.fit`, `asr.stats`, robust OLS, polynomial/quantile/logistic methods | paper formula test + statistics suite |
|
|
18
|
+
| Leakage-aware ML and chronological validation | `machine_learning.py`, walk-forward, purged/gap-aware split tests | quant/core test groups |
|
|
19
|
+
| Portfolio/risk/volatility | `optimization.py`, `metrics.py`, `volatility.py` | quant/core test groups |
|
|
20
|
+
| Fixed income | bond price, YTM, duration, convexity, validated zero-curve bootstrap | `test_paper_fixed_income_contract` |
|
|
21
|
+
| Implementation-risk audit | `QuantLab.audit`, `implementation_audit` | `test_appendix_implementation_audit_and_regression` |
|
|
22
|
+
| N-dimensional parameter surfaces and exports | `surfaces.py` | `test_paper_surface_contract_html_and_gif_export` + surface group |
|
|
23
|
+
| 100+ visualization functions | 102 module-level public functions + result plot methods | `test_visualization_catalog_remains_above_one_hundred_public_functions` |
|
|
24
|
+
| Paper broker, order states, partial fills and risk controls | `PaperBroker`, `PaperTrader`, `RiskPolicy`, market/limit/stop/stop-limit orders | `test_paper_broker_order_types_partial_fill_and_cancellation`, governed paper-trade test |
|
|
25
|
+
| Durable audit and fail-closed deployment controls | `SQLiteAuditStore`, `ProductionReadinessGate`, `DeploymentCertificate`, live safety primitives | production group (62 tests) |
|
|
26
|
+
|
|
27
|
+
## Stable release validation
|
|
28
|
+
|
|
29
|
+
ASRQuant 1.0.0 collects **154 automated tests**, including **18 paper-contract tests**. The paper-contract suite is part of the CI domain matrix and must pass before a stable source commit is treated as matching manuscript v0.1.0.
|
|
30
|
+
|
|
31
|
+
## Deliberate boundaries
|
|
32
|
+
|
|
33
|
+
The stable release does not claim exchange queue realism, complete point-in-time corporate-action reconstruction, universal broker behavior, guaranteed profitability, causal identification from predictive regressions, or automatic authorization for live capital. These boundaries remain explicit in the manuscript and software documentation.
|