search

SMU-clusters / ssptools

MIT License
2 stars 0 forks source link

Feature/clean up #3

Closed nmdickson closed 1 year ago

nmdickson commented 1 year ago

This is a major update which:

  1. Refactors and rewrites large portions of the evolve_mf (and related) module
  2. Removes a lot of unused or unpolished sections of the code
  3. Add some basic documentation to most things
  4. Adds a suite of unit tests covering most remaining functionality
  5. Rewrites and (hopefully) modernizes the package setup

These updates (in particular the updates to evolve_mf definitely break backwards compatibility, so updates to any downstream packages will be necessary as well. In particular, there is no longer a separate module for the 3-component IMF, it is now the only one (currently) supported.

The results of the evolve_mf function will have changed in only one way, as fb41df2 fixed a bug in how the individual remnant masses were sometimes being outputted as exactly equal to the stellar individual masses, and not actually equal to $M_r/N_r$. None of the other output quantities should be changed whatsoever.

nmdickson commented 1 year ago

Few small things I would like to see before this is merged:

  1. Someone else testing that the new setup config still works.
  2. Maybe some auto-testing / CI stuff to the repo, now that we have unit tests
  3. At least some auto-generated online documentation, even if no other manual descriptions are added.