fix --help output, add --help to tests, update docs

latex/tools.tex

@@ -194,6 +194,8 @@ \subsection{TauP\_Time}
 --time             -- only output travel time
 --rel phasename    -- also output relative travel time
 
+--json             -- output travel times as json
+
 -o [stdout|outfile]         -- output is redirected to stdout or to the "outfile" file
 --debug             -- enable debugging output
 --verbose           -- enable verbose output
@@ -690,6 +692,8 @@ \subsection{TauP\_Console}
 TauP\_Console is an instance of the Jython, http://www.jython.org, interpreter with the TauP classes
 preloaded along with some helper functionality. This allows python scripting with TauP.
 
+Note, to make the distribution smaller, TauP\_Console is no longer compiled as the Jython jar was large. It is included in the source in the src/extras directory and also requires the jython jar.
+
 The usage is:
 \begin{verbatim}
 taup_console [scriptfile]

src/main/java/edu/sc/seis/TauP/TauP_Time.java

@@ -1523,7 +1523,8 @@ public void printUsage() {
         printStdUsage();
         Alert.info("--rayp             -- only output the ray parameter\n"
                  + "--time             -- only output travel time\n"
-                 + "--rel phasename    -- also output relative travel time");
+                 + "--rel phasename    -- also output relative travel time\n\n"
+                 + "--json             -- output travel times as json\n");
         printStdUsageTail();
     }
 

src/test/java/edu/sc/seis/TauP/CmdLineOutputTest.java

@@ -46,6 +46,14 @@ public class CmdLineOutputTest {
                                            "taup_curve -o stdout -h 10 -ph P",
                                            "taup_curve -o stdout -h 10 -ph P -mod ak135"};
 
+    String[] helpTestCmds = new String[] {"taup_time --help",
+                                          "taup_pierce --help",
+                                          "taup_path --help",
+                                          "taup_curve --help",
+                                          "taup_wavefront --help",
+                                          "taup_table --help",
+                                          "taup_create --help"};
+
 
     /** disable unless regenerating the cmd line output test resources. 
      * new text files will be in cmdLineTest in cwd
@@ -55,6 +63,7 @@ public class CmdLineOutputTest {
     // @Test
     public void testSaveOutput() throws Exception {
         List<String> allList = new ArrayList<String>();
+        allList.addAll(Arrays.asList(helpTestCmds));
         allList.addAll(Arrays.asList(timeTestCmds));
         allList.addAll(Arrays.asList(pierceTestCmds));
         allList.addAll(Arrays.asList(pathTestCmds));
@@ -73,7 +82,7 @@ public void testSaveOutput() throws Exception {
      */
      // @Test
     public void testSaveOutputSingle() throws Exception {
-        saveOutputToFile(timeTestCmds[6]);
+        saveOutputToFile(helpTestCmds[0]);
     }
 
     @Test

src/test/resources/edu/sc/seis/TauP/cmdLineTest/taup_create_--help

@@ -0,0 +1,18 @@
+TauP_Create starting...
+Usage: taup_create [arguments]
+  or, for purists, java edu.sc.seis.TauP.TauP_Create [arguments]
+
+Arguments are:
+
+   To specify the velocity model:
+-nd modelfile       -- "named discontinuities" velocity file
+-tvel modelfile     -- ".tvel" velocity file, ala ttimes
+
+--vplot file.gmt     -- plot velocity as a GMT script
+
+-debug              -- enable debugging output
+-verbose            -- enable verbose output
+-version            -- print the version
+-help               -- print this out, but you already know that!
+
+

src/test/resources/edu/sc/seis/TauP/cmdLineTest/taup_curve_--help

