Skip to content

Commit 959a05c

Browse files
fix: plzz no merge conflict
2 parents 16170e5 + 7dde401 commit 959a05c

File tree

4 files changed

+40
-9
lines changed

4 files changed

+40
-9
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,11 @@ python -m quant_research_starter.cli compute-factors -d data_sample/sample_price
9494
# run a backtest
9595
python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
9696

97-
# optional: start the Streamlit dashboard
97+
# DISCLAIMER: OLD VERSION
98+
# optional: start the Streamlit dashboard, if on main stream
9899
streamlit run src/quant_research_starter/dashboard/streamlit_app.py
100+
# NEW VERSION: if streamlit is in legacy folder
101+
streamlit run legacy/streamlit/streamlit_app.py
99102
```
100103

101104
---

src/quant_research_starter.egg-info/PKG-INFO

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,29 @@ pip install -e ".[dev]"
9696
pip install streamlit plotly
9797
```
9898

99+
### Quick CLI Usage
100+
101+
After installation, you can use the CLI in two ways:
102+
103+
**Option 1: Direct command (if PATH is configured)**
104+
```bash
105+
qrs --help
106+
# generate synthetic sample price series
107+
qrs generate-data -o data_sample/sample_prices.csv -s 5 -d 365
108+
# compute example factors
109+
qrs compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
110+
# run a backtest
111+
qrs backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
112+
```
113+
114+
**Option 2: Python module (always works)**
115+
```bash
116+
python -m quant_research_starter.cli --help
117+
python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365
118+
python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value
119+
python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
120+
```
121+
99122
### Demo (one-line)
100123

101124
```bash
@@ -106,13 +129,13 @@ make demo
106129

107130
```bash
108131
# generate synthetic sample price series
109-
qrs generate-data -o data_sample/sample_prices.csv -s 5 -d 365
132+
python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365
110133

111134
# compute example factors
112-
qrs compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
135+
python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
113136

114137
# run a backtest
115-
qrs backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
138+
python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
116139

117140
# optional: start the Streamlit dashboard
118141
streamlit run src/quant_research_starter/dashboard/streamlit_app.py
@@ -166,11 +189,13 @@ Supported frequencies:
166189

167190
## CLI reference
168191

169-
Run `qrs --help` or `qrs <command> --help` for full usage. Main commands include:
192+
Run `python -m quant_research_starter.cli --help` or `python -m quant_research_starter.cli <command> --help` for full usage. Main commands include:
193+
194+
* `python -m quant_research_starter.cli generate-data` — create synthetic price series or download data from adapters
195+
* `python -m quant_research_starter.cli compute-factors` — calculate and export factor scores
196+
* `python -m quant_research_starter.cli backtest` — run the vectorized backtest and export results
170197

171-
* `qrs generate-data` — create synthetic price series or download data from adapters
172-
* `qrs compute-factors` — calculate and export factor scores
173-
* `qrs backtest` — run the vectorized backtest and export results
198+
**Note:** If you have the `qrs` command in your PATH, you can use `qrs` instead of `python -m quant_research_starter.cli`.
174199

175200
---
176201

src/quant_research_starter.egg-info/SOURCES.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ src/quant_research_starter/data/downloaders.py
1717
src/quant_research_starter/data/init.py
1818
src/quant_research_starter/data/sample_loader.py
1919
src/quant_research_starter/data/synthetic.py
20+
src/quant_research_starter/data/validator.py
2021
src/quant_research_starter/examples/benchmark/benchmark_factors.py
2122
src/quant_research_starter/factors/__init__.py
2223
src/quant_research_starter/factors/base.py
@@ -34,4 +35,6 @@ tests/test_backtest.py
3435
tests/test_data.py
3536
tests/test_factors.py
3637
tests/test_metrics.py
37-
tests/test_plotting.py
38+
tests/test_plotting.py
39+
tests/test_plotting.py
40+
tests/test_validator.py

0 commit comments

Comments
 (0)