Deploy to GitHub pages

GEMScienceTools · Oct 26, 2023 · 05570a0 · 05570a0
commit 05570a0
Show file tree

Hide file tree

Showing 248 changed files with 29,250 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: aeba5e9eea54eace2327da5758cf23e1
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/Median_Clustering.png b/_images/Median_Clustering.png
diff --git a/_images/Median_Euclidean.png b/_images/Median_Euclidean.png
diff --git a/_images/Median_SammonMaps.png b/_images/Median_SammonMaps.png
diff --git a/_images/ResponseSpectra.png b/_images/ResponseSpectra.png
diff --git a/_images/TrellisPlots.png b/_images/TrellisPlots.png
diff --git a/_images/[BooreEtAl2020]_PGA_AllResPerSite.jpg b/_images/[BooreEtAl2020]_PGA_AllResPerSite.jpg
diff --git a/_images/[BooreEtAl2020]_PGA_IntraResCompPerSite.jpg b/_images/[BooreEtAl2020]_PGA_IntraResCompPerSite.jpg
diff --git a/_images/[BooreEtAl2020]_PGA_bias+sigma.jpeg b/_images/[BooreEtAl2020]_PGA_bias+sigma.jpeg
diff --git a/_images/[BooreEtAl2020]_PGA_likelihood.jpeg b/_images/[BooreEtAl2020]_PGA_likelihood.jpeg
diff --git a/_images/[BooreEtAl2020]_PGA_wrt_depth.jpeg b/_images/[BooreEtAl2020]_PGA_wrt_depth.jpeg
diff --git a/_images/[BooreEtAl2020]_PGA_wrt_dist.jpeg b/_images/[BooreEtAl2020]_PGA_wrt_dist.jpeg
diff --git a/_images/[BooreEtAl2020]_PGA_wrt_mag.jpeg b/_images/[BooreEtAl2020]_PGA_wrt_mag.jpeg
diff --git a/_images/[BooreEtAl2020]_PGA_wrt_vs30.jpeg b/_images/[BooreEtAl2020]_PGA_wrt_vs30.jpeg
diff --git a/_images/all_gmpes_EDR_plot_EDR_correction_factor.jpg b/_images/all_gmpes_EDR_plot_EDR_correction_factor.jpg
diff --git a/_images/all_gmpes_EDR_plot_EDR_value.jpg b/_images/all_gmpes_EDR_plot_EDR_value.jpg
diff --git a/_images/all_gmpes_EDR_plot_MDE.jpg b/_images/all_gmpes_EDR_plot_MDE.jpg
diff --git a/_images/all_gmpes_LLH_plot.jpg b/_images/all_gmpes_LLH_plot.jpg
diff --git a/_images/all_gmpes_PDF_vs_imt_plot.jpg b/_images/all_gmpes_PDF_vs_imt_plot.jpg
diff --git a/_images/contents_sep_docs_tutorials_liq_site_prep_18_0.png b/_images/contents_sep_docs_tutorials_liq_site_prep_18_0.png
diff --git a/_images/contents_sep_docs_tutorials_liq_site_prep_21_0.png b/_images/contents_sep_docs_tutorials_liq_site_prep_21_0.png
diff --git a/_images/contents_sep_docs_tutorials_liq_site_prep_23_0.png b/_images/contents_sep_docs_tutorials_liq_site_prep_23_0.png
diff --git a/_images/contents_sep_docs_tutorials_liq_site_prep_26_0.png b/_images/contents_sep_docs_tutorials_liq_site_prep_26_0.png
diff --git a/_images/contents_sep_docs_tutorials_liq_site_prep_8_0.png b/_images/contents_sep_docs_tutorials_liq_site_prep_8_0.png
diff --git a/_images/contents_sep_docs_tutorials_liquefaction_analysis_12_0.png b/_images/contents_sep_docs_tutorials_liquefaction_analysis_12_0.png
diff --git a/_images/contents_sep_docs_tutorials_liquefaction_analysis_15_0.png b/_images/contents_sep_docs_tutorials_liquefaction_analysis_15_0.png
diff --git a/_images/contents_sep_docs_tutorials_liquefaction_analysis_16_0.png b/_images/contents_sep_docs_tutorials_liquefaction_analysis_16_0.png
diff --git a/_images/contents_sep_docs_tutorials_liquefaction_analysis_21_0.png b/_images/contents_sep_docs_tutorials_liquefaction_analysis_21_0.png
diff --git a/_images/contents_sep_docs_tutorials_liquefaction_analysis_8_0.png b/_images/contents_sep_docs_tutorials_liquefaction_analysis_8_0.png
diff --git a/_images/sigma.png b/_images/sigma.png
diff --git a/_sources/contents/cat.rst.txt b/_sources/contents/cat.rst.txt
@@ -0,0 +1,10 @@
+CAtalogue Toolkit (cat) module
+##############################
+
+The :index:`Catalogue Toolkit` module provides functionalities for the compilation of a homogenised catalogue starting from a collection of catalogues with different origins and magnitudes.
+
+The formats of the original catalogues supported are:
+
+- ISF (see http://www.isc.ac.uk/standards/isf/)
+- GEM Hazard Modeller's Tookit .csv format
+- GCMT .ndk format (see https://www.ldeo.columbia.edu/~gcmt/projects/CMT/catalog/allorder.ndk_explained)s
diff --git a/_sources/contents/ghm.rst.txt b/_sources/contents/ghm.rst.txt
@@ -0,0 +1,18 @@
+Global Hazard Map (ghm) module
+##############################
+
+The :index:`Global Hazard Map` module contains code used to produce homogenised hazard maps using results obtained using a collection of PSHA input models. For the most part this is internal code used by GEM personnel for building various versions of the global seismic hazard maps.
+
+Creating a grid of sites for one of the models
+**********************************************
+Given a model, an almost equally spaced grid of points can be created using the `get_sites.py` tool. Note that this is atool added in 2022. The grids used for the maps created before the end of 2022 were obtained with an inhouse code that we abandoned in favour of the H3 library (see https://h3geo.org/).
+
+1. To learn about the information required by `get_sites.py`, you can run the following::
+
+    > python get_sites.py
+
+2. For example, for the construction of grid of points covering Europe you can use::
+
+   > python get_sites.py 'eur' /tmp/ conf.toml
+
+Note that this requires a configuration file in the .toml format (https://toml.io/en/). An example of configuration file is provided here https://github.com/GEMScienceTools/oq-mbtk/blob/master/openquake/ghm/grid/. It requires: the name of a shapefile (or .geojson) file that provides a mapping between each country and a model in the mosaic, a buffer distance used to add sites around a model and the resolution of the grid, specified as an integer (see https://h3geo.org/docs/core-library/restable).
diff --git a/_sources/contents/installation.rst.txt b/_sources/contents/installation.rst.txt
@@ -0,0 +1,13 @@
+Installation
+============
+The *oq-mbt* is installed with the procedure described in the following. 
+Note that this procedure implies the installation of the OpenQuake engine. 
+It was tested on Mac OS and Linux systems.
+
+* Open a terminal and move to the folder where to intend to install the tools;
+* Create a virtual environment with ``python3 -m venv venv``
+* Activate the virtual environment ``source venv/bin/activate``
+* Update pip ``pip install -U pip``
+* Enter the virtual environment ``cd venv`` and create a directory for storing source code ``mkdir src; cd src``
+* Clone the OpenQuake engine ``git clone [email protected]:gem/oq-engine.git``
+* Complete a development installation with ``cd ..`` then ``pip install -r ./src/oq-engine/requirements-py36-macos.txt`` and finally ``pip install -e ./src/oq-engine/``
diff --git a/_sources/contents/man.rst.txt b/_sources/contents/man.rst.txt
@@ -0,0 +1,21 @@
+Model ANalysis (man) module
+###########################
+
+The :index:`Model Analysis` module contains a number of tools for analyzing various characteristics of hazard input models. Below we provide a description of the main functionalities available. We start with a brief description of the structure of a Probabilistic Seismic Hazard Analysis (PSHA) Input Model for the OpenQuake Engine. 
+
+The structure of a PSHA input model for the OpenQuake engine
+************************************************************
+
+A PSHA Input Model contains two main components: The seismic source characterization and the ground-motion characterization.
+
+The Seismic Source Characterization
+===================================
+
+The :index:`Seismic Source Characterisation` (SSC)  contains the information necessary to describe the location of the earthquake sources, their geometries, the process with which they generate earthquakes and the associated (epistemic) uncertainties.
+
+In its simplest form, the Seismic Source Characterisation contains a Seismic Source Model (i.e. a list of earthquake sources) and the Seismic Source Logic Tree with one Branch Set containing one Branch.
+
+The Ground-Motion Characterization
+==================================
+
+The :index:`Ground-Motion Characterisation` contains the information necessary to describe the models used to compute shaking at the investigated sites for all ruptures admitted by the SSC and the associated epistemic uncertainties.
diff --git a/_sources/contents/mbt.rst.txt b/_sources/contents/mbt.rst.txt
@@ -0,0 +1,14 @@
+Model Building Toolkit (mbt) module
+###################################
+
+The :index:`Model Building Toolkit` module contains code for building a PSHA earthquake occurrence 
+model. The main goals of this tools are to:
+
+1. Streamline the process of building a PSHA earthquake occurrence model
+2. Ensure that the process adopted to build the model is reproducible and 
+   extendable.
+
+Input Datasets and their Format
+*******************************
+
+
diff --git a/_sources/contents/modules.rst.txt b/_sources/contents/modules.rst.txt
@@ -0,0 +1,7 @@
+openquake
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   openquake
diff --git a/_sources/contents/openquake.bin.rst.txt b/_sources/contents/openquake.bin.rst.txt
@@ -0,0 +1,10 @@
+openquake.bin package
+=====================
+
+Module contents
+---------------
+
+.. automodule:: openquake.bin
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/contents/openquake.cat.hmg.rst.txt b/_sources/contents/openquake.cat.hmg.rst.txt
@@ -0,0 +1,69 @@
+openquake.cat.hmg package
+=========================
+
+Submodules
+----------
+
+openquake.cat.hmg.check module
+------------------------------
+
+.. automodule:: openquake.cat.hmg.check
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.hmg.hmg module
+----------------------------
+
+.. automodule:: openquake.cat.hmg.hmg
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.hmg.info module
+-----------------------------
+
+.. automodule:: openquake.cat.hmg.info
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.hmg.map module
+----------------------------
+
+.. automodule:: openquake.cat.hmg.map
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.hmg.merge module
+------------------------------
+
+.. automodule:: openquake.cat.hmg.merge
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.hmg.plot module
+-----------------------------
+
+.. automodule:: openquake.cat.hmg.plot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.hmg.utils module
+------------------------------
+
+.. automodule:: openquake.cat.hmg.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openquake.cat.hmg
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/contents/openquake.cat.parsers.rst.txt b/_sources/contents/openquake.cat.parsers.rst.txt
@@ -0,0 +1,53 @@
+openquake.cat.parsers package
+=============================
+
+Submodules
+----------
+
+openquake.cat.parsers.base module
+---------------------------------
+
+.. automodule:: openquake.cat.parsers.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.parsers.converters module
+---------------------------------------
+
+.. automodule:: openquake.cat.parsers.converters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.parsers.gcmt\_ndk\_parser module
+----------------------------------------------
+
+.. automodule:: openquake.cat.parsers.gcmt_ndk_parser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.parsers.generic\_catalogue module
+-----------------------------------------------
+
+.. automodule:: openquake.cat.parsers.generic_catalogue
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.parsers.isf\_catalogue\_reader module
+---------------------------------------------------
+
+.. automodule:: openquake.cat.parsers.isf_catalogue_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openquake.cat.parsers
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/contents/openquake.cat.rst.txt b/_sources/contents/openquake.cat.rst.txt
@@ -0,0 +1,87 @@
+openquake.cat package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   openquake.cat.hmg
+   openquake.cat.parsers
+   openquake.cat.tests
+
+Submodules
+----------
+
+openquake.cat.catalogue\_query\_tools module
+--------------------------------------------
+
+.. automodule:: openquake.cat.catalogue_query_tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.gcmt\_catalogue module
+------------------------------------
+
+.. automodule:: openquake.cat.gcmt_catalogue
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.gcmt\_utils module
+--------------------------------
+
+.. automodule:: openquake.cat.gcmt_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.isc\_downloader module
+------------------------------------
+
+.. automodule:: openquake.cat.isc_downloader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.isc\_homogenisor module
+-------------------------------------
+
+.. automodule:: openquake.cat.isc_homogenisor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.isf\_catalogue module
+-----------------------------------
+
+.. automodule:: openquake.cat.isf_catalogue
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.regression\_models module
+---------------------------------------
+
+.. automodule:: openquake.cat.regression_models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.utils module
+--------------------------
+
+.. automodule:: openquake.cat.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openquake.cat
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/contents/openquake.cat.tests.completeness.rst.txt b/_sources/contents/openquake.cat.tests.completeness.rst.txt
@@ -0,0 +1,45 @@
+openquake.cat.tests.completeness package
+========================================
+
+Submodules
+----------
+
+openquake.cat.tests.completeness.analysis\_rates\_test module
+-------------------------------------------------------------
+
+.. automodule:: openquake.cat.tests.completeness.analysis_rates_test
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.tests.completeness.analysis\_test module
+------------------------------------------------------
+
+.. automodule:: openquake.cat.tests.completeness.analysis_test
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.tests.completeness.generate\_test module
+------------------------------------------------------
+
+.. automodule:: openquake.cat.tests.completeness.generate_test
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openquake.cat.tests.completeness.norms\_test module
+---------------------------------------------------
+
+.. automodule:: openquake.cat.tests.completeness.norms_test
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openquake.cat.tests.completeness
+   :members:
+   :undoc-members:
+   :show-inheritance: