diff --git a/TODO.org b/TODO.org index b12526093b14f3bcc2b34154bc7542b18927e57b..d97a105f00188320fed74afd391368ea58c68ce8 100644 --- a/TODO.org +++ b/TODO.org @@ -1,7 +1,6 @@ * To do list ** Structure: *** TODO Make sure the structure is logical and clear - *** TODO Follow tutorials on how to properly package the code; - [ ] https://packaging.python.org/tutorials/packaging-projects/ - [ ] https://realpython.com/python-modules-packages/ @@ -9,22 +8,30 @@ - [ ] https://python-packaging-tutorial.readthedocs.io/en/latest/ ** formatting: -*** TODO Make a routine to automatically format the code using the Black formatter\ +*** TODO Make a routine to automatically format the code using the Black formatter ** Documentation: *** TODO Properly set up the doc generation *** TODO Have this on readthedocs. +*** TODO Have the notebook with example on nbviewer -*** TODO Have the notebook with example on nbviewer ** Features: *** Help functionality **** TODO Add help functionality to the module by calling the binary_c help api +**** TODO Add help_all functionality: to have binary_c return the whole set of parameter descriptions *** Floors Stroopwafel -**** TODO Implement the code that FLoor will provide +**** TODO Implement the code that FLoor will provide +**** TODO Implement options to run a population with AIS *** Parallelization **** TODO Look into ways of parallelizing the code to generate populations. + +*** Populations +**** TODO Set up a multiprocessing routine (like joblib) to be able to run populations +**** TODO Allow custom parse functions +**** TODO Make example of how to write a custom logging function that logs once and then quits the sim + ** Compare to other codes *** TODO Compare to HOKI *** TODO COmpare to SEBA