Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
66beb3d
Add a JOSS paper and the repository files a submission needs
vahid-ahmadi Sep 14, 2026
600f57b
Use title case, and describe weight preservation as it actually works
vahid-ahmadi Sep 16, 2026
4af194d
Add Nikhil Woodruff as an author, and acknowledge Anthony Volk and Ja…
vahid-ahmadi Sep 16, 2026
8f61e7a
Describe replicate-weight variance in the paper
vahid-ahmadi Sep 16, 2026
f039188
Correct the paper against a compliance review
vahid-ahmadi Sep 16, 2026
038238e
Correct three claims the source does not support
vahid-ahmadi Sep 16, 2026
19fe283
Add María Juaristi's ORCID
vahid-ahmadi Sep 16, 2026
3ad2ebb
Update author metadata
vahid-ahmadi Sep 16, 2026
4657b7c
Merge main into joss-paper
vahid-ahmadi Sep 18, 2026
97a5b2c
Format paper.md code blocks
vahid-ahmadi Sep 18, 2026
50b10ea
Record who contributed what, and add PyPI download figures
vahid-ahmadi Sep 18, 2026
d5306be
Record the Zenodo DOI
vahid-ahmadi Sep 18, 2026
0e61f9d
Describe cov and corr as implemented, and drop the trade framing
vahid-ahmadi Sep 18, 2026
01bc608
Tighten the paper's prose and refresh the impact figures
juaristi22 Sep 18, 2026
28b4acc
Phrase the release count so it does not go stale
vahid-ahmadi Sep 18, 2026
c2d9802
Transpose the comparison table
vahid-ahmadi Sep 18, 2026
0c38120
Trim the contribution note, and drop two grading adverbs
vahid-ahmadi Sep 18, 2026
6e7792b
Lead the impact paragraph with the dependency, not the counters
vahid-ahmadi Sep 18, 2026
0a62b4e
Brace-protect package names in the bibliography
vahid-ahmadi Sep 18, 2026
a5086da
Merge main into joss-paper
vahid-ahmadi Sep 18, 2026
5b41912
Act on a pre-submission JOSS review
vahid-ahmadi Sep 18, 2026
89585c2
Point the citation at the current archived version
vahid-ahmadi Sep 18, 2026
c34ad11
Simplify the comparison table, and drop the download figure
vahid-ahmadi Sep 18, 2026
be5ed49
Open up the comparison table's row spacing
vahid-ahmadi Sep 18, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/draft-pdf.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
on:
push:
paths:
- paper.md
- paper.bib
pull_request:
paths:
- paper.md
- paper.bib

jobs:
paper:
runs-on: ubuntu-latest
name: Draft PDF
steps:
- uses: actions/checkout@v4
- uses: openjournals/openjournals-draft-action@master
with:
journal: joss
- uses: actions/upload-artifact@v4
with:
name: paper
path: paper.pdf
41 changes: 41 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "microdf: Weighted DataFrames and Series for Survey Microdata Analysis"
url: "https://github.com/PolicyEngine/microdf"
repository-code: "https://github.com/PolicyEngine/microdf"
abstract: "Weighted pandas DataFrames and Series for survey microdata, with distributional statistics including weighted quantiles, Gini, income shares and Foster-Greer-Thorbecke poverty measures."
license: MIT
version: 1.5.9
doi: 10.5281/zenodo.22829459
identifiers:
- type: doi
value: 10.5281/zenodo.22829459
description: "Concept DOI, resolving to the latest archived version"
- type: doi
value: 10.5281/zenodo.22831047
description: "Archived version 1.5.9"
authors:
- family-names: Ahmadi
given-names: Vahid
orcid: "https://orcid.org/0009-0004-1093-6272"
affiliation: "PolicyEngine, Washington, DC, United States"
- family-names: Ghenis
given-names: Max
orcid: "https://orcid.org/0000-0002-1335-8277"
affiliation: "PolicyEngine, Washington, DC, United States"
- family-names: Juaristi
given-names: María
orcid: "https://orcid.org/0009-0007-4946-2248"
affiliation: "PolicyEngine, Washington, DC, United States"
- family-names: Woodruff
given-names: Nikhil
orcid: "https://orcid.org/0009-0009-5004-4910"
affiliation: "PolicyEngine, Washington, DC, United States"
keywords:
- survey statistics
- microdata
- inequality
- poverty
- pandas
- Python
64 changes: 64 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Contributor covenant code of conduct

## Our pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
hello@policyengine.org. All complaints will be reviewed and investigated
promptly and fairly.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

