Explore architecting a new simulation API output structure
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Refactor
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- api, backend-api-design
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.
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.
- Dominant language
- Python
- Stars
- 1
- Forks
- 1
- Avg merge
- 15h 10m
- Merged PRs (30d)
- 12
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.
More from PolicyEngine/policyengine-sim-api
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
PolicyEngine/policyengine-sim-api#674 · 3 comments ·
All issues in PolicyEngine/policyengine-sim-api
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
stephrobert/dsoxlab#238 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
sublimehq/package_control#1780 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
nwg-piotr/nwg-displays#145 ·