rbdavid / USalign

Universal Structure Alignment of Monomeric and Complex Structure of Nucleic Acids and Proteins
https://zhanggroup.org/US-align/
Other
0 stars 0 forks source link

Test driven development #2

Open rbdavid opened 2 weeks ago

rbdavid commented 2 weeks ago

Gonna create a test suite for USalign, relevant to the application presented in #1.

For each pair, run the USalign standard implementations of -mm 5 and -mm 6 and save results in text files as well as parsed python objects. Ideally/locally, these results can be saved in pickle files but, for the github repo, they will be uploaded as json files instead.

These results can be then be checked against to ensure that any changes made to create python bindings aren't affecting the final results from the USalign methods.

Unfortunately, the original USalign repo does not contain a test suite and it is unclear to me if the authors have a in-home suite they use to ensure bugs do not make their way into the code base.

rbdavid commented 2 weeks ago

I really want to also add print statements to the original code implementation that reports on convergence of the SOI_iter function. Then those results can also be tested for. Maybe this is kinda boring since I won't be changing any (or much) of the internal code to the SOI_main function.

rbdavid commented 2 weeks ago

Also, if python bindings are ever gonna be created for the subfunctions called along the way, create tests for those subfunctions. But currently, the plan is only to bind the SOI_main function and leave the underlying c++ code "untouched".