Skip to content

docs: readme updated to newer version, contains legacy folder #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 4, 2025
Merged

docs: readme updated to newer version, contains legacy folder #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...search_starter/dashboard/streamlit_app.py → legacy/streamlit/streamlit_app.py
View file
Open in desktop
File renamed without changes.
39 changes: 32 additions & 7 deletions src/quant_research_starter.egg-info/PKG-INFO
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,29 @@ pip install -e ".[dev]"
pip install streamlit plotly
```

### Quick CLI Usage

After installation, you can use the CLI in two ways:

**Option 1: Direct command (if PATH is configured)**
```bash
qrs --help
# generate synthetic sample price series
qrs generate-data -o data_sample/sample_prices.csv -s 5 -d 365
# compute example factors
qrs compute-factors -d data_sample/sample_prices.csv -f momentum -f value -o output/factors.csv
# run a backtest
qrs backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
```

**Option 2: Python module (always works)**
```bash
python -m quant_research_starter.cli --help
python -m quant_research_starter.cli generate-data -o data_sample/sample_prices.csv -s 5 -d 365
python -m quant_research_starter.cli compute-factors -d data_sample/sample_prices.csv -f momentum -f value
python -m quant_research_starter.cli backtest -d data_sample/sample_prices.csv -s output/factors.csv -o output/backtest_results.json
```

### Demo (one-line)

```bash
Expand All @@ -106,13 +129,13 @@ make demo

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

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

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

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

## CLI reference

Run `qrs --help` or `qrs <command> --help` for full usage. Main commands include:
Run `python -m quant_research_starter.cli --help` or `python -m quant_research_starter.cli <command> --help` for full usage. Main commands include:

* `python -m quant_research_starter.cli generate-data` — create synthetic price series or download data from adapters
* `python -m quant_research_starter.cli compute-factors` — calculate and export factor scores
* `python -m quant_research_starter.cli backtest` — run the vectorized backtest and export results

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

---

Expand Down
6 changes: 5 additions & 1 deletion src/quant_research_starter.egg-info/SOURCES.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ src/quant_research_starter/data/downloaders.py
src/quant_research_starter/data/init.py
src/quant_research_starter/data/sample_loader.py
src/quant_research_starter/data/synthetic.py
src/quant_research_starter/data/validator.py
src/quant_research_starter/examples/benchmark/benchmark_factors.py
src/quant_research_starter/factors/__init__.py
src/quant_research_starter/factors/base.py
Expand All @@ -28,9 +29,12 @@ src/quant_research_starter/factors/size.py
src/quant_research_starter/factors/value.py
src/quant_research_starter/factors/volatility.py
src/quant_research_starter/metrics/__init__.py
src/quant_research_starter/metrics/plotting.py
src/quant_research_starter/metrics/risk.py
src/quant_research_starter/universe/selection.py
tests/test_backtest.py
tests/test_data.py
tests/test_factors.py
tests/test_metrics.py
tests/test_metrics.py
tests/test_plotting.py
tests/test_validator.py
Loading