From 53865c92200d77822dd8d9c7e9ce3d145aa75a67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniele=20Vigan=C3=B2?= Date: Wed, 14 Jun 2017 11:13:23 +0200 Subject: [PATCH] update links and README for 2.5.0 release --- README.md | 58 ++++++++++++++++++------------------- doc/sphinx/architecture.rst | 2 +- 2 files changed, 29 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 9cfaf751735c..1555d4c339b0 100644 --- a/README.md +++ b/README.md @@ -22,54 +22,52 @@ The **OpenQuake Engine** is an open source application that allows users to comp -## 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) | +Starting from OpenQuake version 2.0 we have introduced a "code name" to honour earthquake scientists. ### Current stable -Current stable version is the **OpenQuake Engine 2.4** 'Ewing'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-2.4#openquake-engine. -* [What's new](https://github.com/gem/oq-engine/blob/engine-2.4/doc/whats-new.md) +The code name for version 2.5 is **Fourier**, in memory of [Joseph Fourier](https://en.wikipedia.org/wiki/Joseph_Fourier). +* [What's new](https://github.com/gem/oq-engine/blob/engine-2.5/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-2.5/doc/about.md) +* [FAQ](https://github.com/gem/oq-engine/blob/engine-2.5/doc/faq.md) * [Manuals](http://www.globalquakemodel.org/openquake/support/documentation/engine/#manual-latest-stable) * [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.5/doc/development-guidelines.md) +* [Developers Notes](https://github.com/gem/oq-engine/blob/engine-2.5/doc/developers-notes.md) +* [Architecture](https://github.com/gem/oq-engine/blob/engine-2.5/doc/sphinx/architecture.rst) +* [Calculation Workflow](https://github.com/gem/oq-engine/blob/engine-2.5/doc/calculation-workflow.md) +* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/engine-2.5/doc/hardware-suggestions.md) +* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/engine-2.5/doc/testing.md) +* [Glossary of Terms](https://github.com/gem/oq-engine/blob/engine-2.5/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.5/doc/requirements.md) +* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/engine-2.5/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.5/doc/installing/ubuntu.md) +* [Installing on RedHat and derivates](https://github.com/gem/oq-engine/blob/engine-2.5/doc/installing/rhel.md) +* [Installing on other flavors](https://github.com/gem/oq-engine/blob/engine-2.5/doc/installing/linux-generic.md) +* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-2.5/doc/installing/development.md) +* [Installing on a cluster](https://github.com/gem/oq-engine/blob/engine-2.5/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) +* [Installing on macOS](https://github.com/gem/oq-engine/blob/engine-2.5/doc/installing/macos.md) +* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-2.5/doc/installing/development.md) #### 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.5/doc/installing/windows.md) +* [Starting the software](https://github.com/gem/oq-engine/blob/engine-2.5/doc/running/windows.md) #### VirtualBox @@ -77,17 +75,17 @@ Current stable version is the **OpenQuake Engine 2.4** 'Ewing'. The documentatio #### 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.5/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.5/doc/running/unix.md) +* [Using the WebUI](https://github.com/gem/oq-engine/blob/engine-2.5/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.5/LICENSE)**. ## Contacts diff --git a/doc/sphinx/architecture.rst b/doc/sphinx/architecture.rst index b3465b5415d5..a588ac79a4bb 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.5/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.