From 98d8a5ecdedb0c3392bac35aaeae2568c4ac12b8 Mon Sep 17 00:00:00 2001 From: Victor Lin <13424970+victorlin@users.noreply.github.com> Date: Thu, 15 Jun 2023 11:58:46 -0700 Subject: [PATCH] Update runtime-dependent setup step The step now applies to all runtime setups. Previously, it relied on inaccurate assumptions: 1. It only supported 2 runtimes, Docker and ambient. 2. If using the ambient runtime, it already had tools available (e.g. a Conda environment is already active). --- src/tutorials/creating-a-workflow.rst | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/src/tutorials/creating-a-workflow.rst b/src/tutorials/creating-a-workflow.rst index 8985d227..77643af4 100644 --- a/src/tutorials/creating-a-workflow.rst +++ b/src/tutorials/creating-a-workflow.rst @@ -33,15 +33,27 @@ Setup mkdir -p results/ -3. Additionally, if you installed Nextstrain with the :term:`Docker runtime`, start Docker and enter the runtime. +3. Enter a prompt with Nextstrain tools available. This varies by runtime. - .. code-block:: bash + .. tabs:: + + .. group-tab:: Docker, Conda + + .. code-block:: bash + + nextstrain shell . + + .. note:: + + The dot (``.``) as the last argument indicates that your current directory (``zika-tutorial/``) is the working directory. Your command prompt will change to indicate you are in a Nextstrain shell, which provides access to commands such as ``augur`` and ``auspice``. If you want to leave the Nextstrain shell, run the command ``exit``. + + .. group-tab:: Ambient (advanced) - nextstrain shell . + This varies depending on how your ambient runtime is set up. If you've installed tools into a custom Conda environment, activate it. - .. note:: + .. code-block:: bash - The dot (``.``) as the last argument indicates that your current directory (``zika-tutorial/``) is the working directory. Your command prompt will change to indicate you are in the Docker runtime. If you want to leave the runtime, run the command ``exit``. + conda activate Run a Nextstrain Build ======================