LupoA / lsdensities

Smeared spectral densities from lattice correlators
GNU General Public License v3.0
3 stars 0 forks source link

Use Python package structure #27

Closed edbennett closed 6 months ago

edbennett commented 6 months ago

It would be really good to restructure this into a Python package, such that anyone can install it with pip, and so that you don't have to mess around with adding directories to the PATH to be able to import things correctly.

Python provides a tutorial on packaging Python projects. (Note if you're skim-reading that YOUR_USERNAME_HERE is not an essential part of a package name, that's just so you can follow the tutorial without clashing with anyone else's tutorial package.)

Essential aspects of this:

Once this is done, #26 will probably be easier. (If #26 is already done, then this will break CI and it will need to be fixed.)

nickforce989 commented 6 months ago

I have started addressing this issue (togheter with issues #23 and #24, LICENSE and README) in the branch feature/package. This branch starts from Alessandro's modifications in feature/GP.

In this branch, I will also try to merge the fitting procedure of spectral densities and the usage of different kernels. Moreover, I will add a couple of things that are missing currently in the most recent version of the code.

LupoA commented 6 months ago

excellent, thanks! I'll assign you to this issue

edbennett commented 6 months ago

If HLTRho is going to be the public-facing name for the package, it would probably be a good idea to use something similar (e.g. hltrho) in Python rather than rhos, which may clash with other differently-named packages (and confuse users).

LupoA commented 6 months ago

if anyone is good with acronyms and shit like that I am down for a completely new name

edbennett commented 6 months ago

The first word that springs out of doing grep -I '^ha.*l.*t' /usr/share/dict/words (and that isn't already a package on PyPI, as HaLT is) is HaLaTion, which would have the bonus of giving you a natural theme song for the code (which is obviously the most important consideration when writing software).

LupoA commented 6 months ago

I think we are covered with the music regardless

edbennett commented 6 months ago

Resolved by #41.