PolicyEngine / PolicyEngine/policyengine-sim-api
Explore architecting a new simulation API output structure
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- Avg merge
- 10h 29m
- Merged PRs (30d)
- 7
Description
Perhaps this should be done alongside app v2 implementation, but the output structure we surface after running a given society-wide simulation can be challenging to manipulate. For example, the Winners & Losers deciles are an array of 10 items, but the Deciles impacts (which you'd think would be handled the same way) are actually an object with keys corresponding to a given decile. Harmonizing how we treat some of these calculations would allow for more reusable code.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how simulation results are assembled and compare the Winners & Losers deciles with Deciles impacts. Review the app v2 context before proposing a consistent output structure. Done means the affected calculations expose a harmonized, reusable structure, with the scope and design agreed by maintainers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100