Skip to content

Commit 7285a13

Browse files
author
Oussama
committed
docs: add final process book pdf and README checklist
1 parent e3303d7 commit 7285a13

2 files changed

Lines changed: 51 additions & 25 deletions

File tree

README.md

Lines changed: 51 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,19 @@ Live site: https://com-480-data-visualization.github.io/DArts/
1010

1111
MoMA is often experienced through a small set of famous paintings and sculptures. The recorded collection tells a different story: paper works dominate the archive, a small group of countries accounts for most credited works, gender parity arrives late and unevenly, and representation varies strongly by medium. DArts turns those patterns into a martini-glass narrative: authored scenes first, an open medium explorer next, and a personal underrepresented-artist match at the end.
1212

13+
## Intended Usage
14+
15+
Open the live site and scroll from top to bottom. Scenes 1-3 introduce the core findings, Scene 4 lets users filter by decade, department, region, and selected country, and Scene 5 returns a deterministic underrepresented-artist match. The global decade slider filters the globe, gender chart, and medium explorer; clicking a country on the globe links that selection into later scenes.
16+
17+
## Deliverables
18+
19+
- Website source: [`website/`](website/)
20+
- Process book PDF: [`process_book.pdf`](process_book.pdf)
21+
- Process book LaTeX source: [`process_book/main.tex`](process_book/main.tex)
22+
- EDA notebook: [`notebooks/exploratory_analysis.ipynb`](notebooks/exploratory_analysis.ipynb)
23+
- Data aggregation script: [`data/build_aggregates.py`](data/build_aggregates.py)
24+
- Deployment workflow: [`.github/workflows/deploy.yml`](.github/workflows/deploy.yml)
25+
1326
## Team
1427

1528
| Student | SCIPER |
@@ -26,15 +39,24 @@ MoMA is often experienced through a small set of famous paintings and sculptures
2639
- Python + pandas for build-time data aggregation
2740
- GitHub Pages deployment through GitHub Actions
2841

29-
## Local Development
42+
## Technical Setup
43+
44+
Clone with submodules so the raw MoMA data is available:
45+
46+
```bash
47+
git clone --recurse-submodules https://github.com/com-480-data-visualization/DArts.git
48+
cd DArts
49+
```
50+
51+
Install and run the website locally:
3052

3153
```bash
3254
cd website
3355
npm install
3456
npm run dev
3557
```
3658

37-
Production build:
59+
Run production checks:
3860

3961
```bash
4062
cd website
@@ -43,7 +65,7 @@ npm run build
4365
npm run preview
4466
```
4567

46-
Regenerate data aggregates:
68+
Regenerate data aggregates from the repository root:
4769

4870
```bash
4971
python data/build_aggregates.py
@@ -55,7 +77,7 @@ The Vite base path is `/DArts/`, matching the GitHub Pages deployment URL.
5577

5678
Source: [Museum of Modern Art Collection](https://github.com/MuseumofModernArt/collection), public dataset.
5779

58-
The raw MoMA files are tracked as the `data/moma-collection` submodule. `data/build_aggregates.py` reads the raw CSVs and writes compact JSON files to `website/public/data/`.
80+
The raw MoMA files are provided through the `data/moma-collection` Git submodule. Some upstream raw files are larger than 50 MB, so they remain in the submodule rather than being duplicated into the website bundle. The deployed site uses compact JSON aggregates in `website/public/data/`.
5981

6082
Current reconciliation from `data/build_report.txt`:
6183

@@ -72,26 +94,30 @@ The website never fetches raw CSVs at runtime. It uses pre-aggregated JSON, and
7294

7395
```text
7496
.
75-
├─ data/
76-
│ ├─ build_aggregates.py
77-
│ ├─ build_report.txt
78-
│ ├─ nationality_to_iso3.json
79-
│ ├─ regions.json
80-
│ └─ moma-collection/
81-
├─ notebooks/
82-
│ └─ exploratory_analysis.ipynb
83-
├─ website/
84-
│ ├─ public/data/
85-
│ ├─ public/topology/world-110m.json
86-
│ ├─ src/App.svelte
87-
│ └─ src/lib/
88-
│ ├─ charts/
89-
│ ├─ components/
90-
│ ├─ design/
91-
│ ├─ scenes/
92-
│ ├─ stores/
93-
│ └─ utils/
94-
└─ .github/workflows/deploy.yml
97+
|-- data/
98+
| |-- build_aggregates.py
99+
| |-- build_report.txt
100+
| |-- nationality_to_iso3.json
101+
| |-- regions.json
102+
| `-- moma-collection/
103+
|-- notebooks/
104+
| `-- exploratory_analysis.ipynb
105+
|-- process_book/
106+
| |-- main.tex
107+
| `-- figures/
108+
|-- process_book.pdf
109+
|-- website/
110+
| |-- public/data/
111+
| |-- public/topology/world-110m.json
112+
| |-- src/App.svelte
113+
| `-- src/lib/
114+
| |-- charts/
115+
| |-- components/
116+
| |-- design/
117+
| |-- scenes/
118+
| |-- stores/
119+
| `-- utils/
120+
`-- .github/workflows/deploy.yml
95121
```
96122

97123
## Narrative Scenes
@@ -112,4 +138,4 @@ The workflow installs dependencies with Node 20, runs lint, builds `website/dist
112138

113139
## Notes
114140

115-
This project analyzes the recorded MoMA collection metadata. Demographic fields are limited to what MoMA records; absence in the data is not a judgment of curatorial intent or of an artist's significance.
141+
This project analyzes the recorded MoMA collection metadata. Demographic fields are limited to what MoMA records; absence in the data is not a judgment of curatorial intent or of an artist's significance. Artwork images are not embedded; the site links out to MoMA records where available.

process_book.pdf

2.51 MB
Binary file not shown.

0 commit comments

Comments
 (0)