Skip to content

Commit

Permalink
update readme and links for 3.10.0 release (engine-3.10)[demos]
Browse files Browse the repository at this point in the history
  • Loading branch information
nastasi-oq committed Sep 29, 2020
1 parent 4be416c commit fc40a4d
Show file tree
Hide file tree
Showing 10 changed files with 45 additions and 50 deletions.
69 changes: 32 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,69 +22,64 @@ 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.10 (Ulomov)

### Current stable
Starting from OpenQuake version 2.0 we have introduced a "code name" to honour earthquake scientists.
The code name for version 3.10 is **Ulomov**, in memory of [Valentin Ivanovich Ulomov](http://www.esc-web.org/component/content/article/european-seismological-commission/175-valentin-ulomov.html).

Current stable version is the **OpenQuake Engine 3.9** 'Taylor'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-3.9#openquake-engine.

* [What's new](https://github.com/gem/oq-engine/blob/engine-3.9/doc/whats-new.md)
* [What's new](https://github.com/gem/oq-engine/blob/engine-3.10/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.10/doc/about.md)
* [FAQ](https://github.com/gem/oq-engine/blob/engine-3.10/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.10/doc/oq-commands.md)
* [Architecture](https://github.com/gem/oq-engine/blob/engine-3.10/doc/sphinx/architecture.rst)
* [Calculation Workflow](https://github.com/gem/oq-engine/blob/engine-3.10/doc/calculation-workflow.md)
* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/engine-3.10/doc/hardware-suggestions.md)
* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/engine-3.10/doc/testing.md)
* [Glossary of Terms](https://github.com/gem/oq-engine/blob/engine-3.10/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.10/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.10/doc/web-api.md)
* [Implementing a new GSIM](https://github.com/gem/oq-engine/blob/engine-3.10/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/README.md)
* [Technology stack and requirements](https://github.com/gem/oq-engine/blob/engine-3.10/doc/requirements.md)
* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/README.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.10/doc/installing/ubuntu.md)
* [Installing on RedHat and derivatives](https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/rhel.md)
* [Installing on other flavors (without sudo)](https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/linux-generic.md)
* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/development.md)
* [Installing on a cluster](https://github.com/gem/oq-engine/blob/engine-3.10/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.10/doc/installing/macos.md)
* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/development.md#macos)

#### Windows

* [Installing on Windows](https://github.com/gem/oq-engine/blob/master/doc/installing/windows.md)
* [Installing from sources](https://github.com/gem/oq-engine/blob/master/doc/installing/development-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.10/doc/installing/windows.md)
* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/development-windows.md)
* [Starting the software](https://github.com/gem/oq-engine/blob/engine-3.10/doc/running/windows.md)

#### 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.10/doc/installing/docker.md)

#### Mirrors

Expand All @@ -94,8 +89,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.10/doc/running/unix.md)
* [Using the WebUI](https://github.com/gem/oq-engine/blob/engine-3.10/doc/running/server.md)

### Visualizing outputs via QGIS

Expand All @@ -109,7 +104,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.10/LICENSE)**.

## Contacts

Expand Down
2 changes: 1 addition & 1 deletion doc/adv-manual/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ 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.10/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.

Expand Down
2 changes: 1 addition & 1 deletion doc/adv-manual/common-mistakes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -230,4 +230,4 @@ to happen when generating tens of thousands of tasks. Again, it is
best not to touch this parameter unless you know what you are doing.

.. _equivalent distance approximation: special-features.html#equivalent-epicenter-distance-approximation
.. _rupture radius: https://github.com/gem/oq-engine/blob/master/openquake/hazardlib/source/point.py
.. _rupture radius: https://github.com/gem/oq-engine/blob/engine-3.10/openquake/hazardlib/source/point.py
4 changes: 2 additions & 2 deletions doc/adv-manual/developing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ development installation in Python: you should clone the engine repository,
create and activate a virtualenv and then perform a `pip install -e .`
from the engine main directory, as normal. You can find the details here:

https://github.com/gem/oq-engine/blob/master/doc/installing/development.md
https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/development.md

It is also possible to develop on Windows (
https://github.com/gem/oq-engine/blob/master/doc/installing/development.md)
https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/development.md)
but very few people in GEM are doing that, so you are on your own, should you
encounter difficulties. We recommend Linux, but Mac also works.

Expand Down
2 changes: 1 addition & 1 deletion doc/adv-manual/parametric-gmpes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -293,4 +293,4 @@ Here `set_between_epsilon` is simply shifting the mean with the formula
will likely grow more methods. If you want to understand how it works you
should look at the source code:

https://github.com/gem/oq-engine/blob/master/openquake/hazardlib/gsim/mgmpe/modifiable_gmpe.py
https://github.com/gem/oq-engine/blob/engine-3.10/openquake/hazardlib/gsim/mgmpe/modifiable_gmpe.py
6 changes: 3 additions & 3 deletions doc/implementing-new-gsim.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,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 GSIM. 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 GSIM. 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.10/openquake/hazardlib/gsim/raghukanth_iyengar_2007.py#L119

- Create tests for the new GSIM using the examples available here
https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/tests/gsim
Expand All @@ -27,7 +27,7 @@ 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.10/doc/sphinx/openquake.hazardlib.gsim.rst

- Check that the new code fulfils PEP 8 standards (usually we do this using tools such as flake8 https://pypi.python.org/pypi/flake8)
https://www.python.org/dev/peps/pep-0008/
Expand All @@ -37,4 +37,4 @@ https://www.python.org/dev/peps/pep-0008/
Therefore assignment statements such as REQUIRES_RUPTURE_PARAMETERS = {'mag'} and REQUIRES_RUPTURE_PARAMETERS = set() are both correct.

- 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.10/debian/changelog following the [Developers notes](updating-the-changelog.md)
2 changes: 1 addition & 1 deletion doc/manual/oqum/hazard/02_outputs.tex
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ \section{Description of hazard outputs}

By default, OpenQuake will export only the statistical results, i.e. mean
curves and quantiles. If the user requires the complete results for all
realizations, there is a flag to specify, please see the FAQ \href{https://github.com/gem/oq-engine/blob/master/doc/faq-hazard.md}{https://github.com/gem/oq-engine/blob/master/doc/faq-hazard.md}.
realizations, there is a flag to specify, please see the FAQ \href{https://github.com/gem/oq-engine/blob/engine-3.10/doc/faq-hazard.md}{https://github.com/gem/oq-engine/blob/engine-3.10/doc/faq-hazard.md}.
Beware that if the logic tree contains a large number of end branches the
process of exporting the results from each end branch can add a significant
amount of time - possibly longer than the computation time - and result in a
Expand Down
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/README.md}{https://github.com/gem/oq-engine/blob/master/doc/installing/README.md}.
\href{https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/README.md}{https://github.com/gem/oq-engine/blob/engine-3.10/doc/installing/README.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.10/doc/running/server.md}{https://github.com/gem/oq-engine/blob/engine-3.10/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/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.10/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.10/README.md#installation

License
-------
Expand Down

0 comments on commit fc40a4d

Please sign in to comment.