docs: updating tutorial for ismb#469
Open
ntalluri wants to merge 20 commits into
Open
Conversation
Documentation build overview
4 files changed± tutorial/advanced.html± tutorial/beginner.html± tutorial/intermediate.html± tutorial/introduction.html |
Collaborator
Author
|
Still need to add the information about running dev containers, but other than that, everything else is ready. |
agitter
reviewed
May 26, 2026
Co-authored-by: Anthony Gitter <agitter@users.noreply.github.com>
agitter
reviewed
Jun 16, 2026
agitter
left a comment
agitter
left a comment
Collaborator
There was a problem hiding this comment.
This is just about ready. A few more minor comments.
| # then myAlg will be run on (a=1,b=0.5),(a=1,b=0.75),(a=2,b=0.5), and (a=2,b=0,75). Pretty neat, but be | ||
| # careful: too many parameters might make your runs take a long time. | ||
|
|
||
| # TODO: get rid of the algorithms that will take too long to run |
Comment on lines
+124
to
+135
| .. note:: | ||
|
|
||
| You may see the following error during installation: | ||
|
|
||
| .. code:: text | ||
|
|
||
| ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts. | ||
| dsub 0.4.13 requires tenacity<=8.2.3, but you have tenacity 9.1.4 which is incompatible. | ||
|
|
||
| This is safe to ignore. We do not use dsub as a container option in | ||
| this tutorial, and a fix is currently in progress. SPRAS and this | ||
| tutorial will run correctly without a working dsub installation. |
Collaborator
There was a problem hiding this comment.
Should we remove this now? If you check the GitHub Actions build in #485, we can approve and merge that fix.
Co-authored-by: Anthony Gitter <agitter@users.noreply.github.com>
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
3 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.
My current plan is to update the intermediate code to include evaluation / parameter selection. I will be leaving parameter tuning in the advanced capabilities section. I will also be editing the tutorial based on the comments from when Tony I presented at COMBINE.