@@ -0,0 +1,26 @@
+Usage: taup_curve [arguments]
+  or, for purists, java edu.sc.seis.TauP.TauP_Curve [arguments]
+
+Arguments are:
+-ph phase list     -- comma separated phase list
+-pf phasefile      -- file containing phases
+
+-mod[el] modelname -- use velocity model "modelname" for calculations
+                      Default is iasp91.
+
+-h depth           -- source depth in km
+
+
+--gmt              -- outputs curves as a complete GMT script.
+-reddeg velocity   -- outputs curves with a reducing velocity (deg/sec).
+-redkm velocity    -- outputs curves with a reducing velocity (km/sec).
+-rel phasename     -- outputs relative travel time
+--mapwidth width   -- sets map width for GMT script.
+
+-o outfile         -- output is redirected to "outfile" instead of taup_curve.gmt
+--debug            -- enable debugging output
+--verbose          -- enable verbose output
+--version          -- print the version
+--help             -- print this out, but you already know that!
+
+

src/test/resources/edu/sc/seis/TauP/cmdLineTest/taup_path_--help

@@ -0,0 +1,37 @@
+Usage: taup_path [arguments]
+  or, for purists, java edu.sc.seis.TauP.TauP_Path [arguments]
+
+Arguments are:
+-ph phase list     -- comma separated phase list
+-pf phasefile      -- file containing phases
+
+-mod[el] modelname -- use velocity model "modelname" for calculations
+                      Default is iasp91.
+
+-h depth           -- source depth in km
+
+--stadepth depth   -- receiver depth in km
+
+Distance is given by:
+
+-deg degrees       -- distance in degrees,
+-km kilometers     -- distance in kilometers,
+                      assumes radius of earth is 6371km,
+
+or by giving the station and event latitude and lonitude,
+                      assumes a spherical earth,
+
+-sta[tion] lat lon -- sets the station latitude and longitude
+-evt       lat lon -- sets the event latitude and longitude
+
+
+--gmt             -- outputs path as a complete GMT script.
+--svg             -- outputs path as a complete SVG file.
+--mapwidth        -- sets map width for GMT script.
+
+-o [stdout|outfile]         -- output is redirected to stdout or to the "outfile" file
+--debug             -- enable debugging output
+--verbose           -- enable verbose output
+--version           -- print the version
+--help              -- print this out, but you already know that!
+

src/test/resources/edu/sc/seis/TauP/cmdLineTest/taup_pierce_--help

@@ -0,0 +1,52 @@
+Usage: taup_pierce [arguments]
+  or, for purists, java edu.sc.seis.TauP.TauP_Pierce [arguments]
+
+Arguments are:
+-ph phase list     -- comma separated phase list
+-pf phasefile      -- file containing phases
+
+-mod[el] modelname -- use velocity model "modelname" for calculations
+                      Default is iasp91.
+
+-h depth           -- source depth in km
+
+--stadepth depth   -- receiver depth in km
+
+Distance is given by:
+
+-deg degrees       -- distance in degrees,
+-km kilometers     -- distance in kilometers,
+                      assumes radius of earth is 6371km,
+
+or by giving the station and event latitude and lonitude,
+                      assumes a spherical earth,
+
+-sta[tion] lat lon -- sets the station latitude and longitude
+-evt       lat lon -- sets the event latitude and longitude
+
+
+-az azimuth        -- sets the azimuth (event to station)
+                      used to output lat and lon of pierce points
+                      if the event lat lon and distance are also
+                      given. Calculated if station and event
+                      lat and lon are given.
+-baz backazimuth   -- sets the back azimuth (station to event)
+                      used to output lat and lon of pierce points
+                      if the station lat lon and distance are also
+                      given. Calculated if station and event
+                      lat and lon are given.
+
+-rev               -- only prints underside and bottom turn points, e.g. ^ and v
+-turn              -- only prints bottom turning points, e.g. v
+-under             -- only prints underside reflection points, e.g. ^
+
+-pierce depth      -- adds depth for calculating pierce points
+-nodiscon          -- only prints pierce points for the depths added with -pierce
+
+
+-o [stdout|outfile]         -- output is redirected to stdout or to the "outfile" file
+--debug             -- enable debugging output
+--verbose           -- enable verbose output
+--version           -- print the version
+--help              -- print this out, but you already know that!
+

