search

LupoA / lsdensities

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

Add requirements.txt #47

Closed edbennett closed 5 months ago

edbennett commented 5 months ago

pyproject.toml defines requirements for installing a package, and that is now done correctly.

requirements.txt is useful to let people know what other packages are needed to be able to contribute to development of a project. Currently this is pre-commit, but pytest is coming soon (#42).

Once that's created, there should be a mention in the README of it. (E.g. a short section on contributing/setting up a development environment.)

nickforce989 commented 5 months ago

@edbennett Is there a specific format for this file? Or is it just a '.txt' file?

edbennett commented 5 months ago

Documentation: https://pip.pypa.io/en/stable/reference/requirements-file-format/

nickforce989 commented 5 months ago

I might have addressed this issue? @edbennett

edbennett commented 5 months ago

You don't need mpmath and progressbar as they are already required via pyproject.toml.

nickforce989 commented 5 months ago

Corrected.

edbennett commented 5 months ago

Regarding the README, the requirements.txt only lists the development requirements, so we should move that below the instructions for people who want to use the package and mention that they are development requirements rather than general ones.

nickforce989 commented 5 months ago

Is it reasonable now?