Update documentation and code structure #35
Conversation
Shibabrat
changed the title
There was a problem hiding this comment.
This PR is touching a lot of the same files as #34 , so it's hard to evaluate them simultaneously.
I did go through and add a few specific comments for this one, but see also the other PR for some overlapping points. Might be best to merge both of these PRs into a branch, then open a new PR to merge that one into master so we can see a unified view.
examples/turning_pt_coupled.py
Outdated
|
|
||
| return x[3] | ||
| import turning_point | ||
| importlib.reload(turning_point) |
There was a problem hiding this comment.
importlib should definitely not be used in final code
| deltaE = e - parameters[2] | ||
|
|
||
| """ | ||
| Trial initial Condition s.t. one initial condition is on the LHS of the UPO and the |
There was a problem hiding this comment.
Don't use triple-quoted strings in the middle of normal code. Use comments for that.
|
Also, this does not resolve #3 or #7 . There are still many pep8 violations and overly-abbreviated names without good reason (e.g., |
This fixes #2 #3 #7 by adding the documentation with docstrings and checking for standard python code style.
Also fixes #8 and #13 by organizing example scripts and method scripts in separate directories and renaming files that call the method for an example problem.