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

update installation instructions #25

Open
orbeckst opened this issue Jul 18, 2023 · 1 comment · May be fixed by #63
Open

update installation instructions #25

orbeckst opened this issue Jul 18, 2023 · 1 comment · May be fixed by #63
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@orbeckst
Copy link
Member

orbeckst commented Jul 18, 2023

The installation instructions https://www.mdanalysis.org/hole2-mdakit/getting_started.html#build-and-installation and README need to be updated to include the pip installation from PyPi.

Given how important hole2 is, we should explicitly indicate how to install it:

Eventually we should have a conda-forge package for this MDAKit.

Old issue text:

The docs https://www.mdanalysis.org/hole2-mdakit/getting_started.html#build-and-installation state that there's no conda package available. However, the README shows the recently added conda-forge package installation.

The sphinx docs should be updated to show the conda installation first (because of the ease to pull in hole itself), then pip, then source install.~

@orbeckst orbeckst added the documentation Improvements or additions to documentation label Jul 18, 2023
@orbeckst orbeckst changed the title update installation instructions update installation instructions for conda package Oct 19, 2023
@orbeckst orbeckst changed the title update installation instructions for conda package update installation instructions Oct 19, 2023
@orbeckst
Copy link
Member Author

We should consider making the hole2 conda-forge package a dependency for mdahole2 (at least for Linux and OSX) so that one gets all needed packages in one go.

Will open issue.

@orbeckst orbeckst self-assigned this Mar 28, 2024
@RubenChM RubenChM linked a pull request Dec 13, 2024 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant