update readme and links for 3.21.0 release (engine-3.21)[demos]

README.md

@@ -34,7 +34,7 @@ The code name for version 3.16 is **Angela**, in memory of the Italian science j
 
 ### Latest release - for users needing the latest features
 
-Latest stable version is the **OpenQuake Engine 3.20**.* [What's new](https://docs.openquake.org/oq-engine/master/manual/release-notes/whats-new-3.20.html)
+Latest stable version is the **OpenQuake Engine 3.21**.* [What's new](https://docs.openquake.org/oq-engine/master/manual/release-notes/whats-new-3.21.html)
 
 <!-- GEM END -->
 

doc/api-reference/baselib.rst

@@ -26,7 +26,7 @@ $ pip install openquake.engine
 ```
 
 or in several other ways, see
-https://github.com/gem/oq-engine/blob/master/README.md
+https://github.com/gem/oq-engine/blob/engine-3.21/README.md
 
 License
 -------

doc/api-reference/hazardlib.rst

@@ -33,7 +33,7 @@ support on IRC channel #openquake on freenode.
 Installation
 ------------
 
-See https://github.com/gem/oq-engine/blob/master/README.md
+See https://github.com/gem/oq-engine/blob/engine-3.21/README.md
 
 License
 -------

doc/conf.py

@@ -99,7 +99,7 @@
  # "version_match": (
  # "development" if it_is_master is True else '.'.join(
  # version.split('.')[0:2])
- "version_match": "master"
+ "version_match": "3.21"
  },
  "navbar_center": ["navbar-nav"],
  "navbar_end": ["theme-switcher", "navbar-icon-links"],

doc/contributing/developing-with-the-engine.rst

@@ -156,7 +156,7 @@ The relevant code is something like this:
  run_risk(strikes=[0, 90, 180])
 
 Notice that this documentation can get out of sync with the code. The version
-which is tested and guaranteed to run is the one at https://github.com/gem/oq-engine/blob/master/demos/risk/ScenarioRisk/sensitivity.py, which also sets the environment
+which is tested and guaranteed to run is the one at https://github.com/gem/oq-engine/blob/engine-3.21/demos/risk/ScenarioRisk/sensitivity.py, which also sets the environment
 variable OQ_DISTRIBUTE to ``zmq``. This is the easiest way to parallelize the jobs,
 which makes sense since in this case the jobs are small.
 

doc/contributing/implementing-new-gsim.md

@@ -2,22 +2,22 @@
 
 Below we provide a concise description of the process to be adopted for the creation of a new GSIM (i.e. GMPE or IPE) in the OpenQuake hazard library.
 
-- Read the [Development guidelines](https://github.com/gem/oq-engine/blob/master/doc/contributing/development-guidelines.md)
+- Read the [Development guidelines](https://github.com/gem/oq-engine/blob/engine-3.21/doc/contributing/development-guidelines.md)
 
 - Fork the oq-engine master
 https://help.github.com/articles/fork-a-repo
 
 - Implement the new GSIM using as an example of a GSIM already in the oq-engine, whose functional form is similar to the new GSIM.
-https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/gsim
+https://github.com/gem/oq-engine/tree/engine-3.21/openquake/hazardlib/gsim
 
 - Acceleration should be returned in units of g, and standard deviation values in natural logarithm. If this is not consistent with the original GMPE, then a conversion needs to be made.
 
 - Create verification tables following the examples that you find here:
-https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/tests/gsim/data
-Usually we create verification tables using an independent code provided by the original authors of the new GSIM. If this is not possible - if available - we use an independent implementation available within code accessible on the web. If verification tables are missing, this must be clearly stated as in this example https://github.com/gem/oq-engine/blob/master/openquake/hazardlib/gsim/raghukanth_iyengar_2007.py#L119
+https://github.com/gem/oq-engine/tree/engine-3.21/openquake/hazardlib/tests/gsim/data
+Usually we create verification tables using an independent code provided by the original authors of the new GSIM. If this is not possible - if available - we use an independent implementation available within code accessible on the web. If verification tables are missing, this must be clearly stated as in this example https://github.com/gem/oq-engine/blob/engine-3.21/openquake/hazardlib/gsim/raghukanth_iyengar_2007.py#L119
 
 - Create tests for the new GSIM using the examples available here 
-https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/tests/gsim
+https://github.com/gem/oq-engine/tree/engine-3.21/openquake/hazardlib/tests/gsim
 
 - When tests are passing, update the forked repository, rerun tests and if everything is still okay, open a pull request. To run the full suite of tests, open a terminal and run the following commands:
 
@@ -27,7 +27,7 @@ pytest -xv openquake/hazardlib
 ```
 
 - Update the following .rst file (needed to generate automatically documentation):
-https://github.com/gem/oq-engine/blob/master/doc/api-reference/openquake.hazardlib.gsim.rst
+https://github.com/gem/oq-engine/blob/engine-3.21/doc/api-reference/openquake.hazardlib.gsim.rst
 
 - Check that the new code fulfils PEP 8 standards (usually we do this using tools such as flake8 https://pypi.python.org/pypi/flake8) 
 https://www.python.org/dev/peps/pep-0008/
@@ -37,4 +37,4 @@ https://www.python.org/dev/peps/pep-0008/
 Therefore assignment statements such as REQUIRES_RUPTURE_PARAMETERS = {'mag'} and REQUIRES_RUPTURE_PARAMETERS = set() are both correct.
 
 - Update the changelog file 
-https://github.com/gem/oq-engine/blob/master/debian/changelog following the [Developers notes](updating-the-changelog.md)
+https://github.com/gem/oq-engine/blob/engine-3.21/debian/changelog following the [Developers notes](updating-the-changelog.md)

doc/getting-started/demos-tutorials/index.rst

@@ -31,7 +31,7 @@ This is the list of demos which illustrate how to use the OpenQuake engine for v
 - ScenarioLiquefaction
 - SimpleFaultSourceClassicalPSHA
 
-The demo files are available `here <https://github.com/gem/oq-engine/tree/master/demos/hazard>`__. Feel free to run such examples and to play with the inputs and the outputs.
+The demo files are available `here <https://github.com/gem/oq-engine/tree/engine-3.21/demos/hazard>`__. Feel free to run such examples and to play with the inputs and the outputs.
 
 ********************
 Classical PSHA Demos
@@ -558,7 +558,7 @@ Demos for the Risk Module
 
 The following sections describe the set of demos that have been compiled to demonstrate some of the features and usage of 
 the risk calculators of the OpenQuake engine. These demos can be found in a public repository on GitHub at the following 
-link: `gem/oq-engine <https://github.com/gem/oq-engine/tree/master/demos/risk>`_.
+link: `gem/oq-engine <https://github.com/gem/oq-engine/tree/engine-3.21/demos/risk>`_.
 
 These examples are purely demonstrative and are not intended to represent accurately the seismicity, vulnerability or 
 exposure characteristics of the region selected, but simply to provide example input files that can be used as a starting 
@@ -582,7 +582,7 @@ probabilistic seismic damage and risk analyses:
 - ScenarioDamage
 - ScenarioRisk
 
-The documentation for the **bold** analysis cases is a work in progress. However, the demo files are available `here <https://github.com/gem/oq-engine/tree/master/demos/risk>`__.
+The documentation for the **bold** analysis cases is a work in progress. However, the demo files are available `here <https://github.com/gem/oq-engine/tree/engine-3.21/demos/risk>`__.
 
 These seven demos use Nepal as the region of interest. An example Exposure Model has been developed for this region, 
 comprising 9,063 assets distributed amongst 2,221 locations (due to the existence of more than one asset at the same 

doc/getting-started/installation-instructions/development.rst

@@ -133,7 +133,7 @@ Running the tests
 -----------------
 
 To run the OpenQuake Engine tests see the
-`testing <https://github.com/gem/oq-engine/blob/master/doc/contributing/testing.md>`__
+`testing <https://github.com/gem/oq-engine/blob/engine-3.21/doc/contributing/testing.md>`__
 page.
 
 Sync the source code with remote

doc/getting-started/installation-instructions/index.rst

@@ -51,19 +51,19 @@ The OpenQuake Engine is also available on `PyPI <https://pypi.python.org/pypi/op
 in any Python 3 environment via ``pip``::
 
  ```
- $ pip install -r https://github.com/gem/oq-engine/raw/master/requirements-py311-linux64.txt openquake.engine
+ $ pip install -r https://github.com/gem/oq-engine/raw/engine-3.21/requirements-py311-linux64.txt openquake.engine
  ```
 
 This works for Linux and Python 3.11. You can trivially adapt the command to other operating systems. For instance for Windows it would be::
 
  ```
- $ pip install -r https://github.com/gem/oq-engine/raw/master/requirements-py311-win64.txt openquake.engine
+ $ pip install -r https://github.com/gem/oq-engine/raw/engine-3.21/requirements-py311-win64.txt openquake.engine
  ```
 
 and for Mac, it would be::
 
  ```
- $ pip install -r https://github.com/gem/oq-engine/raw/master/requirements-py311-macos.txt openquake.engine
+ $ pip install -r https://github.com/gem/oq-engine/raw/engine-3.21/requirements-py311-macos.txt openquake.engine
  ```
 
 Cloud

doc/getting-started/installation-instructions/universal.md

@@ -47,7 +47,7 @@ You just need to download the installation script as:
 
 **on Windows:**
 ```
-C:\>curl.exe -L -O https://github.com/gem/oq-engine/raw/master/install.py
+C:\>curl.exe -L -O https://github.com/gem/oq-engine/raw/engine-3.21/install.py
 C:\>python.exe install.py user
 ```
 
@@ -56,13 +56,13 @@ C:\>python.exe install.py user
 Before running the universal installer Python 3.11 need to be installed, please see instructions for the {doc}`macos`
 
 ```
-$ curl -L -O https://github.com/gem/oq-engine/raw/master/install.py
+$ curl -L -O https://github.com/gem/oq-engine/raw/engine-3.21/install.py
 $ python3.11 install.py user
 ```
 
 **on Linux:**
 ```
-$ curl -L -O https://github.com/gem/oq-engine/raw/master/install.py
+$ curl -L -O https://github.com/gem/oq-engine/raw/engine-3.21/install.py
 $ python3.11 install.py user
 ```
 
@@ -180,7 +180,7 @@ automatically installed and started: `openquake-dbserver` and
 `openquake-webui`.
 
 ```
-$ curl -L -O https://github.com/gem/oq-engine/raw/master/install.py
+$ curl -L -O https://github.com/gem/oq-engine/raw/engine-3.21/install.py
 $ sudo -H python3.11 install.py server
 ```
 

doc/index.rst

@@ -116,7 +116,7 @@ maintenance, support, updates, enhancements, or modifications.
 Thanks
 ******
 
-See the list of `contributors <https://github.com/gem/oq-engine/blob/master/CONTRIBUTORS.txt>`_
+See the list of `contributors <https://github.com/gem/oq-engine/blob/engine-3.21/CONTRIBUTORS.txt>`_
 and `sponsors <https://github.com/gem/oq-engine#thanks>`_.
 
 

doc/underlying-science/secondary-perils.rst

@@ -12,7 +12,7 @@ the incorporation is a work in progress.
 In what follows, we provide a brief overview of the implemented models, preceded by general considerations on the 
 spatial resolution at which these analyses are typically conducted. For more in-depth information on the geospatial 
 models, we recommend referring to the original studies. Additionally, we offer corresponding demonstration analyses, 
-which can be found in the `demos section <https://github.com/gem/oq-engine/tree/master/demos>`_) of our GitHub 
+which can be found in the `demos section <https://github.com/gem/oq-engine/tree/engine-3.21/demos>`_) of our GitHub 
 repository. We encourage users to check them out and and familiarize themselves with the required inputs for performing
 liquefaction or landslide assessment. We also provide tools to extract relevant information from digital elevation data
 and its derivatives, which are often given as rasters.

doc/user-guide/configuration-file/event-based-risk-config.rst

@@ -389,7 +389,7 @@ uncertainty of the results in the asset loss table, in the column “variance”
 
 in terms of the variance of each asset for the event and intensity level in consideration, extracted from the asset 
 loss and the coefficients of variation. People interested in the details should look at the implementation in 
-`gem/oq-engine <https://github.com/gem/oq-engine/blob/master/openquake/risklib/scientific.py>`_.
+`gem/oq-engine <https://github.com/gem/oq-engine/blob/engine-3.21/openquake/risklib/scientific.py>`_.
 
 ****************************************
 Additional exceedance probability curves

doc/user-guide/configuration-file/scenario-risk-config.rst

@@ -239,8 +239,8 @@ Ground Motion Fields csv file with their latitude and longitude coordinates.::
  [fragility]
  structural_fragility_file = structural_fragility_model.xml
 
-- ``gmfs_csv``: a parameter used to define the path to the Ground Motion Fields file in the csv format. This file must define Ground Motion Fields for all of the intensity measure types used in the Fragility Model. (`Download an example file here <https://github.com/gem/oq-engine/raw/master/doc/manual/input_scenario_gmfs.csv>`__).
-- ``sites_csv``: a parameter used to define the path to the sites file in the csv format. This file must define site id, longitude, and latitude for all of the sites for the Ground Motion Fields file provided using the gmfs_csv parameter. (`Download an example file here <https://github.com/gem/oq-engine/raw/master/doc/manual/input_scenario_sites.csv>`_).
+- ``gmfs_csv``: a parameter used to define the path to the Ground Motion Fields file in the csv format. This file must define Ground Motion Fields for all of the intensity measure types used in the Fragility Model. (`Download an example file here <https://github.com/gem/oq-engine/raw/engine-3.21/doc/manual/input_scenario_gmfs.csv>`__).
+- ``sites_csv``: a parameter used to define the path to the sites file in the csv format. This file must define site id, longitude, and latitude for all of the sites for the Ground Motion Fields file provided using the gmfs_csv parameter. (`Download an example file here <https://github.com/gem/oq-engine/raw/engine-3.21/doc/manual/input_scenario_sites.csv>`_).
 
 The above calculation(s) can be run using the command line::
 

doc/user-guide/inputs/ground-motion-models-inputs.rst

@@ -235,7 +235,7 @@ Here is an example of use in the logic tree file::
 
 Here *set_between_epsilon* is simply shifting the mean with the formula *mean -> mean + epsilon_tau * inter_event*. In 
 the future ``ModifiableGMPE`` will likely grow more methods. If you want to understand how it works you should look at 
-the source code: `gem/oq-engine <https://github.com/gem/oq-engine/blob/master/openquake/hazardlib/gsim/mgmpe/modifiable_gmpe.py>`_
+the source code: `gem/oq-engine <https://github.com/gem/oq-engine/blob/engine-3.21/openquake/hazardlib/gsim/mgmpe/modifiable_gmpe.py>`_
 
 In engine 3.21 we added a helper function `valid.modified_gsim`
 to modify a GMPE. Internally it is creating a `ModifiableGMPE` instance,

doc/user-guide/outputs/index.rst

@@ -69,7 +69,7 @@ will be happy to give directions on how to do that in Python.
 *NOTE:* in the literature there are different algorithms for the computation of the quantiles. The OpenQuake engine uses an 
 algorithm based on interpolation which is implemented here:
 
-`gem/oq-engine <https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/stats.py>`_
+`gem/oq-engine <https://github.com/gem/oq-engine/tree/engine-3.21/openquake/hazardlib/stats.py>`_
 
 In particular, the median is computed as the q=0.5 quantile.
 

doc/user-guide/workflows/index.rst

@@ -23,7 +23,7 @@ Risk Calculators
 
 The seismic risk results are calculated using the OpenQuake engine risk library, an open-source suite of tools for seismic risk 
 assessment and loss estimation. This library is written in the Python programming language and available in the form of 
-a “developers” release at the following location: `gem/oq-engine <https://github.com/gem/oq-engine/tree/master/openquake/risklib>`_.
+a “developers” release at the following location: `gem/oq-engine <https://github.com/gem/oq-engine/tree/engine-3.21/openquake/risklib>`_.
 
 The risk component of the OpenQuake engine can compute both scenario-based and probabilistic seismic damage and risk 
 using various approaches. The following types of analysis are currently supported: