Updated documentation to match BBP wiki.

doc/Acknowledging.md

@@ -4,15 +4,15 @@ The primary reference for the Broadband Platform software system (v15.3.0 and la
 
 * Maechling, P. J., F. Silva, S. Callaghan, and T. H. Jordan (2015). SCEC Broadband Platform: System Architecture and Software Implementation, Seismol. Res. Lett., 86, no. 1, doi: 10.1785/0220140125.
 
-The primary reference that describes the validation process developed by the Broadband Platform group to establish that the BBP platform software produces results suitable for use in engineering applications is:
+The primary reference that describes the validation process developed by the Broadband Platform group to establish that the BBP platform software produces results are suitable for use in engineering applications is:
 
 * Goulet, C.A., Abrahamson, N.A., Somerville, P.G. and K, E. Wooddell (2015) The SCEC Broadband Platform Validation Exercise: Methodology for Code Validation in the Context of Seismic-Hazard Analyses, Seismol. Res. Lett., 86, no. 1, doi: 10.1785/0220140104
 
 The primary reference that describes the results of the validation process in 2014 is:
 
 * Dreger, D. S., Beroza, G.C., Day, S. M., Goulet, C. A., Jordan, T. H., Spudich, P. A., and Stewart, J. P. (2015). Validation of the SCEC Broadband Platform V14.3 Simulation Methods Using Pseudospectral Acceleration Data, Seismol. Res. Lett., 86, no. 1, doi:10.1785/0220140118.
 
-References for specific computational methods included in the Broadband Platform (v15.3.0 and later, including v16.5.0) and for the validation procedures developed by the Broadband Platform include:
+References for specific computational methods included in the Broadband Platform (v15.3.0 and later, including v16.5.0, v17.3.0, and v19.4.0) and for the validation procedures developed by the Broadband Platform include:
 
 * Anderson, J. G (2015) The Composite Source Model for Broadband Simulations of Strong Ground Motions Seismological Research Letters, January/February 2015, v. 86, p. 68-74, First published on December 17, 2014, doi:10.1785/0220140098
 * Atkinson, G. M., and Assatourians, K. (2015) Implementation and Validation of EXSIM (A Stochastic Finite‐Fault Ground‐Motion Simulation Algorithm) on the SCEC Broadband Platform Seismological Research Letters, January/February 2015, v. 86, p. 48-60, First published on December 17, 2014, doi:10.1785/0220140097

doc/FAQ.md

@@ -4,17 +4,17 @@
   * The most recent version of the Broadband Platform software is posted GitHub's releases page. We expect to make new releases of the Broadband Platform every 6-12 months.
 
 * Which version of the Broadband Platform should I use?
-  * Several previous versions of the broadband platform have been released by SCEC. New versions of the platform incorporate software updates, improvements, and bug fixes. For this reason, we recommend all new users should use the most recent version of the platform, as posted on the Broadband Platform wiki page. We recommend users migrate their work to the most recent version of the broadband platform at the first opportunity. Previous versions of the platform are still available primarily to support reproducibility of earlier results.
+  * Several previous versions of the Broadband Platform have been released by SCEC. New versions of the Platform incorporate software updates, improvements, and bug fixes. For this reason, we recommend all new users should use the most recent version of the Platform, as posted on the Broadband Platform wiki page. We recommend users migrate their work to the most recent version of the Broadband Platform at the first opportunity. Previous versions of the Platform are still available primarily to support reproducibility of earlier results.
 
 * Is the Broadband Platform compatible with Python 3?
-  * The current version of the Broadband Platform is not compatible with Python 3. We expect to have the Broadband Platform ported to Python 3 as part of our next release. For now, users will need to run the Broadband Platform using the latest Python 2.7 release.
+  * The Broadband Platform was ported to Python 3 as of version 19.8. All Broadband Platform versions after 19.8 require Python 3 to run.
 
 * How can I simulate earthquakes in California, Japan and Eastern North America?
-  * The newest Broadband Platform distribution supports simulations for several 1D velocity models. These 1D velocity models were defined to represent structure in parts of California including Los Angeles Basin, Mojave Desert, Central California Coast, Eastern North America, including Virginia and Eastern Canada, and Western and Central Japan. Broadband Platform users can select a region, and simulate earthquakes in that region for one or more of the ground motion modeling software installed in the platform.
+  * The newest Broadband Platform distribution supports simulations for several 1D velocity models. These 1D velocity models were defined to represent structure in parts of California including Los Angeles Basin, Mojave Desert, Central California Coast, Southern Walker Lane (Southern Sierra Nevada region), Eastern North America, including Virginia and Eastern Canada, and Western and Central Japan. Broadband Platform users can select a region, and simulate earthquakes in that region for one or more of the ground motion modeling software installed in the platform.
 
 * What region should I use for an earthquake in California?
-   * The Broadband Platform currently has 4 simulation regions for California: LA Basin, Mojave,
-   Central California, and Northern California. Please take a look at this [map](pdfs/california_gfs_19_4.pdf) for a suggestion of what region to use for simulations in California. Please note that these are only approximate and somewhat subjective, but basically, for ruptures located in the Southern California, users should use the LA Basin region. The Mojave region should be used for faults in most of the inland part of Southern California, the Central California region should be used for the central coast region of California, and the Northern California region should be used for ruptures located in the remainder of the State.
+   * The Broadband Platform currently has 5 simulation regions for California: LA Basin, Mojave,
+   Central California, Southern Sierra Nevada, and Northern California. Please take a look at this [map](pdfs/california_gfs_22_4.pdf) for a suggestion of what region to use for simulations in California. Please note that these are only approximate and somewhat subjective, but basically, for ruptures located in the Southern California, users should use the LA Basin region. The Mojave region should be used for faults in most of the inland part of Southern California, the Central California region should be used for the central coast region of California, the Southern Sierra Nevada region should be used for inland portion of Central and Northern California, and the Northern California region should be used for ruptures located in the remainder of the State.
 
 * How can I simulate earthquakes outside California, Eastern North America, and Japan?
   * Simulating earthquakes outside one of the currently supported regions requires creating a new 1D velocity profile and setting up a new simulation region. In addition to the 1D velocity profile for the region, the Broadband Platform requires the calculation of Greens' Functions and the configuration of several region-specific parameters so it is not as simple as just creating a new 1D velocity model and supplying that file to the BBP. At this time, setting up a new velocity model/Green's Functions/region parameters requires help from several of the science teams. Also the Broadband platform does not currently include software to generate new Greens functions needed for most simulation methods (EXSIM is an exception to this rule). In future releases of the Broadband Platform, it may be possible for the user to define a 1D velocity profile, generate Greens Functions for that profile, and then simulate earthquakes using those Greens Functions.
@@ -23,15 +23,15 @@
   * The Broadband Platform was designed to generate reproducible results. Therefore, given the same inputs, we expect it to produce the exact outputs again and again. In order to generate different simulation variations (or realizations), users can run the Broadband Platform multiple times, but providing a different SEED value each time the BBP is run. The SEED value is included in the simple source description (SRC) file. So, to run 10 different simulation variations, users will need to create 10 copies of the SRC file, each with a different value for the SEED parameter. This seed will be used to initialize the random number generators in several of the BBP modules, resulting in different parameters to be used. For example, in the GP rupture generator, different SEED values will result in different slip distributions. Similarly, other modules use the SEED to randomize their own parameters.
 
 * I try to run the tests of UnitTests.py. The result tells me that ImportError: No module named scipy. I wonder what wrong it is.
-  * The error you are seeing relates to the python software that you are using. The Broadband Platform using standard Python libraries. It also requires several "optional" Python libraries that must be added to most Python installations. The error you are getting indicates that you need to install one (or more) additional Python libraries. These additional libraries are free, but how you install them will depend on the system on which you are installing the broadband platform.
+  * The error you are seeing relates to the python software that you are using. The Broadband Platform uses standard Python libraries. It also requires several "optional" Python libraries that must be added to most Python installations. The error you are getting indicates that you need to install one (or more) additional Python libraries. These additional libraries are free, but how you install them will depend on the system on which you are installing the broadband platform.
 
     Users can install the necessary additional Python libraries onto their computer. Then the Broadband Platform should run. How to install the needed libraries, such as the SciPy library mentioned in your error message will depend on the Python software you are using.
 
     One option that we recommend is using the open source [Anaconda](https://www.anaconda.com) Python distribution. It includes most of the required python libraries in one simple installation.
 
-    The BBP v19.4.0 requires Python v2.7+ and several optional Python libraries. It is possible to collect all necessary Python libraries, but we recommend using a Python distribution that includes nearly all the required libraries. We recommend use of the [Anaconda Python distribution (free)](https://www.anaconda.com). Go to the Anaconda downloads page, and download the Python 2.7 command line distribution tool (free). Once downloaded, the Anaconda Python distribution can be installed by running the downloaded script file.
+    The BBP v22.4.0 requires Python v3.6+ and several optional Python libraries. It is possible to collect all necessary Python libraries, but we recommend using a Python distribution that includes nearly all the required libraries. We recommend use of the [Anaconda Python distribution (free)](https://www.anaconda.com). Go to the Anaconda downloads page, and download the Python 3.6+ command line distribution tool (free). Once downloaded, the Anaconda Python distribution can be installed by running the downloaded script file.
 
-    It will ask you to agree to the license, and then install a current version of Python 2.7 and most of the Python libraries required by the BBP v19.4.0. Anaconda Python can be installed in your user directory and does not require administrator privileges. At the end of the installation process, the installation tool should update your shell initialization files to put the Anaconda Python installation into your default path.
+    It will ask you to agree to the license, and then install a current version of Python 3.6+ and most of the Python libraries required by the BBP v22.4.0. Anaconda Python can be installed in your user directory and does not require administrator privileges. At the end of the installation process, the installation tool should update your shell initialization files to put the Anaconda Python installation into your default path.
 
     Update the PyProj library in Anaconda Python
 
@@ -49,7 +49,7 @@
     $ pip install scipy
     ```
 
-    If you use this approach, you may find that you need to add other Python modules (in addition to scipy) such as matplotlib, pyproj, and basemap. However, once you add all the required Python modules, the Broadband Platform software should run.
+    If you use this approach, you may find that you need to add other Python modules (in addition to scipy) such as matplotlib, pyproj, numba, and basemap. However, once you add all the required Python modules, the Broadband Platform software should run.
 
 * When I run the UnitTests.py, I get a few warnings. I wonder if I can ignore these warnings, what do I do next?
   * When running BBP's unit tests, you will sometime see warning messages like these:

doc/Home.md

@@ -1,7 +1,12 @@
 The Southern California Earthquake Center (SCEC) Broadband Platform (BBP) is a software system that can generate 0-20+ Hz seismograms for historical and scenario earthquakes in California, Eastern North America, and Japan using several alternative computational methods.
 
 ## Latest Release
-The most recent version of the SCEC Broadband Platform is version 19.4 which was released in May 2019. The BBP 19.4 software can be downloaded from SCEC's [Broadband Platform GitHub repository.](https://github.com/SCECcode/bbp) We recommend that all new users work with BBP 19.4 because the version adds new capabilities and provides improvements to the methods provided in earlier releases of the Broadband Platform. Existing BBP users should review the [Broadband Platform 19.4 release notes](./Release-Notes.md) and should upgrade to this new version if the improvements included in it are important to their specific use of the platform. Previous versions of the Broadband Platform are available for users that want to reproduce results produced with earlier versions of the Platform. Please review the [BBP installation instructions](./Installation.md) for details on how to download and install the BBP 19.4 on your local computer.
+The most recent version of the SCEC Broadband Platform is version 22.4 which was released in August 2022. The BBP 22.4 software can be downloaded from:
+
+* [Broadband Platform GitHub repository](https://github.com/SCECcode/bbp) (Released August 2022)
+* [Broadband Platform Github Wiki Documentation](https://github.com/SCECcode/bbp/wiki)
+
+We recommend that all new users work with BBP 22.4 because the version adds new capabilities and provides improvements to the methods provided in earlier releases of the Broadband Platform. Existing BBP users should review the [Broadband Platform 22.4 release notes](./Release-Notes) and should upgrade to this new version if the improvements included in it are important to their specific use of the platform. Previous versions of the Broadband Platform are available for users that want to reproduce results produced with earlier versions of the Platform. Please review the [BBP installation instructions](./Installation) for details on how to download and install the BBP 22.4 on your local computer.
 
 ## Overview
 The goal of the SCEC Broadband Simulation Platform is to generate broadband (0-20+ Hz) ground motions for earthquakes. The SCEC Broadband Platform is a collaborative software development project involving SCEC researchers, research engineers, graduate students, and the SCEC/CME software development group. SCEC scientific groups have contributed modules to the Broadband Platform including kinematic rupture generation, low- and high-frequency seismogram synthesis using 3D wave propagation through 1D layered velocity structures, non-linear site effects, ground motion intensity measure calculations, and visualization. These complex scientific codes have been integrated into a system that supports easy on-demand computation of broadband seismograms, providing user-defined, repeatable calculation of ground-motion seismograms, using alternative simulation methods, and software utilities to generate tables, plots, and maps. The SCEC Broadband Platform is designed to be used by both scientific and engineering researchers with some experience interpreting ground motion simulations.
@@ -10,14 +15,14 @@ Users may calculate broadband seismograms for both historical earthquakes (valid
 
 The SCEC BBP software can be compiled and run on recent Linux systems with GNU compilers. The Broadband Platform continues to evolve, and new versions of the BBP are released periodically on GitHub. The latest release includes seven simulation methods, eight simulation regions covering California, Japan, Eastern North America, and the ability to compare simulation results against empirical ground motion models. The newest features include the ability to simulate multi-segment ruptures using several simulation methods. And, in addition to a new simulation method, it now includes improvements to several existing ground motion simulation methods and revised Green’s functions for all simulation regions. In this release, the site response module is integrated with all simulation methods and can also be used for comparing simulated data against historical earthquakes
 
-The Broadband Platform is open-source software that is made available under the terms of the Apache License, Version 2.0. A copy of the License is provided by the Apache Software Foundation (http://www.apache.org/licenses/LICENSE-2.0) and can also be found with the software in the 'LICENSE' file.
+The SCEC-developed portions of the Broadband platform software is distributed under the terms of the BSD 3-Clause open-source license. Please see the LICENSE.txt file for more information. Individual models codes may be offered under their own open-source software licenses, please look for a LICENSE.txt file under specific sub folders in the 'src' directory for module-specific license information.
 
 ### Preferred Reference for the Broadband Platform Software
 Please support the Broadband Platform project by acknowledging the use of this software. Acknowledgements and citations help us obtain additional resources for continued development of the platform. The primary reference for the Broadband Platform software system (v15.3.0 and later) is:
 
 * Maechling, P. J., F. Silva, S. Callaghan, and T. H. Jordan (2015). SCEC Broadband Platform: System Architecture and Software Implementation, Seismol. Res. Lett., 86, no. 1, doi: 10.1785/0220140125.
 
-Additional information describing how to cite specific methods implemented in the Broadband Platform is provided in more detail on the [acknowledgement page](./Acknowledging.md)
+Additional information describing how to cite specific methods implemented in the Broadband Platform is provided in more detail on the [acknowledgement page](./Acknowledging)
 
 ### Broadband Platform Diagram