diff --git a/README.md b/README.md index 28e9e32ab5b6..bbec3c70fdba 100644 --- a/README.md +++ b/README.md @@ -22,20 +22,16 @@ The **OpenQuake Engine** is an open source application that allows users to comp -## Documentation (master tree) --> -[![AGPLv3](https://www.gnu.org/graphics/agplv3-88x31.png)](https://www.gnu.org/licenses/agpl.html) -[![Build Status](https://travis-ci.org/gem/oq-engine.svg?branch=master)](https://travis-ci.org/gem/oq-engine) -[![Supported Python versions](https://img.shields.io/pypi/pyversions/openquake.engine.svg)](https://pypi.python.org/pypi/openquake.engine) -[![PyPI Version](https://img.shields.io/pypi/v/openquake.engine.svg)](https://pypi.python.org/pypi/openquake.engine) -![PyPI - Wheel](https://img.shields.io/pypi/wheel/openquake.engine.svg) -[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/gem/oq-engine.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/gem/oq-engine/context:python) +## OpenQuake Engine version 3.11 (Wegener) -### Current stable +Starting from OpenQuake version 2.0 we have introduced a "code name" to honour earthquake scientists. -Current stable version is the **OpenQuake Engine 3.10** 'Ulomov'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-3.10#openquake-engine. +The code name for version 3.11 is **Wegener**, in memory of the late Alfred Wegener, polar researcher, geophysicist and meteorologist. -* [What's new](../engine-3.10/doc/whats-new.md) -## Documentation (master tree) +* [What's new](../engine-3.11/doc/whats-new.md) + +## Documentation diff --git a/doc/adv-manual/architecture.rst b/doc/adv-manual/architecture.rst index 676c816e4ae0..4f0efd72a187 100644 --- a/doc/adv-manual/architecture.rst +++ b/doc/adv-manual/architecture.rst @@ -106,7 +106,7 @@ The WebUI provides a REST API that can be used in third party applications: for instance a QGIS plugin could download the maps generated by the engine via the WebUI and display them. There is lot of functionality in the API which is documented here: -https://github.com/gem/oq-engine/blob/master/doc/web-api.md. It is +https://github.com/gem/oq-engine/blob/engine-3.11/doc/web-api.md. It is possible to build your own user interface for the engine on top of it, since the API is stable and kept backward compatible. diff --git a/doc/adv-manual/common-mistakes.rst b/doc/adv-manual/common-mistakes.rst index dc524ebdb810..43b96f23ac22 100644 --- a/doc/adv-manual/common-mistakes.rst +++ b/doc/adv-manual/common-mistakes.rst @@ -251,5 +251,5 @@ to happen when generating tens of thousands of tasks. Again, it is best not to touch this parameter unless you know what you are doing. .. _equivalent distance approximation: special-features.html#equivalent-epicenter-distance-approximation -.. _rupture radius: https://github.com/gem/oq-engine/blob/master/openquake/hazardlib/source/point.py +.. _rupture radius: https://github.com/gem/oq-engine/blob/engine-3.11/openquake/hazardlib/source/point.py .. _point source gridding: point-source-gridding.html diff --git a/doc/adv-manual/developing.rst b/doc/adv-manual/developing.rst index 3e46d0515ae5..3771b09488ba 100644 --- a/doc/adv-manual/developing.rst +++ b/doc/adv-manual/developing.rst @@ -48,10 +48,10 @@ development installation in Python: you should clone the engine repository, 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: -https://github.com/gem/oq-engine/blob/master/doc/installing/development.md +https://github.com/gem/oq-engine/blob/engine-3.11/doc/installing/development.md It is also possible to develop on Windows ( -https://github.com/gem/oq-engine/blob/master/doc/installing/development.md) +https://github.com/gem/oq-engine/blob/engine-3.11/doc/installing/development.md) 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. diff --git a/doc/adv-manual/parametric-gmpes.rst b/doc/adv-manual/parametric-gmpes.rst index e2fc95a6a9c9..6e270cb488ef 100644 --- a/doc/adv-manual/parametric-gmpes.rst +++ b/doc/adv-manual/parametric-gmpes.rst @@ -293,4 +293,4 @@ Here `set_between_epsilon` is simply shifting the mean with the formula will likely grow more methods. If you want to understand how it works you should look at the source code: -https://github.com/gem/oq-engine/blob/master/openquake/hazardlib/gsim/mgmpe/modifiable_gmpe.py +https://github.com/gem/oq-engine/blob/engine-3.11/openquake/hazardlib/gsim/mgmpe/modifiable_gmpe.py diff --git a/doc/implementing-new-gsim.md b/doc/implementing-new-gsim.md index a15272620245..9e81a64680aa 100644 --- a/doc/implementing-new-gsim.md +++ b/doc/implementing-new-gsim.md @@ -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.11/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/sphinx/openquake.hazardlib.gsim.rst +https://github.com/gem/oq-engine/blob/engine-3.11/doc/sphinx/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.11/debian/changelog following the [Developers notes](updating-the-changelog.md) diff --git a/doc/manual/oqum/hazard/02_outputs.tex b/doc/manual/oqum/hazard/02_outputs.tex index 8e20fe9498a2..cdaa6d400d73 100644 --- a/doc/manual/oqum/hazard/02_outputs.tex +++ b/doc/manual/oqum/hazard/02_outputs.tex @@ -100,7 +100,7 @@ \section{Description of hazard outputs} By default, OpenQuake will export only the statistical results, i.e. mean curves and quantiles. If the user requires the complete results for all -realizations, there is a flag to specify, please see the FAQ \href{https://github.com/gem/oq-engine/blob/master/doc/faq-hazard.md}{https://github.com/gem/oq-engine/blob/master/doc/faq-hazard.md}. +realizations, there is a flag to specify, please see the FAQ \href{https://github.com/gem/oq-engine/blob/engine-3.11/doc/faq-hazard.md}{https://github.com/gem/oq-engine/blob/engine-3.11/doc/faq-hazard.md}. Beware that if the logic tree contains a large number of end branches the process of exporting the results from each end branch can add a significant amount of time - possibly longer than the computation time - and result in a diff --git a/doc/manual/oqum/introduction.tex b/doc/manual/oqum/introduction.tex index 898135145d29..f621dbaf1543 100644 --- a/doc/manual/oqum/introduction.tex +++ b/doc/manual/oqum/introduction.tex @@ -15,7 +15,7 @@ \section{Overview} provides a handy guide for users to choose the most appropriate installation method depending on their intended use cases: -\href{https://github.com/gem/oq-engine/blob/master/doc/installing/README.md}{https://github.com/gem/oq-engine/blob/master/doc/installing/README.md}. +\href{https://github.com/gem/oq-engine/blob/engine-3.11/doc/installing/README.md}{https://github.com/gem/oq-engine/blob/engine-3.11/doc/installing/README.md}. This user manual is for the command line interface for the \glsdesc{acr:oqe}. @@ -23,7 +23,7 @@ \section{Overview} \section{Supplementary resources} Guidance instructions for using the \glsdesc{acr:oqe} WebUI are available -at \href{https://github.com/gem/oq-engine/blob/master/doc/running/server.md}{https://github.com/gem/oq-engine/blob/master/doc/running/server.md}. +at \href{https://github.com/gem/oq-engine/blob/engine-3.11/doc/running/server.md}{https://github.com/gem/oq-engine/blob/engine-3.11/doc/running/server.md}. A user manual for the QGIS plugin for the \glsdesc{acr:oqe} is available at \href{https://docs.openquake.org/oq-irmt-qgis/latest/}{https://docs.openquake.org/oq-irmt-qgis/latest/}. diff --git a/doc/sphinx/baselib.rst b/doc/sphinx/baselib.rst index 917c7df4238b..9cae9e783dba 100644 --- a/doc/sphinx/baselib.rst +++ b/doc/sphinx/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#installation +https://github.com/gem/oq-engine/blob/engine-3.11/README.md#installation License ------- diff --git a/doc/sphinx/hazardlib.rst b/doc/sphinx/hazardlib.rst index d2b965ceca92..73ae558db5e7 100644 --- a/doc/sphinx/hazardlib.rst +++ b/doc/sphinx/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#installation +See https://github.com/gem/oq-engine/blob/engine-3.11/README.md#installation License ------- diff --git a/doc/whats-new.md b/doc/whats-new.md index 2de8fe4863e0..b0cf4b1742b8 100644 --- a/doc/whats-new.md +++ b/doc/whats-new.md @@ -33,7 +33,7 @@ Finally, now the engine can automatically download and run calculations from an URL containing a .zip archive. For instance ``` -$ oq engine --run "https://github.com/gem/oq-engine/blob/master/openquake/server/tests/data/classical.zip?raw=true" +$ oq engine --run "https://github.com/gem/oq-engine/blob/engine-3.11/openquake/server/tests/data/classical.zip?raw=true" ``` # Hazard calculators @@ -335,7 +335,7 @@ the risk side, but the feature is still not ready for primetime. # Packaging We now have a universal installer working on Linux, Windows and Mac -(see https://github.com/gem/oq-engine/blob/master/doc/installing/universal.md). +(see https://github.com/gem/oq-engine/blob/engine-3.11/doc/installing/universal.md). The universal installer is now the only supported way to install the engine on Mac and generic Linux systems. It works by using a pre-installed Python, which can