Repository navigation
Add example SIST results - #104
Merged
Merged
Conversation
harryswift01
force-pushed
the
22-docs-add-example-results
branch
from
November 16, 2026 16:47
2053c2c to
254436d
Compare
jimboid
approved these changes
Nov 17, 2026
jimboid
left a comment
Member
There was a problem hiding this comment.
Updating the examples with the new changes is important. Happy to see this merge.
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 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
docs/source/_static/examples/results:melting.json,z-dna.json,cruciform.jsonandcompetition.jsononpbr322.toy.fa.competition-no-inverted-repeats.jsonon a 2,000 bpAACrepeat, which has no inverted repeats, so some pairwise probabilities arenull.melting-with-warnings.jsonon a circular fragment with anNand 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.tests/unit/test_examples.py, which checks that every example passesResultValidatorand that together they cover every algorithm and both statuses.Testing
sistwith--json, using IRF 3.09 for the cruciform and competition runs.sist-validate.Impact
Checklist
pyproject.tomlchanged, the lower bounds were reviewed deliberately