Author: Michael R. Crusoe <crusoe@debian.org>
Description: Update docs to reflect a local install
Forwarded: not-needed
--- toil.orig/docs/index.rst
+++ toil/docs/index.rst
@@ -29,7 +29,6 @@
 .. toctree::
    :caption: Getting Started
 
-   gettingStarted/install
    gettingStarted/quickStart
 
 .. toctree::
--- toil.orig/docs/gettingStarted/quickStart.rst
+++ toil/docs/gettingStarted/quickStart.rst
@@ -13,18 +13,6 @@
 workflows that are portable across multiple workflow engines and platforms.
 Running CWL workflows using Toil is easy.
 
-#. First ensure that Toil is installed with the
-   ``cwl`` extra (see :ref:`extras`)::
-
-       (venv) $ pip install 'toil[cwl]'
-
-   This installs the ``toil-cwl-runner`` executable.
-
-   .. note::
-
-      Don't actually type ``(venv) $`` in at the beginning of each command. This is intended only to remind the user that
-      they should have their :ref:`virtual environment <venvPrep>` running.
-
 #. Copy and paste the following code block into ``example.cwl``:
 
    .. code-block:: yaml
@@ -50,11 +38,11 @@
 
 #. To run the workflow simply enter ::
 
-        (venv) $ toil-cwl-runner example.cwl example-job.yaml
+        $ toil-cwl-runner example.cwl example-job.yaml
 
    Your output will be in ``output.txt``::
 
-        (venv) $ cat output.txt
+        $ cat output.txt
         Hello world!
 
 
@@ -84,13 +72,6 @@
 The `Workflow Description Language`_ (WDL) is another emerging language for writing workflows that are portable across multiple workflow engines and platforms.
 Running WDL workflows using Toil is still in alpha, and currently experimental.  Toil currently supports basic workflow syntax (see :ref:`wdl` for more details and examples).  Here we go over running a basic WDL helloworld workflow.
 
