Difference between revisions of "Broadband Release Info"
(Created page with '= 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 …') |
|||
| Line 2: | Line 2: | ||
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. | ||
| + | |||
| + | == Testing Before Release == | ||
| + | |||
| + | The first step to release a version of the Broadband Platform is to run tests to make sure the Platform is working. | ||
| + | |||
| + | === Unit Tests === | ||
| + | |||
| + | The Platform contains a number of tests cases designed to test each individual software component of the platform. These are called Unit Tests, and can be executed with the following commands: | ||
| + | |||
| + | $ cd tests | ||
| + | $ ./UnitTests.py | ||
| + | |||
| + | The tests take about 20 minutes to run, and after each test you should see | ||
| + | |||
| + | === Acceptance Tests === | ||
| + | |||
| + | The next step is to run the acceptance tests. These tests are complete end-to-end simulation runs, for both scenario and validation simulations using each of the available methods on the Broadband Platform. | ||
| + | |||
| + | In order to start the tests, just follow these steps: | ||
| + | |||
| + | $ cd tests | ||
| + | $ ./AcceptTests.py | ||
| + | |||
| + | These tests will take just over 2 hours to run, and after each test completes, you should see an "ok" message. Here's the sample output of a successful test run: | ||
| + | |||
| + | Number of tests to run: 12 | ||
| + | test_user-CSM (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_user-EXSIM (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_user-GP (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_user-SDSU (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_user-UCSB (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_valid-northridge-CSM (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_valid-northridge-EXSIM (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_valid-northridge-GP (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_valid-northridge-GP_seis (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_valid-northridge-SDSU (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_valid-northridge-SDSU_seis (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | test_valid-northridge-UCSB (__main__.BBP2G_Acceptance_Tests) ... ok | ||
| + | |||
| + | ---------------------------------------------------------------------- | ||
| + | Ran 12 tests in 7639.309s | ||
| + | |||
| + | OK | ||
| + | |||
| + | 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. | ||
== Update Build Version == | == Update Build Version == | ||
Revision as of 21:59, 22 April 2014
Contents
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.
Testing Before Release
The first step to release a version of the Broadband Platform is to run tests to make sure the Platform is working.
Unit Tests
The Platform contains a number of tests cases designed to test each individual software component of the platform. These are called Unit Tests, and can be executed with the following commands:
$ cd tests $ ./UnitTests.py
The tests take about 20 minutes to run, and after each test you should see
Acceptance Tests
The next step is to run the acceptance tests. These tests are complete end-to-end simulation runs, for both scenario and validation simulations using each of the available methods on the Broadband Platform.
In order to start the tests, just follow these steps:
$ cd tests $ ./AcceptTests.py
These tests will take just over 2 hours to run, and after each test completes, you should see an "ok" message. Here's the sample output of a successful test run:
Number of tests to run: 12 test_user-CSM (__main__.BBP2G_Acceptance_Tests) ... ok test_user-EXSIM (__main__.BBP2G_Acceptance_Tests) ... ok test_user-GP (__main__.BBP2G_Acceptance_Tests) ... ok test_user-SDSU (__main__.BBP2G_Acceptance_Tests) ... ok test_user-UCSB (__main__.BBP2G_Acceptance_Tests) ... ok test_valid-northridge-CSM (__main__.BBP2G_Acceptance_Tests) ... ok test_valid-northridge-EXSIM (__main__.BBP2G_Acceptance_Tests) ... ok test_valid-northridge-GP (__main__.BBP2G_Acceptance_Tests) ... ok test_valid-northridge-GP_seis (__main__.BBP2G_Acceptance_Tests) ... ok test_valid-northridge-SDSU (__main__.BBP2G_Acceptance_Tests) ... ok test_valid-northridge-SDSU_seis (__main__.BBP2G_Acceptance_Tests) ... ok test_valid-northridge-UCSB (__main__.BBP2G_Acceptance_Tests) ... ok ---------------------------------------------------------------------- Ran 12 tests in 7639.309s OK
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.
Update Build Version
Starting with the Broadband Platform 13.6.1 release, the version of the main BBP source distribution and the versions of validation events and velocity model packages are independent. To update the version of the BBP source distribution, just edit the comps/version.txt file.
In order to update the version number of one or more velocity model/validation package, you will need to edit the corresponding configuration file and edit the version line:
VELMODEL_VERSION = 4-March-2014
