Skip to content

Commit 495c782

Browse files
committed
update readme and links for 2.7.0 release (engine-2.7)
1 parent c856c5a commit 495c782

File tree

6 files changed

+37
-40
lines changed

6 files changed

+37
-40
lines changed

README.md

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -25,74 +25,71 @@ The **OpenQuake Engine** is an open source application that allows users to comp
2525
-## Documentation (master tree)
2626
-->
2727

28-
| Jenkins (Python 2) | Travis CI (Python 3) |
29-
| :---: | :---: |
30-
| [![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) |
28+
## OpenQuake Engine version 2.7 (Housner)
3129

32-
### Current stable
30+
Starting from OpenQuake version 2.0 we have introduced a "code name" to honour earthquake scientists.
3331

34-
Current stable version is the **OpenQuake Engine 2.6** 'Gutenberg'. The documentation is available at https://github.com/gem/oq-engine/tree/engine-2.6#openquake-engine.
35-
* [What's new](https://github.com/gem/oq-engine/blob/engine-2.6/doc/whats-new.md)
36-
37-
## Documentation (master tree)
32+
The code name for version 2.7 is **Housner**, in memory of [George Housner](https://en.wikipedia.org/wiki/George_W._Housner).
33+
* [What's new](https://github.com/gem/oq-engine/blob/engine-2.7/doc/whats-new.md)
3834

35+
## Documentation
3936
<!-- GEM END -->
4037

4138
### General overview
4239

43-
* [About](https://github.com/gem/oq-engine/blob/master/doc/about.md)
44-
* [FAQ](https://github.com/gem/oq-engine/blob/master/doc/faq.md)
40+
* [About](https://github.com/gem/oq-engine/blob/engine-2.7/doc/about.md)
41+
* [FAQ](https://github.com/gem/oq-engine/blob/engine-2.7/doc/faq.md)
4542
* [Manuals](http://storage.globalquakemodel.org/openquake/support/documentation/engine/#manual-latest-stable)
46-
* [OQ Commands](https://github.com/gem/oq-engine/blob/master/doc/oq-commands.md)
43+
* [OQ Commands](https://github.com/gem/oq-engine/blob/engine-2.7/doc/oq-commands.md)
4744
* [Source Code/API Documentation](http://docs.openquake.org/oq-engine/)
48-
* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/master/doc/development-guidelines.md)
49-
* [Developers Notes](https://github.com/gem/oq-engine/blob/master/doc/developers-notes.md)
50-
* [Architecture](https://github.com/gem/oq-engine/blob/master/doc/sphinx/architecture.rst)
51-
* [Calculation Workflow](https://github.com/gem/oq-engine/blob/master/doc/calculation-workflow.md)
52-
* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/master/doc/hardware-suggestions.md)
53-
* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/master/doc/testing.md)
54-
* [Glossary of Terms](https://github.com/gem/oq-engine/blob/master/doc/glossary.md)
45+
* [Development Philosophy and Coding Guidelines](https://github.com/gem/oq-engine/blob/engine-2.7/doc/development-guidelines.md)
46+
* [Developers Notes](https://github.com/gem/oq-engine/blob/engine-2.7/doc/developers-notes.md)
47+
* [Architecture](https://github.com/gem/oq-engine/blob/engine-2.7/doc/sphinx/architecture.rst)
48+
* [Calculation Workflow](https://github.com/gem/oq-engine/blob/engine-2.7/doc/calculation-workflow.md)
49+
* [Hardware Suggestions](https://github.com/gem/oq-engine/blob/engine-2.7/doc/hardware-suggestions.md)
50+
* [Continuous integration and testing](https://github.com/gem/oq-engine/blob/engine-2.7/doc/testing.md)
51+
* [Glossary of Terms](https://github.com/gem/oq-engine/blob/engine-2.7/doc/glossary.md)
5552

5653
### Installation
5754

58-
* [Technology stack and requirements](https://github.com/gem/oq-engine/blob/master/doc/requirements.md)
59-
* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/master/doc/installing/overview.md)
55+
* [Technology stack and requirements](https://github.com/gem/oq-engine/blob/engine-2.7/doc/requirements.md)
56+
* [Which installation method should I use?](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/overview.md)
6057

6158
#### Linux
6259

63-
* [Installing on Ubuntu](https://github.com/gem/oq-engine/blob/master/doc/installing/ubuntu.md)
64-
* [Installing on RedHat and derivates](https://github.com/gem/oq-engine/blob/master/doc/installing/rhel.md)
65-
* [Installing on other flavors](https://github.com/gem/oq-engine/blob/master/doc/installing/linux-generic.md)
66-
* [Installing from sources](https://github.com/gem/oq-engine/blob/master/doc/installing/development.md)
67-
* [Installing on a cluster](https://github.com/gem/oq-engine/blob/master/doc/installing/cluster.md)
60+
* [Installing on Ubuntu](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/ubuntu.md)
61+
* [Installing on RedHat and derivates](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/rhel.md)
62+
* [Installing on other flavors](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/linux-generic.md)
63+
* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/development.md)
64+
* [Installing on a cluster](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/cluster.md)
6865

6966
#### macOS
7067

71-
* [Installing on macOS](https://github.com/gem/oq-engine/blob/master/doc/installing/macos.md)
72-
* [Installing from sources](https://github.com/gem/oq-engine/blob/master/doc/installing/development.md#macos)
68+
* [Installing on macOS](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/macos.md)
69+
* [Installing from sources](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/development.md#macos)
7370

7471
#### Windows
7572

76-
* [Installing on Windows](https://github.com/gem/oq-engine/blob/master/doc/installing/windows.md)
77-
* [Starting the software](https://github.com/gem/oq-engine/blob/master/doc/running/windows.md)
73+
* [Installing on Windows](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/windows.md)
74+
* [Starting the software](https://github.com/gem/oq-engine/blob/engine-2.7/doc/running/windows.md)
7875

7976
#### VirtualBox
8077

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

8380
#### Docker
8481

85-
* [Deploy a Docker container](https://github.com/gem/oq-engine/blob/master/doc/installing/docker.md)
82+
* [Deploy a Docker container](https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/docker.md)
8683

8784
### Running the OpenQuake Engine
8885

89-
* [Using the command line](https://github.com/gem/oq-engine/blob/master/doc/running/unix.md)
90-
* [Using the WebUI](https://github.com/gem/oq-engine/blob/master/doc/running/server.md)
86+
* [Using the command line](https://github.com/gem/oq-engine/blob/engine-2.7/doc/running/unix.md)
87+
* [Using the WebUI](https://github.com/gem/oq-engine/blob/engine-2.7/doc/running/server.md)
9188

9289

9390
## License
9491

95-
The OpenQuake Engine is released under the **[GNU Affero Public License 3](https://github.com/gem/oq-engine/blob/master/LICENSE)**.
92+
The OpenQuake Engine is released under the **[GNU Affero Public License 3](https://github.com/gem/oq-engine/blob/engine-2.7/LICENSE)**.
9693

9794
## Contacts
9895

doc/implementing-new-gsim.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/gsim
1010

1111
- Create verification tables following the examples that you find here:
1212
https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/tests/gsim/data
13-
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
13+
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.7/openquake/hazardlib/gsim/raghukanth_iyengar_2007.py#L119
1414

1515
- Create tests for the new GMPE using the examples available here
1616
https://github.com/gem/oq-engine/tree/master/openquake/hazardlib/tests/gsim
@@ -23,10 +23,10 @@ nosetests -vsx openquake.hazardlib
2323
```
2424

2525
- Update the following .rst file (needed to generate automatically documentation):
26-
https://github.com/gem/oq-engine/blob/master/doc/sphinx/openquake.hazardlib.gsim.rst
26+
https://github.com/gem/oq-engine/blob/engine-2.7/doc/sphinx/openquake.hazardlib.gsim.rst
2727

2828
- Check that the new code fulfils PEP8 standards (usually we do this using tools such as flake8 https://pypi.python.org/pypi/flake8)
2929
http://legacy.python.org/dev/peps/pep-0008/
3030

3131
- Update the changelog file
32-
https://github.com/gem/oq-engine/blob/master/debian/changelog
32+
https://github.com/gem/oq-engine/blob/engine-2.7/debian/changelog

doc/manual/oqum/introduction.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
provides a handy guide for users to choose the most appropriate installation
1414
method depending on their intended use cases:
1515

16-
\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}.
16+
\href{https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/overview.md}{https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/overview.md}.
1717

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

doc/sphinx/architecture.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,6 @@ The WebUI provides a REST API that can be used in third party
121121
applications: for instance a QGIS plugin could download the maps
122122
generated by the engine via the WebUI and display them. There is lot
123123
of functionality in the API which is documented here:
124-
https://github.com/gem/oq-engine/blob/master/doc/web-api.md. It is
124+
https://github.com/gem/oq-engine/blob/engine-2.7/doc/web-api.md. It is
125125
possible to build your own user interface for the engine on top of it,
126126
since the API is stable and kept backward compatible.

doc/sphinx/intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ support on IRC channel #openquake on freenode.
3333
Installation
3434
------------
3535

36-
See https://github.com/gem/oq-engine/blob/master/README.md#installation
36+
See https://github.com/gem/oq-engine/blob/engine-2.7/README.md#installation
3737

3838
License
3939
-------

doc/whats-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The WebUI now support groups of user, i.e. you can restrict the access
117117
as you want. The `admin` user sees a link in the WebUI from which she
118118
can directly configure the groups by using the Django admin interface.
119119
System administrators interested in using this feature should read
120-
https://github.com/gem/oq-engine/blob/master/doc/installing/server.md.
120+
https://github.com/gem/oq-engine/blob/engine-2.7/doc/installing/server.md.
121121
By default, no authentication is enabled and everything is visible
122122
to everybody.
123123

0 commit comments

Comments
 (0)