Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,23 @@ Quant-Research-Lab/
```bash
cd Quant-Research-Lab
python -m venv .venv
.venv\Scripts\activate
```

Activate the environment with the command for your operating system:

```bash
# macOS / Linux
source .venv/bin/activate

# Windows PowerShell
.venv\Scripts\Activate.ps1
```

The package requires Python 3.11 or newer, and the CI workflow verifies Python 3.11 and 3.12.

Install the runtime dependencies:

```bash
pip install -r requirements.txt
```

Expand All @@ -67,7 +83,11 @@ mypy src --ignore-missing-imports
Copy `.env.example` to `.env` if you have optional API keys:

```bash
copy .env.example .env
# macOS / Linux
cp .env.example .env

# Windows PowerShell
Copy-Item .env.example .env
```

FRED can be accessed through a public CSV endpoint without a key, but `FRED_API_KEY` is supported. Yahoo Finance access is handled through `yfinance`. If a provider fails or no key is present, the scripts use deterministic sample data and log the fallback.
Expand Down
18 changes: 16 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
git clone https://github.com/Fink692/Quant-Research-Lab.git
cd Quant-Research-Lab
python -m venv .venv
.venv\Scripts\activate
python -m pip install -r requirements-dev.txt
python -m pip install -e .
```
Expand All @@ -17,6 +16,14 @@ On macOS or Linux:
source .venv/bin/activate
```

On Windows PowerShell:

```powershell
.venv\Scripts\Activate.ps1
```

The package requires Python 3.11 or newer. Continuous integration verifies Python 3.11 and 3.12.

## Run The Research Workflows

The script interface:
Expand Down Expand Up @@ -53,7 +60,14 @@ mypy src --ignore-missing-imports
Copy `.env.example` to `.env` if you have optional credentials.

```bash
copy .env.example .env
# macOS / Linux
cp .env.example .env
```

On Windows PowerShell:

```powershell
Copy-Item .env.example .env
```

The project runs without keys by using public endpoints or deterministic fallback data where needed.
Loading