Add documentation for quakeT

doc/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 185532c6fbba72181bdb78597cc93e04
+tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/_build/html/_sources/another-feature.md.txt

@@ -0,0 +1,51 @@
+# More features here
+
+
+## Some text
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+
+## Table
+
+| No.  |  Prime |
+| ---- | ------ |
+| 1    |  No    |
+| 2    |  Yes   |
+| 3    |  Yes   |
+| 4    |  No    |
+
+
+
+## Code blocks
+
+The following is a Python code block:
+```python
+  def hello():
+      print("Hello world")
+```
+
+And this is a C code block:
+```c
+#include <stdio.h>
+int main()
+{
+    printf("Hello, World!");
+    return 0;
+}
+```
+
+
+## Math
+
+This creates an equation:
+```{math}
+a^2 + b^2 = c^2
+```
+
+This is an in-line equation, {math}`a^2 + b^2 = c^2`, embedded in text.

doc/_build/html/_sources/contents/auxiliary.rst.txt

@@ -0,0 +1,54 @@
+Auxiliary module
+################################
+
+The :index:`auxiliary` module contains codes that support the development of auxiliary functionalities 
+required for simulating each fundamental phase of the earthquake process. 
+It provides tools for statistical operations, spatial representations, and input/output (I/O) management. 
+Additionally, it includes built-in databases such as ground motion models, correlation models, and other resources 
+essential for the simulation workflow.
+
+Pre-simulation
+*********************************************
+
+The pre-simulation submodule focuses on preparing and managing fault geometries before the main simulation steps. 
+Its core functionalities include:
+
+- **Fault information management**: 
+  Import and modify fault segment data stored in GeoJSON format, including geometrical and attribute handling.
+
+- **Geometry validation**: 
+  Check and validate the geometric consistency of fault segments to ensure accurate meshing and simulation.
+
+- **Triangular meshing**:
+  Generate triangular meshes based on the fault geometry, enabling detailed structural representation.
+
+- **STL file creation**:
+  Convert the meshed fault segments into STL (Stereolithography or Standard Triangle Language) file format, 
+  suitable for 3D visualization and numerical simulations.
+
+
+Post simulation
+*********************************************
+  The post-simulation analysis focuses on processing the earthquake catalog, extracting statistical insights, 
+  and creating visualizations to better understand the seismic event distribution.
+
+- **Catalog processing**: 
+  The earthquake catalog is loaded from a MATLAB `.mat` file. The catalog is then saved as a `.csv` file to facilitate easier access and further processing.
+
+- **Statistical evaluation**: 
+  Key earthquake parameters which are magnitude, rupture area, mean slip, and mean stress drop, are statistically summarized.
+
+- **3D spatial visualization**: 
+  3D scatter plots are created to visualize the spatial distribution of events.
+
+- **Magnitude-frequency distribution (MFD)**: 
+  MFDs of the simulated earthquake catalog are analyzed.
+  Gutenberg-Richter law parameters, specifically the **a-value** and **b-value**, are estimated using various statistical techniques.
+  Then, MFD plots are generated, illustrating the relationship between earthquake magnitude and the cumulative number of events.
+
+
+PSHA
+*********************************************
+PSHA with synthetic catalog ...
+
+

doc/_build/html/_sources/contents/case.rst.txt

@@ -0,0 +1,19 @@
+Case study
+################################
+
+In this part, we will showcase the use of the tools developed within each module in a real case application. 
+
+
+ssc
+*********************************************
+In this part, we will showcase the use of the tools developed within seismic source module in a real case application. 
+
+
+gmc
+*********************************************
+In this part, we will showcase the use of the tools developed within ground motion module in a real case application. 
+
+
+site
+*********************************************
+In this part, we will showcase the use of the tools developed within site and site-effects module in a real case application. 

doc/_build/html/_sources/contents/gmc.rst.txt

@@ -0,0 +1,11 @@
+Ground motion module
+################################
+
+The *ground motion module* will contain functionalities for computing ground motion scalar parameters 
+using ground-motion models (GMMs) implemented into the OQ Engine. 
+The primary functionality required for this module is the GMMs to compute 
+ground motion parameters and their associated uncertainty for scenarios of interest. 
+
+
+
+

doc/_build/html/_sources/contents/ground_motion.rst.txt

