SeBecker
commented
4 years ago I continues Hans-Martins commit and reorganized all functions but there is more to do here:
-
[ ] Split the functions that are currently located in ret.py in the following way:
-
Functions that are only relevant for the retirement model stay in ret.py
-
Functions that are of a more general nature (upper envelope/secondary envelope...) should be transferred in another file
-
Functions that are used in the retirement model functions as well as the upper envelope functions should be transferred in a separate file.
-
For this purpose we should set up the usual package structure like in respy/soepy/grmpy
-
[ ] Provide appropriate docstrings for all functions
-
[ ] Additionally we should include a function that sets up the relevant output containers.
-
[ ] Currently our function inputs look messy, maybe we should simplify it by making use of
*args
After ensuring that our Python implementation produces the same result as the MatLab counterpart, we want to revisit the Python version and make it more pythonic.
Our goal is to reach the exact same result as the MatLab implementation, but this does not necessarily require that we confine ourself to line-to-line translation. Even, if we end up with a code base barely relatable to the MatLab implementation, as long as the result is the same in all possible cases and the code is faster and more pythonic - we should do it!