Docs: New Installation docs#1090
Merged
dwhswenson merged 2 commits intoNov 10, 2021
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1090 +/- ##
=======================================
Coverage 81.56% 81.56%
=======================================
Files 140 140
Lines 15452 15452
=======================================
Hits 12604 12604
Misses 2848 2848 Continue to review full report at Codecov.
|
sroet
requested changes
Nov 9, 2021
sroet
left a comment
Member
There was a problem hiding this comment.
please update the pip commands to the current recommended python -m pip, and 1 question about py-plumed. LGTM otherwise
Co-authored-by: Sander Roet <sanderroet@hotmail.com>
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is a rewrite of the installation page of the docs. The old installation page was originally written with the expectation that we'd need to onboard new contributors who had very little Python experience, and that we'd want to give them multiple options for how to get OPS installed.
However, the install docs are one of the first pages users come to. So I've re-written them to be more focused on user concerns. I kept a brief mention of installing by pip/setuptools, but basically assume that if you're doing that, you know what you're doing.
The new docs include also discuss various tools within the molecular simulation ecosystem that OPS integrates with, and they emphasize that all you need to do to get OPS to work with those tools is install them on your system.
Docs-only; this should be immediately ready for review. I will leave it open for at least 24 hours, merging no earlier than Wed 10 Nov 20:00 GMT (15:00 my local).