update readme and links for 3.3.0 release (engine-3.3)[demos]

gem · Jan 7, 2019 · 27e3645 · 27e3645
1 parent 253d828
commit 27e3645
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -21,78 +21,74 @@ The **OpenQuake Engine** is an open source application that allows users to comp
 +## Documentation
 -## Documentation (master tree)
 -->
+## OpenQuake Engine version 3.3 (Boschi)
 
-[![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)
-
-### Current stable
-
-Current stable version is the **OpenQuake Engine 3.2** 'Mucciarelli'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-3.2#openquake-engine.
-* [What's new](https://github.com/gem/oq-engine/blob/engine-3.2/doc/whats-new.md)
-
-## Documentation (master tree)
+Starting from OpenQuake version 2.0 we have introduced a "code name" to honour earthquake scientists.
+
+The code name for version 3.3 is **Boschi**, in memory of [Enzo Boschi](https://it.wikipedia.org/wiki/Enzo_Boschi).
+* [What's new](https://github.com/gem/oq-engine/blob/engine-3.3/doc/whats-new.md)
+
+## Documentation
 
 <!-- GEM END -->
 
 ### 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.3/doc/about.md)
+* [FAQ](https://github.com/gem/oq-engine/blob/engine-3.3/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.3/doc/oq-commands.md)
+* [Architecture](https://github.com/gem/oq-engine/blob/engine-3.3/doc/sphinx/architecture.rst)
+* [Calculation Workflow](https://github.com/gem/oq-engine/blob/engine-3.3/doc/calculation-workflow.md)
+* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/engine-3.3/doc/hardware-suggestions.md)
+* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/engine-3.3/doc/testing.md)
+* [Glossary of Terms](https://github.com/gem/oq-engine/blob/engine-3.3/doc/glossary.md)
 
 #### For developers
 
-* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/master/doc/development-guidelines.md)
-* [Developers Notes](https://github.com/gem/oq-engine/blob/master/doc/developers-notes.md)
+* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/engine-3.3/doc/development-guidelines.md)
+* [Developers Notes](https://github.com/gem/oq-engine/blob/engine-3.3/doc/developers-notes.md)
 * [Source Code/API Documentation](http://docs.openquake.org/oq-engine/)
 
 #### For scientists
 
-* [Implementing a new GSIM](https://github.com/gem/oq-engine/blob/master/doc/implementing-new-gsim.md)
+* [Implementing a new GSIM](https://github.com/gem/oq-engine/blob/engine-3.3/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.3/doc/requirements.md)
+* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/engine-3.3/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](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.3/doc/installing/ubuntu.md)
+* [Installing on RedHat and derivatives](https://github.com/gem/oq-engine/blob/engine-3.3/doc/installing/rhel.md)
+* [Installing on other flavors](https://github.com/gem/oq-engine/blob/engine-3.3/doc/installing/linux-generic.md)
+* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.3/doc/installing/development.md)
+* [Installing on a cluster](https://github.com/gem/oq-engine/blob/engine-3.3/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.3/doc/installing/macos.md)
+* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.3/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.3/doc/installing/windows.md)
+* [Starting the software](https://github.com/gem/oq-engine/blob/engine-3.3/doc/running/windows.md)
 
 #### VirtualBox
 
 * [Download OVA appliance](https://downloads.openquake.org/ova/stable/)
 
 #### Docker
 
-* [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.3/doc/installing/docker.md)
 
 ### 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.3/doc/running/unix.md)
+* [Using the WebUI](https://github.com/gem/oq-engine/blob/engine-3.3/doc/running/server.md)
 
 ### Visualizing outputs via QGIS
 
@@ -105,7 +101,7 @@ Current stable version is the **OpenQuake Engine 3.2** 'Mucciarelli'. The docume
 
 ## 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.3/LICENSE)**.
 
 ## Contacts
 

diff --git 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.3/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 @@ nosetests -vsx 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.3/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](developers-notes.md)
+https://github.com/gem/oq-engine/blob/engine-3.3/debian/changelog following the [Developers notes](developers-notes.md)
diff --git a/doc/manual/oqum/introduction.tex b/doc/manual/oqum/introduction.tex
@@ -13,7 +13,7 @@
 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.3/doc/installing/overview.md}{https://github.com/gem/oq-engine/blob/engine-3.3/doc/installing/overview.md}.
 
 An \gls{acr:oqe} analysis is launched from the command line of a terminal.
 

diff --git a/doc/sphinx/architecture.rst b/doc/sphinx/architecture.rst
@@ -121,6 +121,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.3/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
@@ -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.3/README.md#installation
 
 License
 -------

diff --git 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.3/README.md#installation
 
 License
 -------