Skip to content

Commit bb57276

Browse files
author
Roméo Maignal
committed
docs(README): added instructions to run the python scripts
1 parent 10f958b commit bb57276

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,24 @@ You can also visit the deployed version of the website hosted on GitHub Pages at
1818
The primary dataset we will be working with is a dataset of plane crashes from 1908 to 2024 found on [Kaggle by Luiscé Francisco](https://www.kaggle.com/datasets/luiscfrancisco/plane-crashes-dataset/data). As a complement, we will be using the airports, routes, and airlines datasets from [OpenFlights](https://openflights.org/data), a free, high-quality and comprehensive aviation database.
1919

2020
### Run the data analysis
21-
TODO
21+
The scripts only use Python's standard library — no extra packages are required. They all read from `data/crashes_cleaned.csv`.
22+
23+
**Hero section stats** (prints summary figures to stdout):
24+
```bash
25+
python3 data/hero_stats.py
26+
```
27+
28+
**Viz 1 — incidents & fatalities by manufacturer** (writes `public/data/crashes_by_manufacturer.json`):
29+
```bash
30+
python3 data/viz1/script.py
31+
```
32+
33+
**Viz 2 — incidents & fatalities by airline** (writes `public/data/crashes_by_airline.json`):
34+
```bash
35+
python3 data/viz2/script.py
36+
```
37+
38+
Run all three from the project root. The two viz scripts must be run before `npm run dev` if the JSON files are missing.
2239

2340
## Contributors
2441
| Student's name | SCIPER | Contribution |

0 commit comments

Comments
 (0)