TODO.org

To do list

Structure:

Make sure the structure is logical and clear

Follow tutorials on how to properly package the code;

• [ ] https://packaging.python.org/tutorials/packaging-projects/
• [ ] https://realpython.com/python-modules-packages/
• [ ] https://python-packaging.readthedocs.io/en/latest/
• [ ] https://python-packaging-tutorial.readthedocs.io/en/latest/

formatting:

Make a routine to automatically format the code using the Black formatter

Documentation:

Properly set up the doc generation

Have this on readthedocs.

Have the notebook with example on nbviewer

Features:

Help functionality

Add help functionality to the module by calling the binary_c help api

Add help_all functionality: to have binary_c return the whole set of parameter descriptions

Floors Stroopwafel

Implement the code that FLoor will provide

Implement options to run a population with AIS

Parallelization

Look into ways of parallelizing the code to generate populations.

Populations

Set up a multiprocessing routine (like joblib) to be able to run populations

Allow custom parse functions

Make example of how to write a custom logging function that logs once and then quits the sim

Compare to other codes

Compare to HOKI

COmpare to SEBA

Compare to COSMIC

FSPS