Bringing over modules from the old toolbox - Githubissues

LatticeQCD / AnalysisToolbox

A set of Python tools for statistically analyzing data. This includes aspects of lattice QCD applications related to QCD phenomenology.

MIT License

22 stars 3 forks source link

Bringing over modules from the old toolbox #1

Closed clarkedavida closed 2 years ago

clarkedavida commented 2 years ago

The jackknife and boostrap are implemented and the tests pass. Was surprisingly painless and, at least according to PyCharm, relatively clean. This seems like a reasonable order for migrating and cleaning some code:

[x] plotting
[x] fitting
[x] splines
[x] physics stuff
[ ] correlator fitting suite

clarkedavida commented 2 years ago

Please do the following when bringing modules over:

Make sure it's clean according to PyCharm
Make sure it's written in Pythonic way
Follow https://google.github.io/styleguide/pyguide.html
Make sure everything is directly or indirectly tested. Put the test in testing folder
Make sure you add documentation in the corresponding spot under doc_src
Make sure there is no from module import * notation
If you find a method that is not being used, or shouldn't exist for some reason (e.g. there used to be some methods that depended on algopy, which weren't used and which Hauke said was slow and unreliable) please just delete it.

clarkedavida commented 2 years ago

Something else to consider, if you feel like it: Can the module I'm bringing over be parallelized in some way?

Possibilities: concurrent.futures, numba, multithreading

clarkedavida commented 2 years ago

Some more stuff with regard to physics modules, specifically:

Please include the DOI or arXiv of any paper you are using.
Please include old (for example) scale setting. I know that we don't use it anymore, but one of the points of NFDI is to support reproducibility, and I can imagine having (for example) old experimental values, scale setting parameterizations, and so on, will help in that direction. You don't have to add any if they aren't already there, just please don't delete them out of the toolbox. They don't hurt to have.

clarkedavida commented 2 years ago

I just want to comment on the above old scale setting point that it was convenient to have the wrong, older scale setting in for a project I am now working on. I had to undo that old scale setting, which was only possible because it was still in the toolbox!

clarkedavida commented 2 years ago

Basically everything major from the old toolbox has been pulled over. What remains is the correlator fitting suite, but I'm not sure anyone has time for that. Anyway the toolbox is useful as is.

I'm going to close this issue.