src/test/resources/edu/sc/seis/TauP/cmdLineTest/taup_table_--help

@@ -0,0 +1,24 @@
+Usage: taup_table [arguments]
+  or, for purists, java edu.sc.seis.TauP.TauP_Table [arguments]
+
+Arguments are:
+-ph phase list     -- comma separated phase list
+-pf phasefile      -- file containing phases
+
+-mod[el] modelname -- use velocity model "modelname" for calculations
+                      Default is iasp91.
+
+
+-header filename   -- reads depth and distance spacing data
+                      from a LOCSAT style file.
+-generic           -- outputs a "generic" ascii table
+
+-locsat            -- outputs a "locsat" style ascii table
+
+
+-o [stdout|outfile]         -- output is redirected to stdout or to the "outfile" file
+--debug             -- enable debugging output
+--verbose           -- enable verbose output
+--version           -- print the version
+--help              -- print this out, but you already know that!
+

src/test/resources/edu/sc/seis/TauP/cmdLineTest/taup_time_--help

@@ -0,0 +1,40 @@
+Usage: taup_time [arguments]
+  or, for purists, java edu.sc.seis.TauP.TauP_Time [arguments]
+
+Arguments are:
+-ph phase list     -- comma separated phase list
+-pf phasefile      -- file containing phases
+
+-mod[el] modelname -- use velocity model "modelname" for calculations
+                      Default is iasp91.
+
+-h depth           -- source depth in km
+
+--stadepth depth   -- receiver depth in km
+
+Distance is given by:
+
+-deg degrees       -- distance in degrees,
+-km kilometers     -- distance in kilometers,
+                      assumes radius of earth is 6371km,
+
+or by giving the station and event latitude and lonitude,
+                      assumes a spherical earth,
+
+-sta[tion] lat lon -- sets the station latitude and longitude
+-evt       lat lon -- sets the event latitude and longitude
+
+
+--rayp             -- only output the ray parameter
+--time             -- only output travel time
+--rel phasename    -- also output relative travel time
+
+--json             -- output travel times as json
+
+
+-o [stdout|outfile]         -- output is redirected to stdout or to the "outfile" file
+--debug             -- enable debugging output
+--verbose           -- enable verbose output
+--version           -- print the version
+--help              -- print this out, but you already know that!
+

src/test/resources/edu/sc/seis/TauP/cmdLineTest/taup_wavefront_--help

@@ -0,0 +1,38 @@
+Usage: taup_wavefront [arguments]
+  or, for purists, java edu.sc.seis.TauP.TauP_Wavefront [arguments]
+
+Arguments are:
+-ph phase list     -- comma separated phase list
+-pf phasefile      -- file containing phases
+
+-mod[el] modelname -- use velocity model "modelname" for calculations
+                      Default is iasp91.
+
+-h depth           -- source depth in km
+
+--stadepth depth   -- receiver depth in km
+
+Distance is given by:
+
+-deg degrees       -- distance in degrees,
+-km kilometers     -- distance in kilometers,
+                      assumes radius of earth is 6371km,
+
+or by giving the station and event latitude and lonitude,
+                      assumes a spherical earth,
+
+-sta[tion] lat lon -- sets the station latitude and longitude
+-evt       lat lon -- sets the event latitude and longitude
+
+
+--rays  num      -- number of raypaths/distances to sample.
+--timestep  num  -- steps in time (seconds) for output.
+--timefiles      -- outputs each time into a separate .ps file within the gmt script.
+--negdist        -- outputs negative distance as well so wavefronts are in both halves.
+
+-o [stdout|outfile]         -- output is redirected to stdout or to the "outfile" file
+--debug             -- enable debugging output
+--verbose           -- enable verbose output
+--version           -- print the version
+--help              -- print this out, but you already know that!
+