FlowModelingControl / flowtorch

flowTorch - a Python library for analysis and reduced-order modeling of fluid flows
GNU General Public License v3.0
131 stars 45 forks source link

Add requirements.txt file or equivalent #22

Closed akaptano closed 2 years ago

akaptano commented 2 years ago

Hello!

First of all, great job with this repository -- the functionality looks very useful. I'm going to be opening a set of new (mostly minor) issues directly in your GitHub repo, unless you prefer that I do so directly in the JOSS review.

First thing I noticed: installation went well with either pip or directly downloading the GitHub repo, but it appears that if the GitHub repo is directly downloaded, there is no requirements.txt or equivalent file that tells the user which python package dependencies are required to run your package. This should be a straightforward fix.

I believe the pip download correctly installs all the dependencies for the package.

Best, Alan

AndreWeiner commented 2 years ago

Hi Alan, thanks a lot for your suggestion. I added a requirements.txt file to the repository and a brief description to the README. The dependencies are also listed in setup.py, which is why the pip command installs all dependencies automatically. If you are happy with the changes, feel free to close this issue. Best, Andre