Skip to content

Add example SIST results - #104

Merged
harryswift01 merged 6 commits into
mainfrom
22-docs-add-example-results
Nov 17, 2026
Merged

harryswift01 merged 6 commits into
mainfrom
22-docs-add-example-results

Conversation

@harryswift01

@harryswift01 harryswift01 commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

Summary

This PR adds example structured results made by sist --json, covering every algorithm and both successful and failed runs, with a test that checks they stay valid. Part of #22.

Changes

  • Add eight example results in docs/source/_static/examples/results:
    • melting.json, z-dna.json, cruciform.json and competition.json on pbr322.toy.fa.
    • competition-no-inverted-repeats.json on a 2,000 bp AAC repeat, which has no inverted repeats, so some pairwise probabilities are null.
    • melting-with-warnings.json on a circular fragment with an N and a low threshold, which raise warnings.
    • melting-failed-underflow.json, a failed run where the partition function underflows.
    • competition-failed-no-irf.json, a failed run without IRF installed.
  • Add tests/unit/test_examples.py, which checks that every example passes ResultValidator and that together they cover every algorithm and both statuses.

Testing

  • Each example was made by running sist with --json, using IRF 3.09 for the cruciform and competition runs.
  • Every example passes sist-validate.

Impact

  • Adds example files and a test. No change to code or output.

Checklist

  • Tests added or updated
  • Documentation updated
  • If dependencies in pyproject.toml changed, the lower bounds were reviewed deliberately

@harryswift01 harryswift01 self-assigned this Nov 16, 2026
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Nov 16, 2026
@harryswift01
harryswift01 force-pushed the 22-docs-add-example-results branch from 2053c2c to 254436d Compare November 16, 2026 16:47
@harryswift01
harryswift01 requested a review from jimboid November 17, 2026 10:40

@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.

Updating the examples with the new changes is important. Happy to see this merge.

@harryswift01
harryswift01 merged commit 8a088d5 into main Nov 17, 2026
20 checks passed
@harryswift01
harryswift01 deleted the 22-docs-add-example-results branch November 17, 2026 11:50
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.

2 participants