From 5c50b764cbca91c23ea564af09869a6610c0fa0b Mon Sep 17 00:00:00 2001 From: Matteo Nastasi Date: Wed, 29 Nov 2017 14:59:00 +0100 Subject: [PATCH] update readme and links for 2.8.0 release (engine-2.8) --- README.md | 67 +++++++++++++++----------------- doc/implementing-new-gsim.md | 6 +-- doc/manual/oqum/introduction.tex | 2 +- doc/sphinx/architecture.rst | 2 +- doc/sphinx/intro.rst | 2 +- 5 files changed, 38 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 22fe2e8f128c..382c093c035d 100644 --- a/README.md +++ b/README.md @@ -22,59 +22,56 @@ The **OpenQuake Engine** is an open source application that allows users to comp +* [What's new](https://github.com/gem/oq-engine/blob/engine-2.6/doc/whats-new.md) + +## Documentation --## Documentation (master tree) --> -| Jenkins (Python 2) | Travis CI (Python 3) | -| :---: | :---: | -| [![Build Status](https://ci.openquake.org/job/master_oq-engine/badge/icon)](https://ci.openquake.org/job/master_oq-engine/) | [![Build Status](https://travis-ci.org/gem/oq-engine.svg?branch=master)](https://travis-ci.org/gem/oq-engine) | - -### Current stable - -Current stable version is the **OpenQuake Engine 2.7** 'Housner'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-2.7#openquake-engine. -* [What's new](https://github.com/gem/oq-engine/blob/engine-2.7/doc/whats-new.md) +## OpenQuake Engine version 2.8 (Imamura) -## Documentation (master tree) +Starting from OpenQuake version 2.0 we have introduced a "code name" to honour earthquake scientists. + +The code name for version 2.8 is **Imamura**, in memory of [Akitsune Imamura](https://en.wikipedia.org/wiki/Akitsune_Imamura). +* [What's new](https://github.com/gem/oq-engine/blob/engine-2.8/doc/whats-new.md) + +## 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-2.8/doc/about.md) +* [FAQ](https://github.com/gem/oq-engine/blob/engine-2.8/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) +* [OQ Commands](https://github.com/gem/oq-engine/blob/engine-2.8/doc/oq-commands.md) * [Source Code/API Documentation](http://docs.openquake.org/oq-engine/) -* [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) -* [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) +* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/engine-2.8/doc/development-guidelines.md) +* [Developers Notes](https://github.com/gem/oq-engine/blob/engine-2.8/doc/developers-notes.md) +* [Architecture](https://github.com/gem/oq-engine/blob/engine-2.8/doc/sphinx/architecture.rst) +* [Calculation Workflow](https://github.com/gem/oq-engine/blob/engine-2.8/doc/calculation-workflow.md) +* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/engine-2.8/doc/hardware-suggestions.md) +* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/engine-2.8/doc/testing.md) +* [Glossary of Terms](https://github.com/gem/oq-engine/blob/engine-2.8/doc/glossary.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-2.8/doc/requirements.md) +* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/engine-2.8/doc/installing/overview.md) #### Linux -* [Installing on Ubuntu](https://github.com/gem/oq-engine/blob/master/doc/installing/ubuntu.md) -* [Installing on RedHat and derivates](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-2.8/doc/installing/ubuntu.md) +* [Installing on RedHat and derivates](https://github.com/gem/oq-engine/blob/engine-2.8/doc/installing/rhel.md) +* [Installing on other flavors](https://github.com/gem/oq-engine/blob/engine-2.8/doc/installing/linux-generic.md) +* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-2.8/doc/installing/development.md) +* [Installing on a cluster](https://github.com/gem/oq-engine/blob/engine-2.8/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-2.8/doc/installing/macos.md) +* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-2.8/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-2.8/doc/installing/windows.md) +* [Starting the software](https://github.com/gem/oq-engine/blob/engine-2.8/doc/running/windows.md) #### VirtualBox @@ -82,17 +79,17 @@ Current stable version is the **OpenQuake Engine 2.7** 'Housner'. The documentat #### 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-2.8/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-2.8/doc/running/unix.md) +* [Using the WebUI](https://github.com/gem/oq-engine/blob/engine-2.8/doc/running/server.md) ## 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-2.8/LICENSE)**. ## Contacts diff --git a/doc/implementing-new-gsim.md b/doc/implementing-new-gsim.md index da0dd56c3cd5..5046fbb1f214 100644 --- a/doc/implementing-new-gsim.md +++ b/doc/implementing-new-gsim.md @@ -10,7 +10,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-2.8/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 @@ -23,10 +23,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-2.8/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 +https://github.com/gem/oq-engine/blob/engine-2.8/debian/changelog diff --git a/doc/manual/oqum/introduction.tex b/doc/manual/oqum/introduction.tex index a6823a9d6e31..2c458f7f04a1 100644 --- 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-2.8/doc/installing/overview.md}{https://github.com/gem/oq-engine/blob/engine-2.8/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 index b3465b5415d5..4c0746218986 100644 --- 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-2.8/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/intro.rst b/doc/sphinx/intro.rst index b10e85de653b..b782523ab2da 100644 --- a/doc/sphinx/intro.rst +++ b/doc/sphinx/intro.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-2.8/README.md#installation License -------