Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make JAX an optional dependency #503

Merged
merged 3 commits into from
Jun 13, 2023
Merged

Conversation

Lnaden
Copy link
Contributor

@Lnaden Lnaden commented Jun 12, 2023

This PR makes JAX an optional dependency at the pip level and raises a warning if JAX could not be imported to tell users it could be faster.

On the pip side, there will be 2 different instal options:

  • pip install pymbar will install without JAX
  • pip install pymbar[jax] will install with JAX.

Partial progress on #500. Until the conda feedstock issue is resolved with a new recipe, I want to leave #500 open to keep documenting it.

Note: there is an outstanding TODO on the README.md file to fill in once we have an official name for the lite version on conda-forge. Resolved as pymbar-core

This PR makes JAX an optional dependency at the pip level and raises a warning if JAX could not be imported to tell users it could be faster.

On the `pip` side, there will be 2 different instal options:

* `pip install pymbar` will install without JAX
* `pip install pymbar[jax]` will install with JAX.

Partial progress on choderalab#500. Until the [conda feedstock](conda-forge/pymbar-feedstock#34) issue is resolved with a new recipe, I want to leave choderalab#500 open to keep documenting it.

Note: there is an outstanding TODO on the `README.md` file to fill in once we have an official name for the lite version on conda-forge.
@Lnaden Lnaden mentioned this pull request Jun 12, 2023
@codecov
Copy link

codecov bot commented Jun 12, 2023

Codecov Report

Merging #503 (dcc6b6d) into master (2740798) will decrease coverage by 0.15%.
The diff coverage is 86.66%.

@Lnaden
Copy link
Contributor Author

Lnaden commented Jun 12, 2023

The docs failure has to do with Sphinx-RTD-Theme not being compatible with Sphinx 7.0+, not something we can directly control unless we add a requirements.txt and pin sphinx for RTD. But then we have an requirements file which will kind of confuse the installer, so I dont want to do that. Some talk of changing to Furo, but different issue than here.

@Lnaden Lnaden merged commit 86199a1 into choderalab:master Jun 13, 2023
@Lnaden Lnaden deleted the optional_jax branch June 13, 2023 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant