Skip to content

Update documentation for SIST 1.0.0 - #40

Merged
harryswift01 merged 1 commit into
mainfrom
17-docs-document-sist
Aug 18, 2026
Merged

Update documentation for SIST 1.0.0#40
harryswift01 merged 1 commit into
mainfrom
17-docs-document-sist

Conversation

@harryswift01

Copy link
Copy Markdown
Member

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 sist command, regression testing, and CCPBioSim maintenance workflow.

Changes

Documentation structure

  • Reorganised the documentation into dedicated pages for the user guide, installation, source usage, development and testing, and citation.
  • Updated the main documentation index and navigation order.

Installation and usage

  • Added the Conda installation route for SIST.
  • Documented the installed sist command as the primary user interface.
  • Added examples for melting, Z-DNA, cruciform, and competition calculations.
  • Documented input requirements, command-line options, output behaviour, and IRF-dependent calculations.
  • Retained the recommended scientific parameter ranges and algorithm limitations.

Source and development documentation

  • Documented the source components, including master.pl, IR_finder.pl, trans_three, and trans_compete.
  • Retained instructions for building and running the C++ components directly.
  • Added guidance for source-tree testing and the maintained scientific regression baselines.
  • Documented the Conda package build and test workflow.
  • Added an overview of the release workflow and package validation process.

Citation and maintenance

  • Added guidance for citing the SIST software and associated scientific methods.
  • Retained the original SIST scientific references.
  • Identified CCPBioSim as the current maintainer and development organisation.
  • Retained the original contact information separately from current maintenance information.

Impact

  • Provides a clearer and more maintainable documentation structure for SIST 1.0.0.
  • Gives users a supported installation and usage path through Conda and the sist command.
  • Preserves the scientific guidance and source-level information from the original SIST documentation.
  • Documents the validation and release processes used to maintain reproducible scientific behaviour.
  • No changes are made to the scientific implementation or numerical behaviour.

@harryswift01 harryswift01 self-assigned this Aug 18, 2026
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Aug 18, 2026
@harryswift01 harryswift01 linked an issue Aug 18, 2026 that may be closed by this pull request
@harryswift01
harryswift01 requested a review from jimboid August 18, 2026 10:42

@jimboid jimboid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@harryswift01
harryswift01 merged commit 91f7358 into main Aug 18, 2026
2 checks passed
@harryswift01
harryswift01 deleted the 17-docs-document-sist branch August 18, 2026 10:46
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 this pull request may close these issues.

[Docs]: Document SIST 1.0.0 Migration to Conda Release

2 participants