NIFTy-PPL / NIFTy

Probabilistic programming framework for signal inference algorithms that operate regardless of the underlying grids and their resolutions
https://ift.pages.mpcdf.de/nifty/index.html
GNU General Public License v3.0
13 stars 2 forks source link

Remind user to install extra `nifty[re]` dependencies when installing editable version #12

Closed apizzuto closed 2 months ago

apizzuto commented 2 months ago

Part of https://github.com/openjournals/joss-reviews/issues/6593

I decided to install the editable version in a fresh virtual environment and if following the directions in the README, this will leave the user without the extra dependencies that are installed when installing from pypi with the [re] specification. If possible, please just list the extra dependencies the user should install in the README when describing how to install the editable version (eg. jax and jaxlib based off of the setup.py file)

Edenhofer commented 2 months ago

Thanks for filing this issue! Right, we should tell users to install '.[re]' when installing the editable version!