From b6bcec10d368b6b64491f9593c7d06fabbd24dcc Mon Sep 17 00:00:00 2001 From: Matteo Nastasi Date: Thu, 26 Sep 2019 11:41:24 +0200 Subject: [PATCH] update readme and links for 3.7.0 release (engine-3.7) [demos] --- README.md | 67 +++++++++++++++----------------- doc/implementing-new-gsim.md | 6 +-- doc/manual/oqum/introduction.tex | 4 +- doc/sphinx/architecture.rst | 2 +- doc/sphinx/baselib.rst | 2 +- doc/sphinx/hazardlib.rst | 2 +- 6 files changed, 39 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 1ddc9aa10eba..f398adb20340 100644 --- a/README.md +++ b/README.md @@ -22,64 +22,59 @@ 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.7 (Richter) -### 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.6** 'Pak Topo'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-3.6#openquake-engine. +The code name for version 3.7 is **Richter**, in memory of [Charles Francis Richter](https://en.wikipedia.org/wiki/Charles_Francis_Richter). -* [What's new](https://github.com/gem/oq-engine/blob/engine-3.6/doc/whats-new.md) +* [What's new](https://github.com/gem/oq-engine/blob/engine-3.7/doc/whats-new.md) -## Documentation (master tree) +## Documentation ### General overview -* [About](https://github.com/gem/oq-engine/blob/master/doc/about.md) -* [FAQ](https://github.com/gem/oq-engine/blob/master/doc/faq.md) +* [About](https://github.com/gem/oq-engine/blob/engine-3.7/doc/about.md) +* [FAQ](https://github.com/gem/oq-engine/blob/engine-3.7/doc/faq.md) * [Manuals](https://www.globalquakemodel.org/single-post/OpenQuake-Engine-Manual) -* [OQ Commands](https://github.com/gem/oq-engine/blob/master/doc/oq-commands.md) -* [Architecture](https://github.com/gem/oq-engine/blob/master/doc/sphinx/architecture.rst) -* [Calculation Workflow](https://github.com/gem/oq-engine/blob/master/doc/calculation-workflow.md) -* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/master/doc/hardware-suggestions.md) -* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/master/doc/testing.md) -* [Glossary of Terms](https://github.com/gem/oq-engine/blob/master/doc/glossary.md) +* [OQ Commands](https://github.com/gem/oq-engine/blob/engine-3.7/doc/oq-commands.md) +* [Architecture](https://github.com/gem/oq-engine/blob/engine-3.7/doc/sphinx/architecture.rst) +* [Calculation Workflow](https://github.com/gem/oq-engine/blob/engine-3.7/doc/calculation-workflow.md) +* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/engine-3.7/doc/hardware-suggestions.md) +* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/engine-3.7/doc/testing.md) +* [Glossary of Terms](https://github.com/gem/oq-engine/blob/engine-3.7/doc/glossary.md) #### For contributors -* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/master/doc/development-guidelines.md) +* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/engine-3.7/doc/development-guidelines.md) * [Source Code/API Documentation](http://docs.openquake.org/oq-engine/) -* [HTTP REST API](https://github.com/gem/oq-engine/blob/master/doc/web-api.md) -* [Implementing a new GSIM](https://github.com/gem/oq-engine/blob/master/doc/implementing-new-gsim.md) +* [HTTP REST API](https://github.com/gem/oq-engine/blob/engine-3.7/doc/web-api.md) +* [Implementing a new GSIM](https://github.com/gem/oq-engine/blob/engine-3.7/doc/implementing-new-gsim.md) ### Installation -* [Technology stack and requirements](https://github.com/gem/oq-engine/blob/master/doc/requirements.md) -* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/master/doc/installing/overview.md) +* [Technology stack and requirements](https://github.com/gem/oq-engine/blob/engine-3.7/doc/requirements.md) +* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/overview.md) #### Linux -* [Installing on Ubuntu](https://github.com/gem/oq-engine/blob/master/doc/installing/ubuntu.md) -* [Installing on RedHat and derivatives](https://github.com/gem/oq-engine/blob/master/doc/installing/rhel.md) -* [Installing on other flavors (without sudo)](https://github.com/gem/oq-engine/blob/master/doc/installing/linux-generic.md) -* [Installing from sources](https://github.com/gem/oq-engine/blob/master/doc/installing/development.md) -* [Installing on a cluster](https://github.com/gem/oq-engine/blob/master/doc/installing/cluster.md) +* [Installing on Ubuntu](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/ubuntu.md) +* [Installing on RedHat and derivatives](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/rhel.md) +* [Installing on other flavors (without sudo)](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/linux-generic.md) +* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/development.md) +* [Installing on a cluster](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/cluster.md) #### macOS -* [Installing on macOS](https://github.com/gem/oq-engine/blob/master/doc/installing/macos.md) -* [Installing from sources](https://github.com/gem/oq-engine/blob/master/doc/installing/development.md#macos) +* [Installing on macOS](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/macos.md) +* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/development.md#macos) #### Windows -* [Installing on Windows](https://github.com/gem/oq-engine/blob/master/doc/installing/windows.md) -* [Starting the software](https://github.com/gem/oq-engine/blob/master/doc/running/windows.md) +* [Installing on Windows](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/windows.md) +* [Starting the software](https://github.com/gem/oq-engine/blob/engine-3.7/doc/running/windows.md) #### VirtualBox @@ -87,7 +82,7 @@ Current stable version is the **OpenQuake Engine 3.6** 'Pak Topo'. The documenta #### Cloud -* [Deploy a Docker container](https://github.com/gem/oq-engine/blob/master/doc/installing/docker.md) +* [Deploy a Docker container](https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/docker.md) #### Mirrors @@ -97,8 +92,8 @@ The main download server ([downloads.openquake.org](https://downloads.openquake. ### Running the OpenQuake Engine -* [Using the command line](https://github.com/gem/oq-engine/blob/master/doc/running/unix.md) -* [Using the WebUI](https://github.com/gem/oq-engine/blob/master/doc/running/server.md) +* [Using the command line](https://github.com/gem/oq-engine/blob/engine-3.7/doc/running/unix.md) +* [Using the WebUI](https://github.com/gem/oq-engine/blob/engine-3.7/doc/running/server.md) ### Visualizing outputs via QGIS @@ -112,7 +107,7 @@ The main download server ([downloads.openquake.org](https://downloads.openquake. ## License -The OpenQuake Engine is released under the **[GNU Affero Public License 3](https://github.com/gem/oq-engine/blob/master/LICENSE)**. +The OpenQuake Engine is released under the **[GNU Affero Public License 3](https://github.com/gem/oq-engine/blob/engine-3.7/LICENSE)**. ## Contacts diff --git a/doc/implementing-new-gsim.md b/doc/implementing-new-gsim.md index 28b71c3045e3..b3c3c7d3e65b 100644 --- a/doc/implementing-new-gsim.md +++ b/doc/implementing-new-gsim.md @@ -12,7 +12,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 GMPE. 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 GMPE. 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.7/openquake/hazardlib/gsim/raghukanth_iyengar_2007.py#L119 - Create tests for the new GMPE using the examples available here https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/tests/gsim @@ -25,10 +25,10 @@ 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.7/doc/sphinx/openquake.hazardlib.gsim.rst - Check that the new code fulfils PEP8 standards (usually we do this using tools such as flake8 https://pypi.python.org/pypi/flake8) http://legacy.python.org/dev/peps/pep-0008/ - 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.7/debian/changelog following the [Developers notes](updating-the-changelog.md) diff --git a/doc/manual/oqum/introduction.tex b/doc/manual/oqum/introduction.tex index b9f44738484e..6e20ef8bbce8 100644 --- a/doc/manual/oqum/introduction.tex +++ b/doc/manual/oqum/introduction.tex @@ -13,12 +13,12 @@ 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/overview.md}{https://github.com/gem/oq-engine/blob/master/doc/installing/overview.md}. +\href{https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/overview.md}{https://github.com/gem/oq-engine/blob/engine-3.7/doc/installing/overview.md}. This manual is for the command line interface for the \glsdesc{acr:oqe}. 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.7/doc/running/server.md}{https://github.com/gem/oq-engine/blob/engine-3.7/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/architecture.rst b/doc/sphinx/architecture.rst index f9ff7f8a8b7b..bd7435fa6f21 100644 --- a/doc/sphinx/architecture.rst +++ b/doc/sphinx/architecture.rst @@ -122,6 +122,6 @@ 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.7/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/sphinx/baselib.rst b/doc/sphinx/baselib.rst index 917c7df4238b..13709c1fff4a 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.7/README.md#installation License ------- diff --git a/doc/sphinx/hazardlib.rst b/doc/sphinx/hazardlib.rst index d2b965ceca92..8b75987dc3c3 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.7/README.md#installation License -------