-#. First ensure that Toil is installed with the
-   ``wdl`` extra (see :ref:`extras`)::
-
-        (venv) $ pip install 'toil[wdl]'
-
-   This installs the ``toil-wdl-runner`` executable.
-
 #. Copy and paste the following code block into ``wdl-helloworld.wdl``::
 
         workflow write_simple_file {
@@ -110,11 +91,11 @@
 
 #. To run the workflow simply enter ::
 
-        (venv) $ toil-wdl-runner wdl-helloworld.wdl wdl-helloworld.json
+        $ toil-wdl-runner wdl-helloworld.wdl wdl-helloworld.json
 
    Your output will be in ``wdl-helloworld-output.txt``::
 
-        (venv) $ cat wdl-helloworld-output.txt
+        $ cat wdl-helloworld-output.txt
         Hello world!
 
 This will, like the CWL example above, use the ``single_machine`` batch system
@@ -144,7 +125,7 @@
 
 3. Specify the name of the :ref:`job store <jobStoreOverview>` and run the workflow::
 
-       (venv) $ python3 helloWorld.py file:my-job-store
+       $ python3 helloWorld.py file:my-job-store
 
 For something beyond a "Hello, world!" example, refer to :ref:`runningDetail`.
 
@@ -169,7 +150,7 @@
 
 #. Run it with the default settings::
 
-      (venv) $ python3 sort.py file:jobStore
+      $ python3 sort.py file:jobStore
 
    The workflow created a file called ``sortedFile.txt`` in your current directory.
    Have a look at it and notice that it contains a whole lot of sorted lines!
@@ -186,7 +167,7 @@
 
 3. Run with custom options::
 
-      (venv) $ python3 sort.py file:jobStore \
+      $ python3 sort.py file:jobStore \
                    --numLines=5000 \
                    --lineLength=10 \
                    --overwriteOutput=True \
@@ -305,7 +286,7 @@
 with the ``--logLevel`` flag. For example, to only log ``CRITICAL`` level
 messages to the screen::
 
-   (venv) $ python3 sort.py file:jobStore \
+   $ python3 sort.py file:jobStore \
                 --logLevel=critical \
                 --overwriteOutput=True
 
@@ -331,7 +312,7 @@
 
 When we run the pipeline, Toil will show a detailed failure log with a traceback::
 
-   (venv) $ python3 sort.py file:jobStore
+   $ python3 sort.py file:jobStore
    ...
    ---TOIL WORKER OUTPUT LOG---
    ...
@@ -353,13 +334,13 @@
 failure, the job store is preserved so that the workflow can be restarted,
 starting from the previously failed jobs. We can restart the pipeline by running ::
 
-   (venv) $ python3 sort.py file:jobStore \
+   $ python3 sort.py file:jobStore \
                 --restart \
                 --overwriteOutput=True
 
 We can also change the number of times Toil will attempt to retry a failed job::
 
-   (venv) $ python3 sort.py file:jobStore \
+   $ python3 sort.py file:jobStore \
                 --retryCount 2 \
                 --restart \
                 --overwriteOutput=True
@@ -373,7 +354,7 @@
 
 ::
 
-    (venv) $ python3 sort.py file:jobStore \
+    $ python3 sort.py file:jobStore \
                  --restart \
                  --overwriteOutput=True
 
@@ -401,7 +382,7 @@
 
 #. Launch a cluster in AWS using the :ref:`launchCluster` command::
 
-        (venv) $ toil launch-cluster <cluster-name> \
+        $ toil launch-cluster <cluster-name> \
                      --clusterType kubernetes \
                      --keyPairName <AWS-key-pair-name> \
                      --leaderNodeType t2.medium \
@@ -412,13 +393,13 @@
 
 #. Copy ``helloWorld.py`` to the ``/tmp`` directory on the leader node using the :ref:`rsyncCluster` command::
 
-        (venv) $ toil rsync-cluster --zone us-west-2a <cluster-name> helloWorld.py :/tmp
+        $ toil rsync-cluster --zone us-west-2a <cluster-name> helloWorld.py :/tmp
 
    Note that the command requires defining the file to copy as well as the target location on the cluster leader node.
 
 #. Login to the cluster leader node using the :ref:`sshCluster` command::
 
-        (venv) $ toil ssh-cluster --zone us-west-2a <cluster-name>
+         $ toil ssh-cluster --zone us-west-2a <cluster-name>
 
    Note that this command will log you in as the ``root`` user.
 
@@ -439,7 +420,7 @@
 
 #. Use the :ref:`destroyCluster` command to destroy the cluster::
 
-        (venv) $ toil destroy-cluster --zone us-west-2a <cluster-name>
+        $ toil destroy-cluster --zone us-west-2a <cluster-name>
 
    Note that this command will destroy the cluster leader
    node and any resources created to run the job, including the S3 bucket.
@@ -457,7 +438,7 @@
 
 #. First launch a node in AWS using the :ref:`launchCluster` command::
 
-      (venv) $ toil launch-cluster <cluster-name> \
+      $ toil launch-cluster <cluster-name> \
                    --clusterType kubernetes \
                    --keyPairName <AWS-key-pair-name> \
                    --leaderNodeType t2.medium \
@@ -467,12 +448,12 @@
 #. Copy ``example.cwl`` and ``example-job.yaml`` from the :ref:`CWL example <cwlquickstart>` to the node using
    the :ref:`rsyncCluster` command::
 
-      (venv) $ toil rsync-cluster --zone us-west-2a <cluster-name> example.cwl :/tmp
-      (venv) $ toil rsync-cluster --zone us-west-2a <cluster-name> example-job.yaml :/tmp
+       toil rsync-cluster --zone us-west-2a <cluster-name> example.cwl :/tmp
+       toil rsync-cluster --zone us-west-2a <cluster-name> example-job.yaml :/tmp
 
 #. SSH into the cluster's leader node using the :ref:`sshCluster` utility::
 
-      (venv) $ toil ssh-cluster --zone us-west-2a <cluster-name>
+      $ toil ssh-cluster --zone us-west-2a <cluster-name>
 
 #. Once on the leader node, command line tools such as ``kubectl`` will be available to you. It's also a good idea to
    update and install the following::
@@ -503,7 +484,7 @@
 
 #. Finally, log out of the leader node and from your local computer, destroy the cluster::
 
-      (venv) $ toil destroy-cluster --zone us-west-2a <cluster-name>
+      $ toil destroy-cluster --zone us-west-2a <cluster-name>
 
 
 .. _awscactus:
@@ -543,7 +524,7 @@
 
 #. Launch a cluster using the :ref:`launchCluster` command::
 
-        (venv) $ toil launch-cluster <cluster-name> \
+        $ toil launch-cluster <cluster-name> \
                      --provisioner <aws, gce> \
                      --keyPairName <key-pair-name> \
                      --leaderNodeType <type> \
@@ -559,11 +540,11 @@
         When using AWS, setting the environment variable eliminates having to specify the ``--zone`` option
         for each command. This will be supported for GCE in the future. ::
 
-            (venv) $ export TOIL_AWS_ZONE=us-west-2c
+            $ export TOIL_AWS_ZONE=us-west-2c
 
 #. Create appropriate directory for uploading files::
 
-        (venv) $ toil ssh-cluster --provisioner <aws, gce> <cluster-name>
+        $ toil ssh-cluster --provisioner <aws, gce> <cluster-name>
         $ mkdir /root/cact_ex
         $ exit
 
@@ -572,18 +553,18 @@
    `here <https://github.com/ComparativeGenomicsToolkit/cactus#seqfile-the-input-file>`__), organisms' genome sequence
    files in FASTA format, and configuration files (e.g. blockTrim1.xml, if desired), up to the leader node::
 
-      (venv) $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> pestis-short-aws-seqFile.txt :/root/cact_ex
-      (venv) $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> GCF_000169655.1_ASM16965v1_genomic.fna :/root/cact_ex
-      (venv) $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> GCF_000006645.1_ASM664v1_genomic.fna :/root/cact_ex
-      (venv) $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> GCF_000182485.1_ASM18248v1_genomic.fna :/root/cact_ex
-      (venv) $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> GCF_000013805.1_ASM1380v1_genomic.fna :/root/cact_ex
-      (venv) $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> setup_leaderNode.sh :/root/cact_ex
-      (venv) $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> blockTrim1.xml :/root/cact_ex
-      (venv) $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> blockTrim3.xml :/root/cact_ex
+      $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> pestis-short-aws-seqFile.txt :/root/cact_ex
+      $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> GCF_000169655.1_ASM16965v1_genomic.fna :/root/cact_ex
+      $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> GCF_000006645.1_ASM664v1_genomic.fna :/root/cact_ex
+      $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> GCF_000182485.1_ASM18248v1_genomic.fna :/root/cact_ex
+      $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> GCF_000013805.1_ASM1380v1_genomic.fna :/root/cact_ex
+      $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> setup_leaderNode.sh :/root/cact_ex
+      $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> blockTrim1.xml :/root/cact_ex
+      $ toil rsync-cluster --provisioner <aws, gce> <cluster-name> blockTrim3.xml :/root/cact_ex
 
 #. Log in to the leader node::
 
-        (venv) $ toil ssh-cluster --provisioner <aws, gce> <cluster-name>
+        $ toil ssh-cluster --provisioner <aws, gce> <cluster-name>
 
 #. Set up the environment of the leader node to run Cactus::
 
