search

LupoA / lsdensities

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

Improve README #45

Closed edbennett closed 3 months ago

edbennett commented 6 months ago

Some things would improve the README

LupoA commented 6 months ago

Should I also change the repository's name according to the package name? I am in favor of that, yet don't want anyone to have a stroke

edbennett commented 6 months ago

It would make life simpler for users. So long as you update the README at the same time to match, I don't see an issue.

LupoA commented 6 months ago

happy to do more changes, you can close otherwise :)

edbennett commented 6 months ago

Thanks Alessandro, that looks a lot better. Could you adjust the example so that it's obvious what sort of data structures are expected for time_extent, parameters, energy, and lattice_correlator, please? (And, if I'm allowed to be picky, replace inputMatrix with input_matrix?)

LupoA commented 6 months ago

Added a bit of info. Pickiness is very welcome!

edbennett commented 6 months ago

Thanks! My intent is to make it so someone can run the example and have it work—to that end, can you a) add the import for Inputs, and b) copy-paste this into a .py file and run it and check that it doesn't error, please?

LupoA commented 6 months ago

thanks that gives me a better idea. Should I also include the file into the example folder?

edbennett commented 6 months ago

That would probably also make sense. :+1:

LupoA commented 5 months ago

all done here