search

madscatt / zazzie

development branch
GNU General Public License v3.0
2 stars 3 forks source link

write docstrings for sturhmann_parallel_axis module #132

Closed skrueger111 closed 1 year ago

skrueger111 commented 1 year ago

The stuhrmann_parallel_axis module is running from a GUI mimic and it is ready to use to test a GUI. However, the docstrings need to be finished. There are a number of equations that need to be documented and referenced, and variable definitions need to be fleshed out.

skrueger111 commented 1 year ago

bi00193a009.pdf Eqs 4 and 5 from this document need to be put into the docstrings. The equations for the errors on the parameters also need to be included. These equations aren't referenced in the original MULCh paper, so some sleuthing needs to be done to determine if there is a reference.

skrueger111 commented 1 year ago

The error analysis needs to be further evaluated. A separate issue will be opened for this purpose. This issue will be closed once docstrings are done for everything else.

skrueger111 commented 1 year ago

Once docstrings are added, check for correct syntax and test all 3 current methods via gui_mimic_multi_component_analysis.py to make sure they still run OK after the changes are made.

skrueger111 commented 1 year ago

Added the version of stuhrman_parallel_axis.py with docstrings. Tested all 3 methods via gui_mimic_multicomponent_analysis. All run OK.