Skip to content

Commit

Permalink
update readme and links for 3.19.0 release (engine-3.19)[demos]
Browse files Browse the repository at this point in the history
  • Loading branch information
nastasi-oq committed Mar 4, 2024
1 parent 08f091a commit 6b45467
Show file tree
Hide file tree
Showing 12 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The code name for version 3.16 is **Angela**, in memory of the Italian science j

### Latest release - for users needing the latest features

Latest stable version is the **OpenQuake Engine 3.18**.* [What's new](https://docs.openquake.org/oq-engine/master/manual/release-notes/whats-new-3.18.html)
Latest stable version is the **OpenQuake Engine 3.19**.* [What's new](https://docs.openquake.org/oq-engine/master/manual/release-notes/whats-new-3.19.html)

<!-- GEM END -->

Expand Down
2 changes: 1 addition & 1 deletion doc/api-reference/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
https://github.com/gem/oq-engine/blob/engine-3.19/README.md

License
-------
Expand Down
2 changes: 1 addition & 1 deletion doc/api-reference/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
See https://github.com/gem/oq-engine/blob/engine-3.19/README.md

License
-------
Expand Down
4 changes: 2 additions & 2 deletions doc/contributing/developing-with-the-engine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ installation the engine works as any other development installation in Python: y
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:

`gem/oq-engine <https://github.com/gem/oq-engine/blob/master/doc/getting-started/installation-instructions/development.md>`_
`gem/oq-engine <https://github.com/gem/oq-engine/blob/engine-3.19/doc/getting-started/installation-instructions/development.md>`_

It is also possible to develop on Windows (`gem/oq-engine <https://github.com/gem/oq-engine/blob/master/doc/getting-started/installation-instructions/development.md>`_) but very few people in GEM are doing that, so you are on your
It is also possible to develop on Windows (`gem/oq-engine <https://github.com/gem/oq-engine/blob/engine-3.19/doc/getting-started/installation-instructions/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.

Since you are going to develop with the engine, you should also install the development dependencies that by default are
Expand Down
8 changes: 4 additions & 4 deletions doc/contributing/implementing-new-gsim.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Below we provide a concise description of the process to be adopted for the creation of a new GSIM (i.e. GMPE or IPE) in the OpenQuake hazard library.

- Read the [Development guidelines](https://github.com/gem/oq-engine/blob/master/doc/contributing/development-guidelines.md)
- Read the [Development guidelines](https://github.com/gem/oq-engine/blob/engine-3.19/doc/contributing/development-guidelines.md)

- Fork the oq-engine master
https://help.github.com/articles/fork-a-repo
Expand All @@ -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.19/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/api-reference/openquake.hazardlib.gsim.rst
https://github.com/gem/oq-engine/blob/engine-3.19/doc/api-reference/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.19/debian/changelog following the [Developers notes](updating-the-changelog.md)
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ authkey = changeme | authkey = changeme

## Running the tests

To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/master/doc/contributing/testing.md)** page.
To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/engine-3.19/doc/contributing/testing.md)** page.

### Sync the source code with remote

Expand Down
2 changes: 1 addition & 1 deletion doc/getting-started/installation-instructions/rhel.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Continue on [How to run the OpenQuake Engine](unix)

## Test the installation

To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/master/doc/contributing/testing.md)** page.
To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/engine-3.19/doc/contributing/testing.md)** page.

(uninstall-the-openquake-engine)=

Expand Down
2 changes: 1 addition & 1 deletion doc/getting-started/installation-instructions/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ gunicorn -w N wsgi:application

where `N` is the number of workers, we suggest `N = 4`.

*gunicorn* is usually managed by the OS init system. See an example for [systemd](https://github.com/gem/oq-engine/blob/master/debian/systemd/openquake-webui.service).
*gunicorn* is usually managed by the OS init system. See an example for [systemd](https://github.com/gem/oq-engine/blob/engine-3.19/debian/systemd/openquake-webui.service).

### nginx

Expand Down
2 changes: 1 addition & 1 deletion doc/getting-started/installation-instructions/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Continue on [How to run the OpenQuake Engine](unix)

## Test the installation

To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/master/doc/contributing/testing.md)** page.
To run the OpenQuake Engine tests see the **[testing](https://github.com/gem/oq-engine/blob/engine-3.19/doc/contributing/testing.md)** page.

## Uninstall the OpenQuake Engine

Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ maintenance, support, updates, enhancements, or modifications.
Thanks
******

See the list of `contributors <https://github.com/gem/oq-engine/blob/master/CONTRIBUTORS.txt>`_
See the list of `contributors <https://github.com/gem/oq-engine/blob/engine-3.19/CONTRIBUTORS.txt>`_
and `sponsors <https://github.com/gem/oq-engine#thanks>`_.


Expand Down
2 changes: 1 addition & 1 deletion doc/user-guide/configuration-file/risk-calculations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1286,4 +1286,4 @@ uncertainty of the results in the asset loss table, in the column “variance”
in terms of the variance of each asset for the event and intensity level in consideration, extracted from the asset
loss and the coefficients of variation. People interested in the details should look at the implementation in
`gem/oq-engine <https://github.com/gem/oq-engine/blob/master/openquake/risklib/scientific.py>`_.
`gem/oq-engine <https://github.com/gem/oq-engine/blob/engine-3.19/openquake/risklib/scientific.py>`_.
2 changes: 1 addition & 1 deletion doc/user-guide/inputs/ground-motion-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -235,4 +235,4 @@ Here is an example of use in the logic tree file::

Here *set_between_epsilon* is simply shifting the mean with the formula *mean -> mean + epsilon_tau * inter_event*. In
the future ``ModifiableGMPE`` will likely grow more methods. If you want to understand how it works you should look at
the source code: `gem/oq-engine <https://github.com/gem/oq-engine/blob/master/openquake/hazardlib/gsim/mgmpe/modifiable_gmpe.py>`_
the source code: `gem/oq-engine <https://github.com/gem/oq-engine/blob/engine-3.19/openquake/hazardlib/gsim/mgmpe/modifiable_gmpe.py>`_

0 comments on commit 6b45467

Please sign in to comment.