# 
# RiskScape™ Copyright New Zealand Institute for Earth Science Limited
# (Earth Sciences New Zealand) is distributed for research purposes only
# under the terms of AGPLv3.
# 
# RiskScape™ Copyright 2025 New Zealand Institute for Earth Science
# Limited (Earth Sciences New Zealand). All rights reserved. Source code
# available under the AGPLv3.
# 
# This program is free software: you can redistribute it and/or modify it under
#  the terms of the GNU Affero General Public License as published by the Free
#  Software Foundation, either version 3 of the License, or (at your option) any
#  later version.
# 
# This program is distributed for RESEARCH PURPOSES ONLY, in the hope that it will
# be useful for research and education initiatives.
# 
# If you are not a researcher, or you are a researcher who wishes to use this
# program on terms other than AGPLv3 (including those who wish to restrict the
# distribution of any source code created using this program), please contact:
# https://riskscape.org.nz
# 
# This program is distributed WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Affero General Public License for more details.  You should have received a copy
# of the GNU Affero General Public License along with this program.  If not, see
# <http://www.gnu.org/licenses/>.
# 
# By way of summary only, under the AGPLv3:
#     • Permissions of this strongest copyleft license are conditioned
#       on making available complete source code of licensed works and
#       modifications, which include larger works using a licensed work,
#       under the same license.
#     • Copyright and license notices must be preserved.
#     • Contributors provide an express grant of patent rights.
#     • When a modified version is used to provide a service over a
#       network, the complete source code of the modified version must be made
#       available.
# 
nz.org.riskscape.oq.OpenQuakeResolver.params.mode = \
  A mode to use when accessing the HDF5 data.  This is used to determine what data is exposed and in what format it is \
  returned.  Supports: \n \
  COVERAGE_SITE_IDS - Returns the `sitecol` dataset as a coverage which can be sampled via `sample_centroid` to return \
  the closest side to the given point. \n \
  RELATION_SITE_IDS - Returns a relation of each site alongside a point where that site is located. \n \
  LOOKUP_GMF_BY_SITE - Returns GMF data for any events that affect the given site-ID. \n \
  LOOKUP_EVENT_METADATA - Returns the rupture data (occurrence rate, etc) associated with a given event.

nz.org.riskscape.oq.OpenQuakeResolver.params.source-crs = \
  The coordinate reference system that the `sitecol` dataset is using to reference points.

nz.org.riskscape.oq.OpenQuakeResolver.params.max-site-distance-metres = \
  For COVERAGE_SITE_IDS, this specifies a cut-off distance when finding the closest site. \
  If no site is within the distance specified of the given point, then null is returned.

nz.org.riskscape.oq.OpenQuakeResolver.params.events-dataset-path = \
  The dataset that contains the event data.

nz.org.riskscape.oq.OpenQuakeResolver.params.sitecol-dataset = \
  The dataset that contains the `sitecol`.

nz.org.riskscape.oq.OpenQuakeResolver.params.gmf-indices-dataset-path = \
  The dataset that contains the GMF indices

nz.org.riskscape.oq.OpenQuakeResolver.params.gmf-data-dataset-path = \
  The dataset that contains the GMF data.

nz.org.riskscape.oq.OpenQuakeResolver.params.ruptures-dataset-path = \
  The dataset that contains the ruptures data.
