Skip to content

Commit 4f7148c

Browse files
committed
docs: add dataset and logo to README
1 parent 1617129 commit 4f7148c

2 files changed

Lines changed: 40 additions & 21 deletions

File tree

README.md

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# Olympic Inequalities
22

3+
<p align="center">
4+
<img src="website/img/logo_footer.png" alt="Logo" width="600"></img>
5+
</p>
6+
7+
Project created in the context of EPFL COM-480 Data visualisation course in 2026.
38

49
Have a look at our [website](https://com-480-data-visualization.github.io/DataRizz/).
510

11+
612
## Motivation
713

814
The Olympic Games are often seen as a symbol of fairness: athletes from all around the world competing on equal ground. But are the Olympics really as equal as they appear?
@@ -28,6 +34,27 @@ We explore the following themes:
2834
Comparing medal counts while accounting for GDP and population differences.
2935

3036

37+
## Target Audiance
38+
This website is accessible for everybody interested in how inequalities are reflected through the Olympics.
39+
Try out our visualisations and have fun on the website !
40+
41+
42+
## Screen cast
43+
44+
Have a look at ou [screencast](https://youtu.be/ow9zDZU0r-M) to have an idea of what you can expect from our website.
45+
46+
47+
## Dataset
48+
We combined many datasets from Kaggle:
49+
- [athlete_events.csv](https://www.kaggle.com/datasets/heesoo37/120-years-of-olympic-history-athletes-and-results?select=athlete_events.csv)
50+
- [noc_regions.csv](https://www.kaggle.com/datasets/heesoo37/120-years-of-olympic-history-athletes-and-results?select=noc_regions.csv)
51+
- [gdp_per_capita.csv](https://data.worldbank.org/indicator/NY.GDP.PCAP.CD)
52+
- [pop_count.csv](https://www.kaggle.com/datasets/aliaamiri/historical-worldwide-countries-population)
53+
- [conflicts.csv](https://www.kaggle.com/datasets/nikolaosroufas/history-of-large-conflicts-between-1800-2024)
54+
55+
We first [merged](milestones/milestone1/merge_datasets.ipynb) them into a single [olympic.csv](milestones/milestone3/olympics.csv) file. We then [created individual](milestones/milestone3/extract_viz_data.ipynb) extracted datasets per visualisation topic (see `website/data` folder) to make our website run smoother.
56+
57+
3158
## Project Structure
3259

3360
```text
@@ -40,10 +67,17 @@ We explore the following themes:
4067
└── models/ # 3D athlete models
4168
```
4269

43-
## Screen cast
44-
45-
Have a look at ou [screencast](https://youtu.be/ow9zDZU0r-M).
70+
## Running the Project Locally
4671

72+
To clone the repository:
73+
```bash
74+
git clone https://github.com/com-480-data-visualization/DataRizz.git
75+
```
76+
To run the website locally:
77+
```bash
78+
cd DataRizz/website
79+
python -m http.server 8080
80+
```
4781

4882
## Authors
4983

@@ -56,21 +90,6 @@ Have a look at ou [screencast](https://youtu.be/ow9zDZU0r-M).
5690

5791
## Milestones
5892

59-
The Milestone 1 report can be found [here](milestones/milestone1/Milestone1.md).
60-
61-
The Milestone 2 report can be found [here](milestones/milestone2/Report_M2.pdf).
62-
63-
The final process book can be found [here](milestones/milestone3/ProcessBook.pdf).
64-
65-
66-
## Running the Project Locally
67-
68-
To clone the repository:
69-
```bash
70-
git clone https://github.com/com-480-data-visualization/DataRizz.git
71-
```
72-
To run the website locally:
73-
```bash
74-
cd DataRizz/website
75-
python -m http.server 8080
76-
```
93+
- [Milestone 1 report](milestones/milestone1/Milestone1.md).
94+
- [Milestone 2 report](milestones/milestone2/Report_M2.pdf).
95+
- [Final process book](milestones/milestone3/ProcessBook.pdf).

website/img/logo_footer.png

250 KB
Loading

0 commit comments

Comments
 (0)