CyberShake Hazard Calculation - Revision history

Kmilner at 23:17, 7 March 2016

2016-03-07T23:17:17Z

Kmilner: /* Disaggregation Calculation */

2016-03-07T23:08:21Z

Disaggregation Calculation

Kmilner: /* Disaggregation Calculation */

2016-03-07T23:07:57Z

Disaggregation Calculation

Kmilner at 23:04, 7 March 2016

2016-03-07T23:04:30Z

Kmilner at 22:56, 7 March 2016

2016-03-07T22:56:16Z

Kmilner at 22:37, 7 March 2016

2016-03-07T22:37:16Z

Kmilner at 22:26, 7 March 2016

2016-03-07T22:26:13Z

Kmilner at 22:15, 7 March 2016

2016-03-07T22:15:35Z

Kmilner: Created page with "= CyberShake Hazard Curve/Disaggregation Calculation = == Common Setup == The tools mentioned below are part of the OpenSHA platform (www.opensha.org). The easiest way to ob..."

2016-03-07T22:15:21Z

Created page with "= CyberShake Hazard Curve/Disaggregation Calculation = == Common Setup == The tools mentioned below are part of the OpenSHA platform (www.opensha.org). The easiest way to ob..."

New page

= CyberShake Hazard Curve/Disaggregation Calculation =

== Common Setup ==

The tools mentioned below are part of the OpenSHA platform (www.opensha.org). The easiest way to obtain the code needed for these tools is to download the complete OpenSHA jar file nightly build from here:

[http://opensha.usc.edu/dev/opensha-complete/nightly/opensha-complete.jar OpenSHA_complete.jar nightly build]

@@ Line 1: / Line 1: @@
 = CyberShake Hazard Curve/Disaggregation Calculation =
-Note: this wiki entry assumes basic familiarity with the CyberShake database including finding CyberShake Run IDs of interest for a given CyberShake Study
+Note: this wiki entry assumes basic familiarity with the CyberShake database including finding CyberShake Run IDs of interest for a given CyberShake Study. For information on various studies see [[Comparison of CyberShake Studies]].
 == Common Setup ==

@@ Line 96: / Line 96: @@
         <arg>] [-R <arg>] [-s <arg>] [-sgt <arg>] [-t <arg>] [-vel <arg>]
   -?,--help                   Display this message
   -cmp,--component <arg>      Intensity measure component. Options: GEOM,X,Y,RotD100,RotD50, Default: GEOM
   -e,--erf-id <arg>           ERF ID

← Older revision		Revision as of 23:07, 7 March 2016
Line 118:		Line 118:
	</pre>		</pre>

−	You can also include GMPE comparisons which will plot to separate files using the same --~~erf~~-file ~~and~~ --~~atten-rel~~-file ~~arguments~~ as ~~before~~.	+	You can also include GMPE comparisons which will plot to separate files using the same --atten-rel-file argument as before. The --erf-file argument is not needed (or supported) as the correct ERF was already instantiated in the code to perform CyberShake disaggregation.

← Older revision		Revision as of 23:04, 7 March 2016
Line 85:		Line 85:
	--erf-file /path/to/MeanUCERF.xml --atten-rel-file /path/to/cb2008.xml,/path/to/ba2008.xml,/path/to/cy2008.xml,/path/to/as2008.xml		--erf-file /path/to/MeanUCERF.xml --atten-rel-file /path/to/cb2008.xml,/path/to/ba2008.xml,/path/to/cy2008.xml,/path/to/as2008.xml
	</pre>		</pre>
		+
		+	== Disaggregation Calculation ==
		+
		+	Syntax for the disaggregation calculator is similar to the Hazard Curve Calculator above and is located at org.opensha.sha.cybershake.plot.DisaggregationPlotter:
		+
		+	<pre>
		+	java -cp opensha-complete.jar org.opensha.sha.cybershake.plot.DisaggregationPlotter --help
		+	usage: DisaggregationPlotter [-?] [-cmp <arg>] [-e <arg>] [-i <arg>]
		+	[-imid <arg>] [-imt <arg>] [-o <arg>] [-p <arg>] [-pr <arg>] [-r
		+	<arg>] [-R <arg>] [-s <arg>] [-sgt <arg>] [-t <arg>] [-vel <arg>]
		+	-?,--help Display this message
		+	-cmp,--component <arg> Intensity measure component. Options: GEOM,X,Y,RotD100,RotD50, Default: GEOM
		+	-e,--erf-id <arg> ERF ID
		+	-i,--imls <arg> Intensity Measure Levels (IMLs) to disaggregate at. Multiple IMLs should be comma separated.
		+	-imid,--im-type-id <arg> Intensity measure type ID. If not supplied, will be detected from im type/component/period parameters
		+	-imt,--im-type <arg> Intensity measure type. Options: SA, Default: SA
		+	-o,--output-dir <arg> Output directory
		+	-p,--period <arg> Period(s) to calculate. Multiple periods should be comma separated (default: 3)
		+	-pr,--probs <arg> Probabilities (1 year) to disaggregate at. Multiple probabilities should be comma separated.
		+	-r,--rv-id <arg> Rupture Variation ID
		+	-R,--run-id <arg> Run ID
		+	-s,--site <arg> Site short name
		+	-sgt,--sgt-var-id <arg> STG Variation ID
		+	-t,--type <arg> Plot save type. Options are png, pdf, and txt. Multiple types can be comma separated (default is pdf)
		+	-vel,--vel-model-id <arg> Velocity Model ID
		+	</pre>
		+
		+	Here is an example for the same run as before:
		+
		+	<pre>
		+	java -cp opensha-complete.jar org.opensha.sha.cybershake.plot.DisaggregationPlotter --run-id 4498 --period 3,5,10 --output-dir /tmp/test_disagg --probs 4e-4 --type pdf,png,txt --cmp RotD50
		+	</pre>
		+
		+	You can also include GMPE comparisons which will plot to separate files using the same --erf-file and --atten-rel-file arguments as before.

