Skip to content

Commit

Permalink
update README and links for 3.0.0 release (engine-3.0)
Browse files Browse the repository at this point in the history
  • Loading branch information
nastasi-oq committed Apr 9, 2018
1 parent 9134597 commit bc0066f
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 37 deletions.
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,67 +22,67 @@ The **OpenQuake Engine** is an open source application that allows users to comp
-## Documentation (master tree)
-->

[![Build Status](https://travis-ci.org/gem/oq-engine.svg?branch=master)](https://travis-ci.org/gem/oq-engine)
## OpenQuake Engine version 3.0 (Karakhanyan)

### Current stable

Current stable version is the **OpenQuake Engine 2.9** 'Jeffreys'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-2.9#openquake-engine.
* [What's new](https://github.com/gem/oq-engine/blob/engine-2.9/doc/whats-new.md)
Starting from OpenQuake version 2.0 we have introduced a "code name" to honour earthquake scientists.
The code name for version 3.0 is **Karakhanyan**, in memory of [Arkady Karakhanyan](https://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D1%80%D0%B0%D1%85%D0%B0%D0%BD%D1%8F%D0%BD,_%D0%90%D1%80%D0%BA%D0%B0%D0%B4%D0%B8%D0%B9_%D0%A1%D1%82%D0%B5%D0%BF%D0%B0%D0%BD%D0%BE%D0%B2%D0%B8%D1%87).
* [What's new](https://github.com/gem/oq-engine/blob/engine-3.0/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.0/doc/about.md)
* [FAQ](https://github.com/gem/oq-engine/blob/engine-3.0/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-3.0/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-3.0/doc/development-guidelines.md)
* [Developers Notes](https://github.com/gem/oq-engine/blob/engine-3.0/doc/developers-notes.md)
* [Architecture](https://github.com/gem/oq-engine/blob/engine-3.0/doc/sphinx/architecture.rst)
* [Calculation Workflow](https://github.com/gem/oq-engine/blob/engine-3.0/doc/calculation-workflow.md)
* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/engine-3.0/doc/hardware-suggestions.md)
* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/engine-3.0/doc/testing.md)
* [Glossary of Terms](https://github.com/gem/oq-engine/blob/engine-3.0/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-3.0/doc/requirements.md)
* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/engine-3.0/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-3.0/doc/installing/ubuntu.md)
* [Installing on RedHat and derivates](https://github.com/gem/oq-engine/blob/engine-3.0/doc/installing/rhel.md)
* [Installing on other flavors](https://github.com/gem/oq-engine/blob/engine-3.0/doc/installing/linux-generic.md)
* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.0/doc/installing/development.md)
* [Installing on a cluster](https://github.com/gem/oq-engine/blob/engine-3.0/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.0/doc/installing/macos.md)
* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-3.0/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.0/doc/installing/windows.md)
* [Starting the software](https://github.com/gem/oq-engine/blob/engine-3.0/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.0/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.0/doc/running/unix.md)
* [Using the WebUI](https://github.com/gem/oq-engine/blob/engine-3.0/doc/running/server.md)

### Visualizing outputs via QGIS

Expand All @@ -95,7 +95,7 @@ Current stable version is the **OpenQuake Engine 2.9** 'Jeffreys'. The documenta

## 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.0/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 @@ -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-3.0/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 @@ -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-3.0/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-3.0/debian/changelog
2 changes: 1 addition & 1 deletion doc/manual/oqum/introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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.0/doc/installing/overview.md}{https://github.com/gem/oq-engine/blob/engine-3.0/doc/installing/overview.md}.

An \gls{acr:oqe} analysis is launched from the command line of a terminal.

Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.0/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/intro.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.0/README.md#installation

License
-------
Expand Down

0 comments on commit bc0066f

Please sign in to comment.