Skip to content

Commit ef77ae2

Browse files
committed
Update README.md
1 parent 4721920 commit ef77ae2

1 file changed

Lines changed: 46 additions & 33 deletions

File tree

README.md

Lines changed: 46 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,78 @@
11
![EquityStack Banner](banner/EquityStack-banner.png)
22

3-
# EquityStack 📊
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue?label=license)](LICENSE)
4+
[![Build Status](https://github.com/Varnasr/EquityStack/actions/workflows/ci.yml/badge.svg)](https://github.com/Varnasr/EquityStack/actions)
5+
[![Zenodo DOI](https://zenodo.org/badge/DOI/<DOI>.svg)](https://doi.org/<DOI>)
6+
[![Maintained](https://img.shields.io/badge/maintained-yes-brightgreen?label=2025)]()
47

5-
**EquityStack** is a Python-based, modular, and field-aware toolkit of reusable notebooks, functions, and pipelines for applied data work — especially in public health, gender, climate, education, and evaluation sectors.
8+
# Welcome to EquityStack 📊
69

7-
It helps analysts, MEL professionals, and researchers turn raw data into clean, interpretable outputs — fast.
10+
Hey there! I’m Varna Sri Raman, and I’m thrilled you’re exploring **EquityStack**. 🎉 This toolkit is my passion project—a modular, field-aware collection of Python scripts, notebooks, and pipelines built to make data work smooth and insightful, especially in public health, gender, climate, education, and evaluation.
811

912
---
1013

1114
## 🗺️ Folder Map
1215

1316
```
1417
EquityStack/
15-
├── notebooks/ # Jupyter notebooks with examples
16-
├── social_sector/ # Domain-specific helpers
17-
├── cleaning/ # Wrangling, tidying, validations
18-
├── visualisation/ # Custom plots, maps
19-
├── modelling/ # Predictive/statistical models
20-
├── io_helpers/ # File input/output tools
21-
├── validation/ # Column checks, schema tests
18+
├── notebooks/ # Jupyter notebooks with step-by-step examples
19+
├── social_sector/ # Domain-specific helpers for social development
20+
├── cleaning/ # Wrangling, tidying, and validation functions
21+
├── visualisation/ # Custom plots and interactive maps
22+
├── modelling/ # Statistical and predictive model templates
23+
├── io_helpers/ # File I/O utilities (CSV, Excel, GIS)
24+
├── validation/ # Schema checks and data quality tests
2225
├── tests/ # pytest tests for key modules
23-
├── sample_data/ # Simulated or cleaned inputs
24-
├── README.md
25-
├── ROADMAP.md
26-
├── LICENSE
27-
├── requirements.txt
28-
├── CONTRIBUTING.md
26+
├── sample_data/ # Synthetic datasets to follow along
27+
├── README.md # You are here!
28+
├── ROADMAP.md # Detailed v1.x plans
29+
├── LICENSE # MIT License
30+
├── requirements.txt # Python dependencies
31+
├── CONTRIBUTING.md # How to join the fun
2932
```
3033

3134
---
3235

33-
## 📘 What's Inside
36+
## 📘 Whats Inside
3437

35-
- Modular Python scripts (`.py`) and testable functions
36-
- Jupyter notebooks with sample CSV data
37-
- Spatial plotting (e.g., health access index maps)
38-
- Survey analysis, education summaries, WEE examples
39-
- Dashboard prep: wide long + clean exports
40-
- Compatible with pandas, geopandas, folium, matplotlib, numpy
38+
- **Easy‑to‑use scripts (`.py`)** for cleaning, validating, and transforming your data
39+
- **Jupyter & Quarto notebooks** showcasing real‑world examples—from exploratory analysis to modeling
40+
- **Spatial mapping tools** powered by `geopandas` and `folium` to visualize health & access indices
41+
- **Survey & WEE analyses** with clear, commented code you can adapt to your own projects
42+
- **Dashboard‑ready workflows** that reshape data (wide long) and export clean CSVs
43+
- **Automated tests** via `pytest` ensuring everything runs reliably every time
4144

4245
---
4346

4447
## 🧭 Roadmap Snapshot
4548

46-
> ✅ v1.0: Clean modular structure, tests, spatial & social sector tools
47-
> 🚀 v1.1+: Dashboards, NLP, real datasets, multi-language support
49+
> **v1.0:** Clean modular structure, core domain helpers, spatial & socialsector tools, and automated tests
50+
> 🚀 **v1.1+:** Interactive dashboards, NLP utilities, integration with real datasets, multilanguage support
4851
49-
See [ROADMAP.md](./ROADMAP.md) for details.
52+
For the full details on upcoming features, check out [ROADMAP.md](./ROADMAP.md).
5053

5154
---
5255

53-
## 📬 Contact
56+
## 🤝 Get In Touch
5457

55-
- Email: varna[DOT]sr [AT] gmail [DOT] com
56-
- Website: [varnasr.github.io](https://varnasr.github.io)
57-
- LinkedIn: [Varna Sri Raman](https://www.linkedin.com/in/varna)
58+
I love feedback and contributions! Reach out anytime:
59+
60+
- ✉️ Email: varna[DOT]sr [AT] gmail [DOT] com
61+
- 🌐 Website: [varnasr.github.io](https://varnasr.github.io)
62+
- 💼 LinkedIn: [Varna Sri Raman](https://www.linkedin.com/in/varna)
63+
64+
Or just open an issue or PR here on GitHub—I’m always happy to collaborate.
5865

5966
---
6067

61-
You're welcome to fork, adapt, and use — EquityStack is a living repository for better, fairer data workflows.
68+
## 📑 Citation
69+
70+
If **EquityStack** supports your work, please cite:
6271

63-
If you use this repository in your work, please cite it as:
64-
Sri Raman, V. (2025). *[EquityStack/FieldStack]: Reusable Tools for Applied Data Analysis and Evaluation*. GitHub. https://github.com/Varnasr/EquityStack
72+
> Sri Raman, V. (2025). _EquityStack: Reusable Tools for Applied Data Analysis and Evaluation_. GitHub. https://github.com/Varnasr/EquityStack
73+
74+
---
6575

76+
<footer align="center">
77+
Made with 💛 by [Varna Sri Raman](https://on-web.link/varna) · [GitHub](https://github.com/Varnasr) · [Threads](https://www.threads.net/@varnasriraman)
78+
</footer>

0 commit comments

Comments
 (0)