Skip to content

Commit 37aae3e

Browse files
committed
doc: Update README.dm
1 parent eec7918 commit 37aae3e

2 files changed

Lines changed: 32 additions & 8 deletions

File tree

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,27 @@
11
# Flight Inspectors
22
Flight Inspectors is a data visualization project that explores the history of plane crashes from 1908 to 2024. The project aims to provide insights into the causes and trends of plane crashes over time, as well as to raise awareness about aviation safety.
33

4+
## Milestone 1
5+
6+
[Milestone 1](milestones/milestone1)
7+
8+
## Milestone 2
9+
10+
[Milestone 2](milestones/milestone2)
11+
12+
## Milestone 3
13+
14+
[Milestone 3](milestones/milestone3)
15+
416
## Prerequisites
517
- [Node.js / NPM](https://nodejs.org/en/download)
618
- [Git](https://git-scm.com/install/)
719

820
## Run
921
```
22+
pip install -r requirements
23+
```
24+
```
1025
npm install
1126
```
1227
```
@@ -48,14 +63,26 @@ python3 data/viz3/script.py
4863
python3 data/viz4/script.py
4964
```
5065

51-
Run all from the project root. The four viz scripts must be run before `npm run dev` if the JSON files are missing.
66+
**Viz 5 — directed chord graph of accidents between locations** (writes `public/data/crashed_routes.json`):
67+
```bash
68+
python3 data/viz5/script.py
69+
```
70+
71+
**Viz 6 — custom predictive model of airplane crashes** (writes `public/data/crashed_routes.json`):
72+
```bash
73+
python3 data/viz6/script.py
74+
```
75+
76+
<sub><sup>Note: Viz 4 and 5 are swapped on the website for more fluent logical continuation, but was kept numbered as such to maintain consistency across our working pipeline.</sup></sub>
77+
78+
Run all from the project root. The six viz scripts must be run before `npm run dev` if the JSON files are missing. `pip install -r requirements` required for viz5 and viz6.
5279

5380
## Contributors
54-
| Student's name | SCIPER | Contribution |
81+
| Student's name | SCIPER | Department |
5582
| -------------- | ------ | ------------ |
56-
| Nicolas Karmolinski | 316655 | TODO |
57-
| Roméo Maignal | 360568 | Worked on the first skeleton of the website and then embellished it with additional decorations, animations and responsive design features. In charge of the two first data visualizations, extracting the corresponding data and implementing the interactive features with D3.js. |
58-
| Jakub Kielar | 423372 | In charge of the third and fourth data visualizations, which add a geographic perspective to the dataset. Built a heatmap and treemap pair showing where crashes concentrate around the world, and an interactive 3D globe of crashed flight routes with a year-range slider for exploring different periods. |
83+
| Nicolas Karmolinski | 316655 | Data Science |
84+
| Roméo Maignal | 360568 | Computer Science |
85+
| Jakub Kielar | 423372 | Computer Science |
5986

6087
## Stack
6188
- Scripting language: [TypeScript](https://www.typescriptlang.org/)

src/components/Viz5.tsx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,6 @@ const Viz5: React.FC = () => {
105105
const base = PALETTE.indexOf(CONTINENT_COLORS[cont] ?? '#6b7280')
106106
const idx = contIdx.get(cont) ?? 0; contIdx.set(cont, idx+1)
107107
colorMap.set(n.id, PALETTE[(base + idx) % PALETTE.length])
108-
// then:
109-
// const base = (CONTINENT_IDX[cont] ?? 6) * 3
110-
// colorMap.set(n.id, PALETTE[(base + idx) % PALETTE.length])
111108
})
112109
}
113110
return { nodes: sorted, flows: filtered, colorMap }

0 commit comments

Comments
 (0)