Broadband User Guide v14.3.0 - Revision history

Fsilva: /* Installing the Broadband Platform */

2014-05-22T21:44:01Z

Installing the Broadband Platform

Fsilva: /* Installing the Broadband Platform */

2014-05-22T21:41:58Z

Installing the Broadband Platform

Fsilva: /* Installing the Broadband Platform */

2014-05-22T21:41:42Z

Installing the Broadband Platform

Fsilva: /* Running the Tests */

2014-05-09T18:29:01Z

Running the Tests

Fsilva: /* Running Acceptance Tests */

2014-05-09T18:25:20Z

Running Acceptance Tests

Fsilva: /* Running Unit Tests */

2014-05-09T18:23:59Z

Running Unit Tests

Fsilva: /* Downloading the Platform */

2014-05-09T16:39:19Z

Downloading the Platform

Fsilva: /* Downloading the Platform */

2014-05-09T16:38:15Z

Downloading the Platform

Fsilva: /* Downloading the Platform */

2014-05-09T16:35:02Z

Downloading the Platform

Fsilva: Created page with ''''Version 14.3.0''' If you find errors in this document or sections to be unclear, please contact software@scec.org. If possible, please send a description of how to reproduce …'

2014-03-27T21:53:31Z

Created page with ''''Version 14.3.0''' If you find errors in this document or sections to be unclear, please contact software@scec.org. If possible, please send a description of how to reproduce …'

Show changes

@@ Line 4: / Line 4: @@
 = Installing the Broadband Platform =
