Skip to content

Commit

Permalink
build: Revise an out-of-date description in --help
Browse files Browse the repository at this point in the history
At this point, other places are better for documenting specifics of our
different runtimes than the --help output of `build`.
  • Loading branch information
tsibley committed Jan 13, 2023
1 parent 8772c33 commit 645afc2
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions nextstrain/cli/command/build.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,9 @@
The build directory should contain a Snakefile, which will be run with
snakemake.
The default runtime is an ephemeral Docker container which has
all the necessary Nextstrain components available. You may instead run the
build in the ambient environment by passing the --ambient flag, but all
dependencies must already be installed and configured. For larger builds, you
may want to use the --aws-batch flag to launch jobs on AWS Batch instead of
running locally (if the required AWS resources are configured in your AWS
account).
You can test if Docker, ambient, or AWS Batch runtimes are properly
supported on your computer by running:
You need at least one runtime available to run a build. You can test if the
Docker, Conda, ambient, or AWS Batch runtimes are properly supported on your
computer by running:
nextstrain check-setup
Expand Down

0 comments on commit 645afc2

Please sign in to comment.