Merging setup

index.html

@@ -264,6 +264,11 @@ <h3>Managing Data with SQL</h3>
 
 <h2 id="setup">Setup</h2>
 
+<p>
+  <a href="test-setup.html">This page</a> has instructions on testing
+  that you have the right software installed.
+</p>
+
 <div> <!-- Start of 'editor' section. -->
   <h3>Text Editor</h3>
 

test-setup.md

@@ -0,0 +1,97 @@
+---
+layout: page
+title: Testing Setup
+---
+Learners
+--------
+
+This directory contains scripts for testing your machine to make sure
+you have the software you'll need for your workshop installed.  The
+comments at the head of each script have full details, but in brief,
+you should be able to:
+
+1.  Download [test-setup-minimal.py](util/test-setup-minimal.py).
+
+2.  Run it from the shell by typing:
+
+    ~~~
+    $ python test-install-minimal.py
+    Passed
+    ~~~
+
+3.  Download [test-setup-all.py](util/test-setup-all.py).
+
+4.  Run it from the shell by typing:
+
+    ~~~
+    $ python test-install-all.py
+    check virtual-shell...  pass
+    ...
+    Successes:
+
+    virtual-shell Bourne Again Shell (bash) 4.2.37
+    ...
+    ~~~
+
+If you see something like:
+
+~~~
+$ python test-install-all.py
+check virtual-shell...  fail
+...
+check for command line shell (virtual-shell) failed:
+  command line shell (virtual-shell) requires at least one of the following dependencies
+  For instructions on installing an up-to-date version, see
+  http://software-carpentry.org/setup/
+  causes:
+  check for Bourne Again Shell (bash) failed:
+    could not find 'bash' executable for Bourne Again Shell (bash)
+    For instructions on installing an up-to-date version, see
+    http://software-carpentry.org/setup/
+...
+~~~
+
+follow the suggestions to try and install any missing software.  For
+additional troubleshooting information, you can use the `--verbose`
+option:
+
+~~~
+$ python test-install-all.py --verbose
+check virtual-shell...  fail
+...
+==================
+System information
+==================
+os.name            : posix
+...
+~~~
+
+Instructors
+-----------
+
+`test-install-minimal.py` is pretty simple, and just checks that the
+students have a recent enough version of Python installed that they'll
+be able to parse `test-install-all.py`.  The latter checks for a list
+of dependencies and prints error messages if a package is not
+installed, or if the installed version is not current enough.  By
+default, the script checks for pretty much anything that has ever been
+used at a Software Carpentry workshop, which is probably not what you
+want for your particular workshop.
+
+Before your workshop, you should go through `test-install-all.py` and
+comment any dependencies you don't need out of the `CHECKS` list.  You
+might also want to skim through the minimum version numbers listed
+where particular dependencies are defined (e.g. `('git', 'Git', (1, 7,
+0), None)`).  For the most part, fairly conservative values have been
+selected, so students with modern machines should be fine.  If your
+workshop has stricter version requirements, feel free to bump them
+accordingly.
+
+Similarly, the virtual dependencies can be satisfied by any of several
+packages.  If you don't want to support a particular package (e.g. if
+you have no Emacs experience and don't want to be responsible for
+students who show up with Emacs as their only editor), you can comment
+out that particular `or_dependency`.
+
+Finally, don't forget to post your modified scripts somewhere where
+your students can download them!