README: Add --docker and --cpus 1 to the example nextstrain build invocation#10
Merged
README: Add --docker and --cpus 1 to the example nextstrain build invocation#10
nextstrain build invocation#10Conversation
…nvocation The --image argument is ignored unless a containerized runtime is used (Docker or AWS Batch currently). Under the "native"/ambient runtime, which may be the default for some installations, a warning will be emitted but ultimately --image will be ignored. Specifying --docker explicitly means a more obvious (although still not good) error occurs earlier. These two arguments are temporary until Nextalign v2 has a stable release. Relatedly, specifying --cpus 1 now heads off issues with "native"/ambient environments with newer Snakemake's until Nextstrain CLI accounts for that automatically. While this invocation doesn't use the "native"/ambient runtime now, including --cpus now means that when --image and --docker are no longer necessary we can simply remove them. Before that point, it also provides a guidance point for people using variants of this example invocation. Ultimately, given further work within our ecosystem (Nextalign, Nextstrain CLI), this whole invocation should revert back to just `nextstrain build .`.
Use all the CPUs available for Nextalign, under the assumptions that a) this workflow currently produces a single build at a time and b) Nextalign doesn't have significant upper limits on useful parallelism (number of input sequences not withstanding, which is awkward to calculate here). These assumptions might be incorrect? They certainly might _become_ incorrect later, so we should remember to reconsider them in the future. Use up to 8 CPUs for `augur tree`, as I dimly recall diminishing returns from IQ-TREE above a number like 8. This might also be wrong, though!
Contributor
Author
|
New commit (1088ed1) on top:
Thoughts? |
rneher
approved these changes
May 25, 2022
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.
The --image argument is ignored unless a containerized runtime is used
(Docker or AWS Batch currently). Under the "native"/ambient runtime,
which may be the default for some installations, a warning will be
emitted but ultimately --image will be ignored. Specifying --docker
explicitly means a more obvious (although still not good) error occurs
earlier. These two arguments are temporary until Nextalign v2 has a
stable release.
Relatedly, specifying --cpus 1 now heads off issues with
"native"/ambient environments with newer Snakemake's until Nextstrain
CLI accounts for that automatically. While this invocation doesn't use
the "native"/ambient runtime now, including --cpus now means that when
--image and --docker are no longer necessary we can simply remove them.
Before that point, it also provides a guidance point for people using
variants of this example invocation.
Ultimately, given further work within our ecosystem (Nextalign,
Nextstrain CLI), this whole invocation should revert back to just
nextstrain build ..Related issue(s)
Related to #8
Testing
Ran new example invocation under environments where the