File tree Expand file tree Collapse file tree 1 file changed +8
-5
lines changed Expand file tree Collapse file tree 1 file changed +8
-5
lines changed Original file line number Diff line number Diff line change @@ -60,16 +60,19 @@ After installation, you can use the CLI in two ways:
6060** Option 1: Direct command (if PATH is configured)**
6161``` bash
6262qrs --help
63- python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365
64- python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
65- qrs backtest -d data/sample.csv -s output/factors.csv
63+ # generate synthetic sample price series
64+ qrs generate-data -o data_sample/sample_prices.csv -s 5 -d 365
65+ # compute example factors
66+ qrs compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
67+ # run a backtest
68+ qrs backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
6669```
6770
6871** Option 2: Python module (always works)**
6972``` bash
7073python -m quant_research_starter.cli --help
71- python -m quant_research_starter.cli generate-data -o data/sample .csv -s 5 -d 365
72- python -m quant_research_starter.cli compute-factors -d data/sample .csv -f momentum -f value
74+ python -m quant_research_starter.cli generate-data -o data_sample/sample_prices .csv -s 5 -d 365
75+ python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices .csv -f momentum -f value
7376python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
7477```
7578
You can’t perform that action at this time.
0 commit comments