Repository navigation
Direct Engine API Docs - #793
Merged
Merged
Conversation
Also, update to use 4 threads; 8 caused local build problems
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.
Only updates to docs. This mainly includes documentation about how to use the direct control API for engines (the standard API we used for toy engine and OpenMM). In particular it adds two significant files:
engines_direct_api.rst: Explanation of the direct API and how to implement an engine using it.snapshot_features.rst: Documentation on the snapshot features and how to use them. Not quite complete; still needs more about how to add storable features.Also added docstrings to
SnapshotDescriptorso that linking to it explains how to use it..In addition, this includes a bunch of minor fixes to the docs:
This is docs-only, so should be immediately ready for review. If no review in a week (August 4) I'll self-merge this.