-Installing the Broadband Platform involves obtaining a copy of the code and building the required executables. You can either download the platform from the  [http://scec.usc.edu/scecpedia/Broadband_Platform Broadband web site] or check the code out of SCEC's Subversion repository. Most users should download the platform.
+Installing the Broadband Platform involves obtaining a copy of the code and building the required executables. You can either download the platform from the  [http://scec.usc.edu/scecpedia/Broadband_Platform#Current_Broadband_Platform_Release Broadband web site] or check the code out of SCEC's Subversion repository. Most users should download the platform.
 == System Dependencies ==

@@ Line 4: / Line 4: @@
 = Installing the Broadband Platform =
-Installing the Broadband Platform involves obtaining a copy of the code and building the required executables. You can either download the platform from the  ([http://scec.usc.edu/scecpedia/Broadband_Platform Broadband web site]) or check the code out of SCEC's Subversion repository. Most users should download the platform.
+Installing the Broadband Platform involves obtaining a copy of the code and building the required executables. You can either download the platform from the  [http://scec.usc.edu/scecpedia/Broadband_Platform Broadband web site] or check the code out of SCEC's Subversion repository. Most users should download the platform.
 == System Dependencies ==

@@ Line 4: / Line 4: @@
 = Installing the Broadband Platform =
-Installing the Broadband Platform involves obtaining a copy of the code and building the required executables. You can either download the platform from the Broadband web site ([http://www.scec.org/research/broadband http://www.scec.org/research/broadband]) or check the code out of SCEC's Subversion repository. Most users should download the platform.
+Installing the Broadband Platform involves obtaining a copy of the code and building the required executables. You can either download the platform from the  ([http://scec.usc.edu/scecpedia/Broadband_Platform Broadband web site]) or check the code out of SCEC's Subversion repository. Most users should download the platform.
 == System Dependencies ==

@@ Line 226: / Line 226: @@
 = Running the Tests =
-The Broadband Platform contains three kinds of tests. The checksum tests verify that the data files were copied correctly and you have all the files that are expected. Unit tests run each module using a set of input files, and compare the results against known outputs. They verify that each module has been built and is working correctly. Acceptance tests verify that the modules are working correctly together. They test the Platform end-to-end using different combinations with known inputs and compare the results. Each method (for both user-defined and validation events) are tested as checks against integration errors. Both unit and acceptance tests require the LABasin Greens' Functions package to be installed.
+The Broadband Platform contains three kinds of tests. The checksum tests verify that the data files were copied correctly and you have all the files that are expected. Unit tests run each module using a set of input files, and compare the results against known outputs. They verify that each module has been built and is working correctly. Acceptance tests verify that the modules are working correctly together. They test the Platform end-to-end using different combinations with known inputs and compare the results. Each method (for both user-defined and validation events) are tested as checks against integration errors. Both unit and acceptance tests require the LABasin Greens' Functions package to be installed. The acceptance tests also require users to install the Northridge validation package.
 == Running Checksum Tests ==

@@ Line 259: / Line 259: @@
 There will be one test for each method in the platform, for both the validation mode (historical events) and the scenario modes (hypotethical earthquakes). These tests will take somewhere between 2 and 3 hours to run, depending on how fast the computer is.
-When they're complete, the console will either print "OK" or how many tests failed. Acceptance test failures indicate that the modules are not integrated correctly. Like with the unit tests, verify that you have the ref_data directory.  If a certain acceptance test fails, you can get more information by consulting the acceptance test logs in $BBP_DATA_DIR/logs/acceptance_tests_logs/<test that failed>.log .  If you can't determine the reason for the failure, contact [mailto:software@scec.org support].
+When they're complete, the console will either print "OK" or how many tests failed. Acceptance test failures indicate that the modules are not integrated correctly. Like with the unit tests, verify that you have the ref_data directory.  If a certain acceptance test fails, you can get more information by consulting the acceptance test logs in $BBP_DATA_DIR/logs/acceptance_test_logs/<test that failed>.log .  If you can't determine the reason for the failure, contact [mailto:software@scec.org support].
 Since the acceptance tests can take a long time to run, you may wish to resume where you left off. This feature is supported automatically. If you do not wish to resume, delete the resume file in $BBP_DATA_DIR/logs/resume.txt. If there are any failure or errors while running the acceptance tests, consult the Troubleshooting section at the end of this user guide for known issues and their solutions.

@@ Line 246: / Line 246: @@
 The tests should begin and will take approximately 30 minutes to run. At the end of each test, a "ok" should be printed if the test was
-successful. At the end, the program will print the number of tests that passed and the number of tests that failed. If a test has failed, first check that you have built the executables.You can rerun just the specific test that failed (test_<module>.py). If the test is still failing, also verify that you have the ref_data directory, since it contains the input and reference files. If you're looking for more information about the failure, you can consult the Unit Tests log file in $BBP_DATA_DIR/logs/unit_test.log .  If you can't determine the reason for the failure, contact [mailto:software@scec.org support].
+successful. At the end, the program will print the number of tests that passed and the number of tests that failed. If a test has failed, first check that you have built the executables.You can rerun just the specific test that failed (test_<module>.py). If the test is still failing, also verify that you have the ref_data directory, since it contains the input and reference files. If you're looking for more information about the failure, you can consult the Unit Tests log file in $BBP_DATA_DIR/logs/unit_tests.log .  If you can't determine the reason for the failure, contact [mailto:software@scec.org support].
 Once the unit tests all pass, proceed to the acceptance tests. If there are any failure or errors while running the unit tests, consult the Troubleshooting section at the end of this user guide for know issues and their solutions.

@@ Line 57: / Line 57: @@
   $ md5sum downloaded_file.tar.gz
-where "downloaded_file.tar.gz" is the file downloaded from the Broadband website. Users should do this once for each of the downloaded files to make sure they have successfully downloaded the files. The easiest way to do it, it to have all files in the same directory and type:
+where "downloaded_file.tar.gz" is the file downloaded from the Broadband website. Users should do this once for each of the downloaded files to make sure they have successfully downloaded the files. The easiest way to do it, it to have all .tar.gz distribution files and all .md5 files in the same directory and type:
   $ md5sum -c *.md5

@@ Line 53: / Line 53: @@
 You should get something like /usr/bin/md5sum. If you see the message 'no md5sum in...', contact your Linux system administrator and ask to have md5sum added to your path.
-Once you can run the ''md5sum'' command, run:
+Once you have the ''md5sum'' command installed on your system, you can type:
   $ md5sum downloaded_file.tar.gz
-where "downloaded_file.tar.gz" is the file downloaded from the Broadband website. Users should do this once for each of the downloaded files to make sure they have successfully downloaded the files.
+where "downloaded_file.tar.gz" is the file downloaded from the Broadband website. Users should do this once for each of the downloaded files to make sure they have successfully downloaded the files. The easiest way to do it, it to have all files in the same directory and type:
 If multiple users are planning to use the platform on the same system, you only need one copy of the data files per machine. Each user will still need his or her own copy of the code files.

@@ Line 44: / Line 44: @@
 * Northridge (requires the LABasin GF package)
-* Loma Prieta (requires the Loma Prieta GF package)
+* Loma Prieta (requires the LOMAP GF package)
 After downloading the needed files to your local Linux system, users can calculate their checksums and compare them to the checksums on the