Update documentation for SIST 1.0.0 - #40
Merged
Merged
Conversation
jimboid
approved these changes
Aug 18, 2026
jimboid
left a comment
Member
There was a problem hiding this comment.
A comprehensive treatment of the documentation for the starting release of SIST as it will stand at 1.0.0. This will enable existing users and new users to pick up and run with the code in its new home. Thanks for this!
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
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.
Summary
This PR updates the SIST documentation for the 1.0.0 release, providing a clearer user-facing structure for installation, usage, source-level operation, development, testing, and citation.
The documentation retains the existing scientific guidance while reflecting the maintained Conda packaging, installed
sistcommand, regression testing, and CCPBioSim maintenance workflow.Changes
Documentation structure
Installation and usage
sistcommand as the primary user interface.Source and development documentation
master.pl,IR_finder.pl,trans_three, andtrans_compete.Citation and maintenance
Impact
sistcommand.