@@ -0,0 +1,7 @@
+Auxiliary module
+################################
+
+The :index:`Auxiliary` module contains code for the the simulation of each fundamental step of the earthquake process such as statistical, spatial representation, and input/output (I/O) functionalities. 
+
+Moreover, this auxiliary module will contain the built-in databases. 
+*********************************************

doc/_build/html/_sources/contents/installation.rst.txt

@@ -0,0 +1,42 @@
+Installation
+============
+The **quakeT** is installed with the procedure described in the following. 
+Note that this procedure implies the installation of the OpenQuake engine. 
+It was tested on **Windows**, **Mac OS** and **Linux** systems.
+
+Here we demonstrate the installation of the quakeT for a Windows system and Python 3.12.
+
+* Open a terminal and move to the folder where you intend to install the tools;
+* Upgrade pip:
+
+.. code-block:: ini
+
+    >python -m pip install --upgrade pip
+
+* Install the OpenQuake engine and activate its virtual environment:
+
+.. code-block:: ini
+
+    >git clone https://github.com/GEMScienceTools/quakeT.git
+
+.. code-block:: ini
+
+    >cd oq-engine
+
+.. code-block:: ini
+
+    >python3 install.py devel
+
+.. code-block:: ini
+
+    >openquake/script/activate
+
+* Go to the folder where you cloned the quakeT repository and complete the installation running the following commands, making sure to replace `requirements.txt` with the name of the file corresponding to the correct python version and operating system:
+
+.. code-block:: ini
+
+    >pip install -e .
+
+.. code-block:: ini
+
+    >pip install -r requirements.txt

doc/_build/html/_sources/contents/seismic_source.rst.txt

@@ -0,0 +1,7 @@
+Auxiliary module
+################################
+
+The :index:`Auxiliary` module contains code for the the simulation of each fundamental step of the earthquake process such as statistical, spatial representation, and input/output (I/O) functionalities. 
+
+Moreover, this auxiliary module will contain the built-in databases. 
+*********************************************

doc/_build/html/_sources/contents/site.rst.txt

@@ -0,0 +1,7 @@
+Site and site-effects module
+################################
+
+Within the *site and site-effects module*, functionalities will be developed for modelling the site response.
+
+
+

doc/_build/html/_sources/contents/ssc.rst.txt

@@ -0,0 +1,7 @@
+Seismic source module
+################################
+
+The *seismic source module* will contain codes for evaluating models related to seismic sources.
+
+
+

doc/_build/html/_sources/index.rst.txt

@@ -0,0 +1,45 @@
+.. 
+Welcome to the quakeT documentation!
+====================================
+
+**quakeT** is an initiative of the SIGMA3 project, jointly conducted by the *Électricité de France (EDF)* and the *GEM Foundation*. 
+Its goal is to collect a set of tools for building components of a probabilistic seismic hazard model, 
+generating synthetic datasets, and checking the compatibility between observations and models.
+
+
+quakeT code is hosted on github at the following link: https://github.com/GEMScienceTools/quakeT. 
+It is developed in close connection with the `OpenQuake engine <https://github.com/gem/oq-engine>`_ and other toolkits in `GEMScienceTools <https://github.com/GEMScienceTools>`_ , 
+the open-source hazard and risk calculation engine developed primarily by the GEM Foundation.
+
+
+Currently the quakeT includes five sub-modules:
+
+* **Auxiliary module** is related to the development of the auxiliary functionalities required to support the modules related to the simulation of each fundamental step of the earthquake process such as pre-simulation, post simulation, and PSHA model with synthetic catalogs;
+
+* **Seismic source module** will contain codes for evaluating models related to seismic sources;
+
+* **Ground motion module** will contain functionalities for computing ground motion intensity measures (IMs);
+
+* **Site and site-effects module** will be developed for modelling the site response;
+
+* **Case study module** will showcase the use of the tools developed within each module in a real case application; 
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   contents/installation
+   contents/auxiliary
+   contents/ssc
+   contents/gmc
+   contents/site
+   contents/case
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/_build/html/_sources/some-feature.md.txt

@@ -0,0 +1,14 @@
+# Some feature
+
+## Subsection
+
+Exciting documentation in here.
+Let's make a list (empty surrounding lines required):
+
+- item 1
+
+  - nested item 1
+  - nested item 2
+
+- item 2
+- item 3