From 6b454675edf176d04e1cb0616c627a7b19252544 Mon Sep 17 00:00:00 2001 From: Matteo Nastasi Date: Mon, 4 Mar 2024 16:54:15 +0100 Subject: [PATCH] update readme and links for 3.19.0 release (engine-3.19)[demos] --- README.md | 2 +- doc/api-reference/baselib.rst | 2 +- doc/api-reference/hazardlib.rst | 2 +- doc/contributing/developing-with-the-engine.rst | 4 ++-- doc/contributing/implementing-new-gsim.md | 8 ++++---- .../installation-instructions/development.md | 2 +- doc/getting-started/installation-instructions/rhel.md | 2 +- doc/getting-started/installation-instructions/server.md | 2 +- doc/getting-started/installation-instructions/ubuntu.md | 2 +- doc/index.rst | 2 +- doc/user-guide/configuration-file/risk-calculations.rst | 2 +- doc/user-guide/inputs/ground-motion-models.rst | 2 +- 12 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 953f1ffd0084..aca1863c3fc1 100644 --- a/README.md +++ b/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.18**.* [What's new](https://docs.openquake.org/oq-engine/master/manual/release-notes/whats-new-3.18.html) +Latest stable version is the **OpenQuake Engine 3.19**.* [What's new](https://docs.openquake.org/oq-engine/master/manual/release-notes/whats-new-3.19.html) diff --git a/doc/api-reference/baselib.rst b/doc/api-reference/baselib.rst index 8e4253e29b8b..c52635333845 100644 --- a/doc/api-reference/baselib.rst +++ b/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.19/README.md License ------- diff --git a/doc/api-reference/hazardlib.rst b/doc/api-reference/hazardlib.rst index bef1a190e59b..341d2b9c284d 100644 --- a/doc/api-reference/hazardlib.rst +++ b/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.19/README.md License ------- diff --git a/doc/contributing/developing-with-the-engine.rst b/doc/contributing/developing-with-the-engine.rst index 8f897b078a24..a63837fd2613 100644 --- a/doc/contributing/developing-with-the-engine.rst +++ b/doc/contributing/developing-with-the-engine.rst @@ -35,9 +35,9 @@ installation the engine works as any other development installation in Python: y create and activate a virtualenv and then perform a *pip install -e* . from the engine main directory, as normal. You can find the details here: -`gem/oq-engine `_ +`gem/oq-engine `_ -It is also possible to develop on Windows (`gem/oq-engine `_) but very few people in GEM are doing that, so you are on your +It is also possible to develop on Windows (`gem/oq-engine `_) but very few people in GEM are doing that, so you are on your own, should you encounter difficulties. We recommend Linux, but Mac also works. Since you are going to develop with the engine, you should also install the development dependencies that by default are diff --git a/doc/contributing/implementing-new-gsim.md b/doc/contributing/implementing-new-gsim.md index b32d179cbc0e..b1bdc5a8752b 100644 --- a/doc/contributing/implementing-new-gsim.md +++ b/doc/contributing/implementing-new-gsim.md @@ -2,7 +2,7 @@ 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.19/doc/contributing/development-guidelines.md) - Fork the oq-engine master https://help.github.com/articles/fork-a-repo @@ -14,7 +14,7 @@ https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/gsim - 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 +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.19/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 @@ -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.19/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.19/debian/changelog following the [Developers notes](updating-the-changelog.md) diff --git a/doc/getting-started/installation-instructions/development.md b/doc/getting-started/installation-instructions/development.md index 9ee4978614fd..705da216bb50 100644 --- a/doc/getting-started/installation-instructions/development.md +++ b/doc/getting-started/installation-instructions/development.md @@ -109,7 +109,7 @@ authkey = changeme | authkey = changeme ## Running the tests -To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/master/doc/contributing/testing.md)** page. +To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/engine-3.19/doc/contributing/testing.md)** page. ### Sync the source code with remote diff --git a/doc/getting-started/installation-instructions/rhel.md b/doc/getting-started/installation-instructions/rhel.md index d10894b8d525..b6599406f60d 100644 --- a/doc/getting-started/installation-instructions/rhel.md +++ b/doc/getting-started/installation-instructions/rhel.md @@ -71,7 +71,7 @@ Continue on [How to run the OpenQuake Engine](unix) ## Test the installation -To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/master/doc/contributing/testing.md)** page. +To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/engine-3.19/doc/contributing/testing.md)** page. (uninstall-the-openquake-engine)= diff --git a/doc/getting-started/installation-instructions/server.md b/doc/getting-started/installation-instructions/server.md index 2643bd56a9a4..61e37a78c29a 100644 --- a/doc/getting-started/installation-instructions/server.md +++ b/doc/getting-started/installation-instructions/server.md @@ -126,7 +126,7 @@ gunicorn -w N wsgi:application where `N` is the number of workers, we suggest `N = 4`. -*gunicorn* is usually managed by the OS init system. See an example for [systemd](https://github.com/gem/oq-engine/blob/master/debian/systemd/openquake-webui.service). +*gunicorn* is usually managed by the OS init system. See an example for [systemd](https://github.com/gem/oq-engine/blob/engine-3.19/debian/systemd/openquake-webui.service). ### nginx diff --git a/doc/getting-started/installation-instructions/ubuntu.md b/doc/getting-started/installation-instructions/ubuntu.md index a91cd0769d46..c0cc9a0b8c2a 100644 --- a/doc/getting-started/installation-instructions/ubuntu.md +++ b/doc/getting-started/installation-instructions/ubuntu.md @@ -50,7 +50,7 @@ Continue on [How to run the OpenQuake Engine](unix) ## Test the installation -To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/master/doc/contributing/testing.md)** page. +To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/engine-3.19/doc/contributing/testing.md)** page. ## Uninstall the OpenQuake Engine diff --git a/doc/index.rst b/doc/index.rst index 29de0de66567..e51d74b11612 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -116,7 +116,7 @@ maintenance, support, updates, enhancements, or modifications. Thanks ****** -See the list of `contributors `_ +See the list of `contributors `_ and `sponsors `_. diff --git a/doc/user-guide/configuration-file/risk-calculations.rst b/doc/user-guide/configuration-file/risk-calculations.rst index 07746aceb0f9..005e98b6bcd6 100644 --- a/doc/user-guide/configuration-file/risk-calculations.rst +++ b/doc/user-guide/configuration-file/risk-calculations.rst @@ -1286,4 +1286,4 @@ 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 `_. +`gem/oq-engine `_. diff --git a/doc/user-guide/inputs/ground-motion-models.rst b/doc/user-guide/inputs/ground-motion-models.rst index fb446078a03a..6a8f9ae42b4a 100644 --- a/doc/user-guide/inputs/ground-motion-models.rst +++ b/doc/user-guide/inputs/ground-motion-models.rst @@ -235,4 +235,4 @@ 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 `_ \ No newline at end of file +the source code: `gem/oq-engine `_ \ No newline at end of file