.. _chap-irmt-settings:

*************
IRMT settings
*************

.. _fig-connection-settings:

.. figure:: images/dialogConnectionSettings.png
    :align: center
    :scale: 60%
    
    |icon-connection-settings| IRMT settings

Some of the functionalities provided by the plugin, such as the ability to work
with GEM data, require the interaction between the plugin itself and the
OpenQuake Platform (OQ-Platform) or the OpenQuake Engine (OQ-Engine).

The OQ-Platform is a web-based portal to visualize, explore and share GEM's
datasets, tools and models. In the :guilabel:`IRMT Settings` dialog displayed
in :numref:`fig-connection-settings`, credentials must be inserted to
authenticate the user and to allow the user to log into the OQ-Platform. In the
:guilabel:`Host` field insert the URL of GEM's production installation of the
`OQ-Platform <https://platform.openquake.org>`_ or a different installation if
you have URL access. If you still haven't registered to use the OQ-Platform,
you can do so by clicking :guilabel:`Register to the OQ-Platform`.  This will
open a new web browser and a `sign up page
<https://platform.openquake.org/account/signup/>`_.

The `OQ-Engine <https://github.com/gem/oq-engine>`_ is an open source
application that allows users to compute seismic hazard and seismic risk of
earthquakes on a global scale. It can run locally on the user's machine, or on
a remote workstation or cluster. The `OQ Engine Server
<https://github.com/gem/oq-engine/blob/master/doc/running/server.md>`_ provides
an HTTP RESTful API. The IRMT plugin leverages this API to enable the user to
drive the OQ-Engine directly from within QGIS. In order to interface the plugin
with a running OQ Engine Server, it is necessary to insert in this dialog the
user credentials (if they are required by the server) and the web URL where the
service is hosted. By default, the host is set to `http://localhost:8800`,
meaning that the plugin will attempt to connect to a OQ Engine Server running
locally, on port `8800`.

The checkbox labeled :guilabel:`Developer mode (requires restart)` can be used
to increase the verbosity of logging. The latter is useful for developers or
advanced users because logging is critical for troubleshooting, but it is not
recommended for standard users.


.. |icon-connection-settings| image:: images/iconConnectionSettings.png