Broadband Release Info - Revision history

Fsilva at 21:06, 28 April 2014

2014-04-28T21:06:53Z

Fsilva at 17:42, 23 April 2014

2014-04-23T17:42:14Z

Fsilva: /* Create Distribution Files */

2014-04-23T17:31:50Z

Create Distribution Files

Fsilva at 16:14, 23 April 2014

2014-04-23T16:14:01Z

Fsilva at 15:12, 23 April 2014

2014-04-23T15:12:45Z

Fsilva: /* Generating Validation Events and Velocity Models Tar Files */

2014-04-23T15:01:49Z

Generating Validation Events and Velocity Models Tar Files

Fsilva at 22:21, 22 April 2014

2014-04-22T22:21:54Z

Fsilva at 22:21, 22 April 2014

2014-04-22T22:21:31Z

Fsilva at 22:12, 22 April 2014

2014-04-22T22:12:52Z

Fsilva: /* Unit Tests */

2014-04-22T22:01:55Z

Unit Tests

← Older revision		Revision as of 21:06, 28 April 2014
Line 132:		Line 132:

	VELMODEL_VERSION = 4-March-2014		VELMODEL_VERSION = 4-March-2014
		+
		+	== Tag Version on SVN ==
		+
		+	After making sure the latest versions of all files are committed to svn, you should create a svn tag with the release version. The svn command to use is:
		+
		+	$ svn copy -m "Tagged Broadband version 14.3.0" . https://source.usc.edu/svn/broadband/tags/Version_14_3_0_2014-03-31

	== Generating MD5 Sums ==		== Generating MD5 Sums ==

← Older revision		Revision as of 17:42, 23 April 2014
Line 185:		Line 185:
	canada1000-velocity-model-14.3.0.tar.gz		canada1000-velocity-model-14.3.0.tar.gz
	ceus1000-velocity-model-14.3.0.tar.gz		ceus1000-velocity-model-14.3.0.tar.gz
		+
		+	== Posting Distribution Files ==
		+
		+	BBP distribution files should be posted on hypocenter.usc.edu. Assuming we are releasing version 14.3.0, you should log into hypocenter.usc.edu, and then:
		+
		+	$ cd /var/www/html/research/bbp/versions
		+	$ mkdir 14.3.0
		+	$ cd 14.3.0
		+	$ touch index.html (to disable directory listing!)
		+
		+	Copy the source distribution and all validation/velocity model packages to this directory (often scp is needed for this). On the machine where the source distribution/other packages were created:
		+
		+	$ cd <where BBP source distribution is>
		+	$ scp bbp-14.3.0-23-apr-2014.tar.gz user@hypocenter.usc.edu:/var/www/html/research/bbp/versions/14.3.0/.
		+	$ cd <where validation/velocity model packages are>
		+	$ scp *-14.3.0.tar.gz hypocenter.usc.edu:/var/www/html/research/bbp/versions/14.3.0/.
		+
		+	Back on hypocenter.usc.edu, you will need to generate the md5 sums for all files using the following for loop:
		+
		+	$ for file in `ls \| grep tar.gz`; do md5sum $file > $file.md5; done;

← Older revision		Revision as of 17:31, 23 April 2014
Line 148:		Line 148:
	=== Generating Source Distribution Tar File ===		=== Generating Source Distribution Tar File ===

		+	To create the Broadband Platform source distribution tar file, you can use the 'create_source_dist.sh' script, located in the utils/dist directory of the Platform. The script will take an argument specifying the version number, and will create a tar file (without the .svn sub-directories) with the version number and date embedded in the filename. The script should run in the directory above where the "trunk" svn directory is.

		+	$ ./trunk/utils/dist/create_source_dist.sh 14.3.0
		+
		+	The output file will be named like "bbp-14.3.0-23-apr-2014.tar.gz"

	=== Generating Validation Events and Velocity Models Tar Files ===		=== Generating Validation Events and Velocity Models Tar Files ===