[homepage]: https://www.contributor-covenant.org
1 change: 1 addition & 0 deletions changelog.d/joss-paper.added.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Added a JOSS paper, a citation file, a code of conduct, and a workflow that builds a draft PDF of the paper.
143 changes: 143 additions & 0 deletions paper.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
@article{policyengine_py,
author = {Ahmadi, Vahid and Ghenis, Max and Woodruff, Nikhil and Makarchuk, Pavel and Volk, Anthony},
title = {{policyengine}: A Microsimulation Tool for Tax-Benefit Policy Analysis},
journal = {Journal of Open Source Software},
publisher = {The Open Journal},
volume = {11},
number = {125},
pages = {11115},
year = {2026},
doi = {10.21105/joss.11115},
url = {https://doi.org/10.21105/joss.11115}
}

@misc{arnold_ventures,
title={Public Finance Program},
author={{Arnold Ventures}},
year={2023},
note={Grant to PolicyEngine for congressional district-level policy analysis},
url={https://www.arnoldventures.org/work/public-finance}
}

@misc{nsf_pose,
title={{POSE}: Phase {I}: {PolicyEngine} -- Advancing Public Policy Analysis},
author={{National Science Foundation}},
year={2025},
note={Award 2518372. PI: Max Ghenis, PSL Foundation. \$299,974},
url={https://www.nsf.gov/awardsearch/showAward.jsp?AWD_ID=2518372}
}

@online{neo_philanthropy,
title={{NEO Philanthropy} Awards \$200,000 Grant to {PolicyEngine}},
author={Ghenis, Max},
year={2024},
url={https://policyengine.org/us/research/neo-philanthropy}
}

@software{claude2026,
title={{Claude}},
author={{Anthropic}},
year={2026},
note={Used for code refactoring, test authoring and drafting assistance},
url={https://www.anthropic.com/claude}
}

@misc{nuffield2024grant,
title={Enhancing, localising and democratising tax-benefit policy analysis},
author={{Nuffield Foundation}},
year={2024},
note={General Election Analysis and Briefing Fund grant to PolicyEngine},
url={https://www.nuffieldfoundation.org/project/enhancing-localising-and-democratising-tax-benefit-policy-analysis}
}
@inproceedings{mckinney2010pandas,
author = {McKinney, Wes},
title = {Data Structures for Statistical Computing in {P}ython},
booktitle = {Proceedings of the 9th Python in Science Conference},
pages = {56--61},
year = {2010},
doi = {10.25080/Majora-92bf1922-00a}
}

@software{pandas2020,
author = {{The pandas development team}},
title = {{pandas-dev/pandas}: {pandas}},
publisher = {Zenodo},
year = {2020},
doi = {10.5281/zenodo.3509134},
url = {https://doi.org/10.5281/zenodo.3509134}
}

@inproceedings{seabold2010statsmodels,
author = {Seabold, Skipper and Perktold, Josef},
title = {{statsmodels}: Econometric and statistical modeling with {P}ython},
booktitle = {Proceedings of the 9th Python in Science Conference},
year = {2010},
doi = {10.25080/Majora-92bf1922-011}
}

@article{foster1984fgt,
author = {Foster, James and Greer, Joel and Thorbecke, Erik},
title = {A Class of Decomposable Poverty Measures},
journal = {Econometrica},
volume = {52},
number = {3},
pages = {761--766},
year = {1984},
doi = {10.2307/1913475}
}

@article{lumley2004survey,
author = {Lumley, Thomas},
title = {Analysis of Complex Survey Samples},
journal = {Journal of Statistical Software},
volume = {9},
number = {8},
pages = {1--19},
year = {2004},
doi = {10.18637/jss.v009.i08}
}

@book{lumley2010complex,
author = {Lumley, Thomas},
title = {Complex Surveys: A Guide to Analysis Using {R}},
publisher = {John Wiley and Sons},
year = {2010},
doi = {10.1002/9780470580066}
}

@article{samplics,
author = {Diallo, Mamadou S.},
title = {{samplics}: a {P}ython Package for selecting, weighting and analyzing data from complex sampling designs},
journal = {Journal of Open Source Software},
volume = {6},
number = {66},
pages = {3376},
year = {2021},
doi = {10.21105/joss.03376}
}

@book{wolter2007variance,
author = {Wolter, Kirk M.},
title = {Introduction to Variance Estimation},
edition = {2},
publisher = {Springer},
year = {2007},
doi = {10.1007/978-0-387-35099-8}
}

@inproceedings{fay1995successive,
author = {Fay, Robert E. and Train, George F.},
title = {Aspects of Survey and Model-Based Postcensal Estimation of Income and Poverty Characteristics for States and Counties},
booktitle = {Proceedings of the Section on Government Statistics},
publisher = {American Statistical Association},
pages = {154--159},
year = {1995}
}

@manual{convey,
title = {{convey}: Income Concentration Analysis with Complex Survey Samples},
author = {Pessoa, Djalma and Damico, Anthony and Jacob, Guilherme},
year = {2026},
note = {R package version 1.0.1},
url = {https://CRAN.R-project.org/package=convey}
}
Loading
Loading