Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation and add charts #56

Closed
wants to merge 19 commits into from
Closed

Conversation

nikhilwoodruff
Copy link
Contributor

Charts used in the Scottish budget analysis- e.g. the earnings variation chart.

@nikhilwoodruff nikhilwoodruff self-assigned this Dec 6, 2024
@nikhilwoodruff nikhilwoodruff marked this pull request as draft December 6, 2024 11:50
@nikhilwoodruff nikhilwoodruff marked this pull request as ready for review December 6, 2024 14:08
@MaxGhenis
Copy link
Contributor

could you add an issue? who'd you like to review this?

The existing type hints in simulation.py are incorrect. This attempts to
fix them (And associated issues found while doing that), but I had to
use # type:ignore in one place related to where we are trying to work on
microsimulation and simulation in the same code even though only some of
it applies to microsimulations.

Do not merge as-is, this commit is at-request to show current progress
@nikhilwoodruff nikhilwoodruff marked this pull request as draft December 9, 2024 12:06
@nikhilwoodruff
Copy link
Contributor Author

@mikesmit this incorporates your branch (fixed merge conflicts), and also adds a fair amount of documentation.

The docs now have a page on:

  • The Simulation class (via sphinx autodoc)
image
  • Every leaf endpoint that you can pass into Simulation.calculate. Claude assisted with this but it was more of a joint process.
image image

@nikhilwoodruff nikhilwoodruff marked this pull request as ready for review December 10, 2024 12:18
@nikhilwoodruff
Copy link
Contributor Author

I'd like to merge if possible so as to move the repo away from its broken state- feedback still absolutely welcome!

@nikhilwoodruff nikhilwoodruff changed the title Add charts Improve documentation and add charts Dec 10, 2024
@nikhilwoodruff
Copy link
Contributor Author

Superseded by #62

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants