diff --git a/README.md b/README.md index f474d71..6c5e5f6 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,52 @@ # PyStatsV1 — Applied Statistics (R ↔ Python) -Plain Python scripts that mirror R recipes so non-specialists can run analyses from the command line, -save figures/tables, and compare results across R/Python. +[![ci](https://img.shields.io/github/actions/workflow/status/nicholaskarlson/PyStatsV1/ci.yml?branch=main)](https://github.com/nicholaskarlson/PyStatsV1/actions/workflows/ci.yml) +[![release](https://img.shields.io/github/v/tag/nicholaskarlson/PyStatsV1?label=release)](https://github.com/nicholaskarlson/PyStatsV1/tags) -## Quick start +Plain Python scripts that mirror R recipes so non-specialists can run analyses from the command line, save figures/tables, and compare results across R/Python. + +--- -# macOS/Linux +## Quick start +### macOS / Linux +```bash python -m venv .venv && source .venv/bin/activate python -m pip install -U pip pip install -r requirements.txt +``` -# Windows (Git Bash or PowerShell) - -python -m venv .venv; source .venv/Scripts/activate 2>/dev/null || .venv\\Scripts\\Activate.ps1 +### Windows (Git Bash or PowerShell) +```bash +# Try Git Bash first; if that fails, PowerShell will activate the venv +python -m venv .venv; source .venv/Scripts/activate 2>/dev/null || .venv\Scripts\Activate.ps1 python -m pip install -U pip pip install -r requirements.txt +``` -# Example - -## License - -MIT © 2025 Nicholas Elliott Karlson +--- +## Example +Run the Chapter 1 example: +```bash python scripts/ch01_introduction.py +``` +### Chapter 13 quick smoke (fast) +```bash +make ch13-ci +``` +This generates tiny synthetic datasets and saves a couple of plots to `outputs/`. -![CI](https://github.com/nicholaskarlson/PyStatsV1/actions/workflows/ci.yml/badge.svg) +Full chapter run: +```bash +make ch13 +``` -![Tag](https://img.shields.io/github/v/tag/nicholaskarlson/PyStatsV1?label=release) +See **[docs/README.md](docs/README.md)** for chapter notes, commands, and links. +--- + +## License +MIT © 2025 Nicholas Elliott Karlson \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 8655124..6d4e31c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,5 @@ # PyStatsV1 Docs -![CI](https://github.com/nicholaskarlson/PyStatsV1/actions/workflows/ci.yml/badge.svg) -![Tag](https://img.shields.io/github/v/tag/nicholaskarlson/PyStatsV1?label=release) - - Chapter 12 — Diagnostics - `scripts/ch12_diagnostics.py` @@ -11,4 +8,57 @@ - Run: `scripts/sim_stroop.py`, `scripts/ch13_stroop_within.py --save-plots` - Chapter 13 — Fitness 2×2 Mixed (this chapter) - Data: `data/synthetic/fitness_*` - - Run: `scripts/sim_fitness_2x2.py`, `scripts/ch13_fitness_mixed.py --save-plots` \ No newline at end of file + - Run: `scripts/sim_fitness_2x2.py`, `scripts/ch13_fitness_mixed.py --save-plots` + + + +[![ci](https://img.shields.io/github/actions/workflow/status/nicholaskarlson/PyStatsV1/ci.yml?branch=main)](https://github.com/nicholaskarlson/PyStatsV1/actions/workflows/ci.yml) +[![release](https://img.shields.io/github/v/tag/nicholaskarlson/PyStatsV1?label=release)](https://github.com/nicholaskarlson/PyStatsV1/tags) + +Plain Python scripts that mirror R recipes so non-specialists can run analyses from the command line, save figures/tables, and compare results across R/Python. + +--- + +## Quick start + +### macOS / Linux +```bash +python -m venv .venv && source .venv/bin/activate +python -m pip install -U pip +pip install -r requirements.txt +``` + +### Windows (Git Bash or PowerShell) +```bash +# Try Git Bash first; if that fails, PowerShell will activate the venv +python -m venv .venv; source .venv/Scripts/activate 2>/dev/null || .venv\Scripts\Activate.ps1 +python -m pip install -U pip +pip install -r requirements.txt +``` + +--- + +## Example +Run the Chapter 1 example: +```bash +python scripts/ch01_introduction.py +``` + +### Chapter 13 quick smoke (fast) +```bash +make ch13-ci +``` +This generates tiny synthetic datasets and saves a couple of plots to `outputs/`. + +Full chapter run: +```bash +make ch13 +``` + +See **[docs/README.md](docs/README.md)** for chapter notes, commands, and links. + +--- + +## License + +MIT © 2025 Nicholas Elliott Karlson \ No newline at end of file