Skip to content

Commit

Permalink
update readme and links for 3.7.0 release (engine-3.7) [demos]
Browse files Browse the repository at this point in the history
  • Loading branch information
nastasi-oq committed Sep 26, 2019
1 parent 1b6e059 commit b6bcec1
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 44 deletions.
67 changes: 31 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,72 +22,67 @@ 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

<!-- 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.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

* [Download OVA appliance](https://downloads.openquake.org/ova/stable/)

#### 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

Expand All @@ -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

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions doc/implementing-new-gsim.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
4 changes: 2 additions & 2 deletions doc/manual/oqum/introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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/}.
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion doc/sphinx/baselib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/hazardlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand Down

0 comments on commit b6bcec1

Please sign in to comment.