@@ Line 142: / Line 142: @@
 Note that running the script without the '-g' option, will cause it to check the previously stored MD5 sum values against the MD5 sum of the actual files in each of the validation/velocity model packages. It will print any discrepancies to the terminal window, signaling a file modification.
-== Generating Validation Events and Velocity Models Tar Files ==
+== Create Distribution Files ==
 In order to generate the tar files for all validation events and velocity model packages, you can use the 'make_packages_release.sh' script located in the utils/dist directory. The script assumes you have a directory somewhere (BBP_ROOT), where both 'bbp_val' and 'bbp_gf' subdirectories are located. The script takes a single parameter, the version number to add to all tar filenames. For example, the following commands:

@@ Line 12: / Line 12: @@
   $ ./UnitTests.py
-The tests take about 20 minutes to run, and after each test you should see an 'ok' message.
+The tests take about 10 minutes to run, and after each test you should see an 'ok' message. Here's a sample output for a successful test run:
 === Acceptance Tests ===

← Older revision		Revision as of 15:01, 23 April 2014
Line 110:		Line 110:

	== Generating Validation Events and Velocity Models Tar Files ==		== Generating Validation Events and Velocity Models Tar Files ==
		+
		+	In order to generate the tar files for all validation events and velocity model packages, you can use the 'make_packages_release.sh' script located in the utils/dist directory. The script assumes you have a directory somewhere (BBP_ROOT), where both 'bbp_val' and 'bbp_gf' subdirectories are located. The script takes a single parameter, the version number to add to all tar filenames. For example, the following commands:
		+
		+	$ cd $BBP_ROOT
		+	$ make_packages_release.sh 14.3.0
		+
		+	will generate all validation and velocity model packages for the 14.3.0 version of the platform:
		+
		+	gmpe-verification-14.3.0.tar.gz
		+	whittier-validation-14.3.0.tar.gz
		+	nr-validation-14.3.0.tar.gz
		+	nps-validation-14.3.0.tar.gz
		+	landers-validation-14.3.0.tar.gz
		+	lomap-validation-14.3.0.tar.gz
		+	niigata-validation-14.3.0.tar.gz
		+	tottori-validation-14.3.0.tar.gz
		+	rdl1k-validation-14.3.0.tar.gz
		+	saguenayhartzell1k-validation-14.3.0.tar.gz
		+	mineral-validation-14.3.0.tar.gz
		+	alum-rock-validation-14.3.0.tar.gz
		+	chino-hills-validation-14.3.0.tar.gz
		+	northridge-validation-14.3.0.tar.gz
		+	lomaprieta-validation-14.3.0.tar.gz
		+	labasin-velocity-model-14.3.0.tar.gz
		+	lomap-velocity-model-14.3.0.tar.gz
		+	mojave-velocity-model-14.3.0.tar.gz
		+	centraljapan-velocity-model-14.3.0.tar.gz
		+	westernjapan-velocity-model-14.3.0.tar.gz
		+	canada1000-velocity-model-14.3.0.tar.gz
		+	ceus1000-velocity-model-14.3.0.tar.gz

← Older revision		Revision as of 22:21, 22 April 2014
Line 1:		Line 1:
−	~~= Creating a New Broadband Platform Release =~~
−
	This page contains instructions for creating a release of the SCEC Broadband Platform software. A release consists of the main BBP source distribution, along with one or more region packages, containing GFs and region-specific parameters for each of the methods supported by the Platform, and optionally validation packages, which contain event specific data and can be used to run the Broadband Platform in validation mode.		This page contains instructions for creating a release of the SCEC Broadband Platform software. A release consists of the main BBP source distribution, along with one or more region packages, containing GFs and region-specific parameters for each of the methods supported by the Platform, and optionally validation packages, which contain event specific data and can be used to run the Broadband Platform in validation mode.

