Skip to content

Commit 8129330

Browse files
committed
docs: Improve README for Data Acorns landing page
Refactors the README to clearly explain the purpose of Data Acorns, its relation to the `shellgame` and `geoDeltaAudit` R packages, and outlines the methodology and development stack. The previous content focused on app deployment, which was not the primary function of this repository.
1 parent d54c3a6 commit 8129330

1 file changed

Lines changed: 28 additions & 13 deletions

File tree

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,35 @@
1-
<div align="center">
2-
<img width="1200" height="475" alt="GHBanner" src="https://github.com/user-attachments/assets/0aa67016-6eaf-458a-adb2-6e31a0763ed6" />
3-
</div>
1+
# Data Acorns | The Shell Game
42

5-
# Run and deploy your AI Studio app
3+
A landing page for the **shellgame** and **geoDeltaAudit** R packages, providing documentation and quantification of perturbation in geographic population data workflows.
64

7-
This contains everything you need to run your app locally.
5+
## Overview
86

9-
View your app in AI Studio: https://ai.studio/apps/df2d31a9-7c1b-432e-b2bb-1ae090a692f3
7+
Data Acorns is dedicated to documenting and quantifying the uncertainties and perturbations introduced during population data processing, specifically focusing on geographic crosswalks and allocation methods.
108

11-
## Run Locally
9+
## Ecosystem
1210

13-
**Prerequisites:** Node.js
11+
### shellgame
12+
An R package designed to audit geographic crosswalks and evaluate the fidelity of population data as it moves between different spatial resolutions.
1413

14+
### geoDeltaAudit
15+
A diagnostic tool for quantifying spatial and demographic perturbation in population data, helping researchers understand the "delta" between source and target geographies.
1516

16-
1. Install dependencies:
17-
`npm install`
18-
2. Set the `GEMINI_API_KEY` in [.env.local](.env.local) to your Gemini API key
19-
3. Run the app:
20-
`npm run dev`
17+
## Methodology
18+
19+
The "Shell Game" refers to the complex movement and reallocation of population data points across administrative boundaries. Our protocol provides:
20+
- **Relational Sync:** Ensuring data invariants are maintained during spatial transitions.
21+
- **Integrity Audits:** Quantifying the loss or shifting of demographic signals.
22+
- **Transparency:** Clear documentation of how allocation decisions impact end-state data quality.
23+
24+
## Development
25+
26+
This site is built with React and Tailwind CSS.
27+
28+
### Getting Started
29+
30+
1. Clone the repository
31+
2. Install dependencies: `npm install`
32+
3. Start the development server: `npm run dev`
33+
34+
---
35+
*Built by [Data Acorns](https://dataacorns.com)*

0 commit comments

Comments
 (0)