Docs - final draft#5
Merged
Merged
Conversation
Member
rclune
commented
May 7, 2026
rclune
commented
- Split up the examples information to reflect the subdirectory structure
- Added information about model checkpoints
- Moved information about command line options that was in the README file in the examples to the descriptions in parsers.py
- Added advice for what to do if installation issues occur
…ed example scripts to executables
STILL NEEDS PROOF READING
- Took apart the README in the examples folder and split the information between:
- index.py (information about running with pixi, input and output files)
- parsers.py (command line option descriptions and usage advice)
- docs/examples/monomer.md (information about the examples in the example/monomer folder)
- docs/examples/interface_design.md (information about the examples in the example/interface folder)
- docs/examples/postprocessing.md (information about the examples in the example/postprocessing folder)
- The example/README.md now just contains a brief note about how to run the examples and links (that will not work until the repo is transferred) to the external documentation
- Changed the instalaltion guide to just 'Installation Issues' since the README already describes the various ways to install HBDesigner
- Added documentation file that gives a summary of each provided checkpoint file
- added the `prog` argument to the parser to make it appear in the external documentation correctly.
Minor updates were made to clarify language and improve the order of some sections.
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.