@@ Line 1: / Line 1: @@
 = CyberShake Hazard Curve/Disaggregation Calculation =
 == Common Setup ==
@@ Line 5: / Line 7: @@
 The tools mentioned below are part of the OpenSHA platform (http://www.opensha.org). The easiest way to obtain the code needed for these tools is to download the complete OpenSHA jar file nightly build from here:
-[http://opensha.usc.edu/dev/opensha-complete/nightly/opensha-complete.jar OpenSHA_complete.jar nightly build]
+[http://opensha.usc.edu/dev/opensha-complete/nightly/opensha-complete.jar opensha-complete.jar nightly build]
 You can also obtain the source code directly and compile it yourself, either via an ant build script or via eclipse. For details on this approach, see http://opensha.usc.edu/trac/wiki/SettingUpEclipse
@@ Line 13: / Line 15: @@
 === Running OpenSHA on the command line ===
-Assuming that OpenSHA_complete.jar is in the current directory, the following command can be used to run the fictional java class org.opensha.Test:
+Assuming that opensha-complete.jar is in the current directory, the following command can be used to run the fictional java class org.opensha.Test:
 <pre>
@@ Line 22: / Line 24: @@
 <pre>
-java -Dcybershake.db.host="my.server.come" -Dcybershake.db.name="CyberShake" -cp OpenSHA_complete.jar org.opensha.Test
+java -Dcybershake.db.host="my.server.com" -Dcybershake.db.name="CyberShake" -cp OpenSHA_complete.jar org.opensha.Test
 </pre>
@@ Line 30: / Line 32: @@
 <pre>
-kevin@steel:/tmp$ java -cp OpenSHA_complete.jar org.opensha.sha.cybershake.plot.HazardCurvePlotter --help
+java -cp opensha-complete.jar org.opensha.sha.cybershake.plot.HazardCurvePlotter --help
 usage: HazardCurvePlotter [-?] [-af <arg>] [-benchmark] [-c] [-cmp <arg>]
         [-comp <arg>] [-cvmvs] [-e <arg>] [-ef <arg>] [-f] [-fvs <arg>] [-h
@@ Line 68: / Line 70: @@
 </pre>
-Many arguments are optional but the important ones are as follows:
+The GMPE comparisons mentioned in the above options use XML configuration files that can be downloaded from [http://source.usc.edu/svn/opensha/trunk/src/org/opensha/sha/cybershake/conf/ here].
-* '''--run-id''': This argument supplies the CyberShake Run_ID, identifying a unique run of the CyberShake platform. This is the best way to specify a CyberShake dataset of interest, but you can also supply a combination of the --site, --sgt-var-id, --rv-id, and --vel-model-id options to dynamically search for
+If you want to include GMPE comparison hazard curves, first download XML descriptions of the models you wish to use from [http://source.usc.edu/svn/opensha/trunk/src/org/opensha/sha/cybershake/conf/ here]. Then add the following options:
 <pre>
---run-id 4498
+--erf-file /path/to/MeanUCERF.xml --atten-rel-file /path/to/cb2008.xml,/path/to/ba2008.xml,/path/to/cy2008.xml,/path/to/as2008.xml
 </pre>

@@ Line 8: / Line 8: @@
 You can also obtain the source code directly and compile it yourself, either via an ant build script or via eclipse. For details on this approach, see http://opensha.usc.edu/trac/wiki/SettingUpEclipse
 == Hazard Curve Calculation ==
@@ Line 13: / Line 29: @@
 Hazard curve calculation/plotting is done via the org.opensha.sha.cybershake.plot.HazardCurvePlotter OpenSHA class. Here is the usage:
-<code>
+<pre>
 kevin@steel:/tmp$ java -cp OpenSHA_complete.jar org.opensha.sha.cybershake.plot.HazardCurvePlotter --help
 usage: HazardCurvePlotter [-?] [-af <arg>] [-benchmark] [-c] [-cmp <arg>]
@@ Line 50: / Line 66: @@
   -vel,--vel-model-id <arg>            Velocity Model ID
   -w,--width <arg>                     Plot width (default = 600)
-</code>
+</pre>

← Older revision		Revision as of 22:26, 7 March 2016
Line 6:		Line 6:

	[http://opensha.usc.edu/dev/opensha-complete/nightly/opensha-complete.jar OpenSHA_complete.jar nightly build]		[http://opensha.usc.edu/dev/opensha-complete/nightly/opensha-complete.jar OpenSHA_complete.jar nightly build]
		+
		+	You can also obtain the source code directly and compile it yourself, either via an ant build script or via eclipse. For details on this approach, see http://opensha.usc.edu/trac/wiki/SettingUpEclipse
		+
		+	== Hazard Curve Calculation ==
		+
		+	Hazard curve calculation/plotting is done via the org.opensha.sha.cybershake.plot.HazardCurvePlotter OpenSHA class. Here is the usage:
		+
		+	<code>
		+	kevin@steel:/tmp$ java -cp OpenSHA_complete.jar org.opensha.sha.cybershake.plot.HazardCurvePlotter --help
		+	usage: HazardCurvePlotter [-?] [-af <arg>] [-benchmark] [-c] [-cmp <arg>]
		+	[-comp <arg>] [-cvmvs] [-e <arg>] [-ef <arg>] [-f] [-fvs <arg>] [-h
		+	<arg>] [-imid <arg>] [-imt <arg>] [-n] [-novm] [-o <arg>] [-p
		+	<arg>] [-pf <arg>] [-pl <arg>] [-R <arg>] [-r <arg>] [-s <arg>]
		+	[-sgt <arg>] [-sgtsym] [-t <arg>] [-v <arg>] [-vel <arg>] [-w
		+	<arg>]
		+	-?,--help Display this message
		+	-af,--atten-rel-file <arg> XML Attenuation Relationship description file(s) for comparison. Multiple files should be comma separated
		+	-benchmark,--benchmark-test-recalc Forces recalculation of hazard curves to test calculation speed. Newly recalculated curves are not kept and the original curves are plotted.
		+	-c,--calc-only Only calculate and insert the CyberShake curves, don't make plots. If a curve already exists, it will be skipped.
		+	-cmp,--component <arg> Intensity measure component. Options: GEOM,X,Y,RotD100,RotD50, Default: GEOM
		+	-comp,--compare-to <arg> Compare to aspecific Run ID (or multiple IDs, comma separated)
		+	-cvmvs,--cvm-vs30 Option to use Vs30 value from the velocity model itself in GMPE calculations rather than, for example, the Wills 2006 value.
		+	-e,--erf-id <arg> ERF ID
		+	-ef,--erf-file <arg> XML ERF description file for comparison
		+	-f,--force-add Flag to add curves to db without prompt
		+	-fvs,--force-vs30 <arg> Option to force the given Vs30 value to be used in GMPE calculations.
		+	-h,--height <arg> Plot height (default = 500)
		+	-imid,--im-type-id <arg> Intensity measure type ID. If not supplied, will be detected from im type/component/period parameters
		+	-imt,--im-type <arg> Intensity measure type. Options: SA, Default: SA
		+	-n,--no-add Flag to not automatically calculate curves not in the database
		+	-novm,--no-vm-colors Disables Velocity Model coloring
		+	-o,--output-dir <arg> Output directory
		+	-p,--period <arg> Period(s) to calculate. Multiple periods should be comma separated (default: 3)
		+	-pf,--password-file <arg> Path to a file that contains the username and password for inserting curves into the database. Format should be "user:pass"
		+	-pl,--plot-chars-file <arg> Specify the path to a plot characteristics XML file
		+	-R,--run-id <arg> Run ID
		+	-r,--rv-id <arg> Rupture Variation ID
		+	-s,--site <arg> Site short name
		+	-sgt,--sgt-var-id <arg> STG Variation ID
		+	-sgtsym,--sgt-colors Enables SGT specific symbols
		+	-t,--type <arg> Plot save type. Options are png, pdf, jpg, and txt. Multiple types can be comma separated (default is pdf)
		+	-v,--vs30 <arg> Specify default Vs30 for sites with no Vs30 data, or leave blank for default value. Otherwise, you will be prompted to enter vs30 interactively if needed.
		+	-vel,--vel-model-id <arg> Velocity Model ID
		+	-w,--width <arg> Plot width (default = 600)
		+	</code>