← Older revision		Revision as of 22:21, 22 April 2014
Line 101:		Line 101:

	VELMODEL_VERSION = 4-March-2014		VELMODEL_VERSION = 4-March-2014
		+
		+	== Generating MD5 Sums ==
		+
		+	Event validation packages and velocity model packages include a set of MD5 sums in order to help catch user modifications to the various input files provided to the Broadband Platform. In order to generate these MD5 sums before a BBP release, the user needs to use the following program:
		+
		+	$ cd checksums
		+	$ ./md5sum_check.py -g
		+
		+	Note that running the script without the '-g' option, will cause it to check the previously stored MD5 sum values against the MD5 sum of the actual files in each of the validation/velocity model packages. It will print any discrepancies to the terminal window, signaling a file modification.
		+
		+	== Generating Validation Events and Velocity Models Tar Files ==

← Older revision		Revision as of 22:12, 22 April 2014
Line 47:		Line 47:

	Note that, all acceptance tests have their 'xml' workflow already created in the 'ref_data' directory of the BBP distribution. When modifications are made to the top-level workflow builder script, or to the interface between modules (e.g. adding/removing parameters a module uses), it is necessary to recreate these 'xml' workflow description files. This can be easily done with the 'comps/gen_accept_tests.py' script.		Note that, all acceptance tests have their 'xml' workflow already created in the 'ref_data' directory of the BBP distribution. When modifications are made to the top-level workflow builder script, or to the interface between modules (e.g. adding/removing parameters a module uses), it is necessary to recreate these 'xml' workflow description files. This can be easily done with the 'comps/gen_accept_tests.py' script.
		+
		+	=== Full Validation Tests ===
		+
		+	The acceptance tests use a small number of stations to validate the codes inside the Broadband Platform. A more extensive test is to run a complete validation tests using a larger number of stations. The Broadband Platform is distributed with 2 validation packages that can be used to make sure everything is working properly. In order to run these validation simulations, users have to make sure they have all the needed dependencies installed on their computer. The Northridge event uses the LABasin velocity model package, and the LomaPrieta event uses the LOMAP velocity model package for Northern California. One important consideration is the time it takes to run some of these validation simulations. This is especially true for the GP, and SDSU methods, which may take up to 72 hours to run each of them. In these cases, it is recommended that the output of the platform is redirected to a log file:
		+
		+	$ cd comps
		+	$ ./run_bbp.py -l ~/northridge-gp-log.txt
		+	Welcome to the SCEC Broadband Platform.
		+	Please select the modules you want to run.
		+	Do you want to perform a validation run (y/n)? y
		+	Do you want to validate with:
		+	(1) Loma Prieta
		+	(2) Northridge
		+	? 2
		+	Choose a Method to use in a Broadband validation simulation:
		+	(1) GP (Graves & Pitarka)
		+	(2) GP Seis (GP precomp seismograms)
		+	(3) UCSB
		+	(4) SDSU
		+	(5) SDSU Seis (SDSU precomp seismograms)
		+	(6) EXSIM
		+	(7) Composite Source Model (CSM)
		+	(8) Irikura Recipe (Irikura)
		+	? 1
		+	Do you want to run a rupture generator (y/n)? y
		+	Do you want to provide a custom source file (y/n)? n
		+	Do you want to
		+	(1) run all validation stations
		+	(2) select a custom station list
		+	? 1
		+	Do you want to run the site response module (y/n)? y
		+	Do you want to plot velocity seismograms (y/n)? y
		+	Do you want to plot acceleration seismograms (y/n)? y
		+	Do you want to generate a GMPE comparison plot (y/n)? y
		+	Choose a Goodness of Fit (GOF) Module:
		+	(1) GP
		+	(2) SDSU
		+	(3) Both
		+	(4) None
		+	? 1
		+	^Z
		+	[1]+ Stopped ./run_bbp.py -l ~/northridge-gp-log.txt
		+	$ bg
		+	[1]+ ./run_bbp.py -l ~/northridge-gp-log.txt &
		+
		+	Note that after selecting the GOF module, the simulation starts and the user puts the process in background by hitting "CTRL-Z" and then typing 'bg' at the shell.

	== Update Build Version ==		== Update Build Version ==