deploy: 2fa71a3

TomoATT · Jul 13, 2024 · a62a4ad · a62a4ad
commit a62a4ad
Show file tree

Hide file tree

Showing 130 changed files with 27,964 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: 5b65c5582b2dc108701ac645b1ed00d1
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/pytomoatt.png b/_images/pytomoatt.png
diff --git a/_modules/index.html b/_modules/index.html
diff --git a/_modules/pytomoatt/attarray.html b/_modules/pytomoatt/attarray.html
diff --git a/_modules/pytomoatt/checkerboard.html b/_modules/pytomoatt/checkerboard.html
diff --git a/_modules/pytomoatt/data.html b/_modules/pytomoatt/data.html
diff --git a/_modules/pytomoatt/model.html b/_modules/pytomoatt/model.html
diff --git a/_modules/pytomoatt/para.html b/_modules/pytomoatt/para.html
diff --git a/_modules/pytomoatt/src_rec.html b/_modules/pytomoatt/src_rec.html
diff --git a/_sources/index.md.txt b/_sources/index.md.txt
@@ -0,0 +1,39 @@
+![](_static/pytomoatt.png)
+
+[![Python Package using Conda](https://github.com/MIGG-NTU/PyTomoATT/actions/workflows/build-test-conda.yml/badge.svg?branch=devel)](https://github.com/MIGG-NTU/PyTomoATT/actions/workflows/build-test-conda.yml)
+[![Build documentations](https://github.com/MIGG-NTU/PyTomoATT/actions/workflows/build-docs.yml/badge.svg?branch=docs)](https://migg-ntu.github.io/PyTomoATT/)
+[![codecov](https://codecov.io/gh/MIGG-NTU/PyTomoATT/branch/devel/graph/badge.svg?token=EYOV0WOA2Y)](https://codecov.io/gh/MIGG-NTU/PyTomoATT)
+
+![PyPI - License](https://img.shields.io/pypi/l/pytomoatt)
+![PyPI](https://img.shields.io/pypi/v/pytomoatt)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytomoatt)
+
+PyTomoATT is a Python module that provides an interface for [TomoATT](https://migg-ntu.github.io/TomoATT-docs/), a software package for seismic tomography analysis. With PyTomoATT, users can create TomoATT projects, manage input data, and generate 3D initial models, 3D checkerboards, and slices of horizontal and vertical cross sections.
+
+```{toctree}
+:maxdepth: 1
+:caption: Getting Start
+:hidden:
+
+installation
+usages/model.md
+usages/ckb.md
+
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: API
+:hidden:
+
+modules/index
+```
+
+
+```{toctree}
+:caption: Links
+:hidden:
+
+TomoATT <https://migg-ntu.github.io/TomoATT-docs/>
+GitHub Repository <https://github.com/MIGG-NTU/PyTomoATT>
+```
diff --git a/_sources/installation.md.txt b/_sources/installation.md.txt
@@ -0,0 +1,48 @@
+# Installation
+
+## Conda environment
+
+We recommend installing PyTomoATT in a conda environment to ensure compatibility with the required dependencies.
+
+```{note}
+If you don't already have Conda installed, you can download and install it from the official Conda website: [https://docs.conda.io/en/latest/miniconda.html](https://docs.conda.io/en/latest/miniconda.html)
+```
+
+### Create a new Conda environment
+
+Create a new Conda environment for Pytomoatt with the following command:
+```
+conda create -n pytomoatt python=3.11
+```
+
+This creates a new environment named "pytomoatt" with Python version 3.10 installed.
+
+
+### Activate the Conda environment
+
+Activate the newly created environment with the following command:
+
+```
+conda activate pytomoatt
+```
+
+## Installing stable version via PyPI
+
+```
+pip install pytomoatt
+```
+
+## Installing development version from source
+
+- Clone the repository
+
+Users can install PyTomoATT from the source code available on GitHub. First, clone the PyTomoATT repository:
+```
+git clone --branch=devel https://github.com/MIGG-NTU/PyTomoATT.git
+```
+
+- Install using `pip`
+
+```
+pip install .
+```
diff --git a/_sources/modules/attarray.rst.txt b/_sources/modules/attarray.rst.txt
@@ -0,0 +1,10 @@
+
+pytomoatt.attarray
+===================
+
+Submodule of ``xarray.Dataset`` for handling array data, which can be generated from ``pytomoatt.module.ATTModel.to_array`` and ``pytomoatt.data.ATTData.to_array``.
+
+.. automodule:: pytomoatt.attarray
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/_sources/modules/checkerboard.rst.txt b/_sources/modules/checkerboard.rst.txt
@@ -0,0 +1,10 @@
+
+pytomoatt.checkerboard
+=======================
+
+Module for generating checkerboard model.
+
+.. automodule:: pytomoatt.checkerboard
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/_sources/modules/data.rst.txt b/_sources/modules/data.rst.txt
@@ -0,0 +1,10 @@
+
+pytomoatt.data
+===============
+
+Module for handling middleware array data, including kernel, kernel density, and traveltime field, etc. 
+
+.. automodule:: pytomoatt.data
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/_sources/modules/index.md.txt b/_sources/modules/index.md.txt
@@ -0,0 +1,12 @@
+# Module index
+
+```{toctree}
+:maxdepth: 1
+
+para
+src_rec/src_rec
+data
+model
+attarray
+checkerboard
+```
diff --git a/_sources/modules/model.rst.txt b/_sources/modules/model.rst.txt
@@ -0,0 +1,10 @@
+
+pytomoatt.model
+===============
+
+Module for handling model data.
+
+.. automodule:: pytomoatt.model
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/_sources/modules/para.rst.txt b/_sources/modules/para.rst.txt
@@ -0,0 +1,8 @@
+
+pytomoatt.para
+===============
+
+.. automodule:: pytomoatt.para
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.add_noise.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.add_noise.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.add\_noise
+====================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.add_noise
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.append.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.append.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.append
+================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.append
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.calc_distaz.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.calc_distaz.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.calc\_distaz
+======================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.calc_distaz
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.copy.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.copy.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.copy
+==============================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.copy
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.count_events_per_station.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.count_events_per_station.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.count\_events\_per\_station
+=====================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.count_events_per_station
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.erase_duplicate_events.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.erase_duplicate_events.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.erase\_duplicate\_events
+==================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.erase_duplicate_events
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.from_seispy.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.from_seispy.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.from\_seispy
+======================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.from_seispy
diff --git a/...ces/modules/src_rec/pytomoatt.src_rec.SrcRec.generate_double_difference.rst.txt b/...ces/modules/src_rec/pytomoatt.src_rec.SrcRec.generate_double_difference.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.generate\_double\_difference
+======================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.generate_double_difference
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.geo_weighting.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.geo_weighting.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.geo\_weighting
+========================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.geo_weighting
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.plot.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.plot.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.plot
+==============================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.plot
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.read.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.read.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.read
+==============================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.read
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.rec_points.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.rec_points.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.rec\_points
+=====================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. autoproperty:: SrcRec.rec_points
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.rec_points_cr.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.rec_points_cr.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.rec\_points\_cr
+=========================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. autoproperty:: SrcRec.rec_points_cr
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.rec_points_cs.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.rec_points_cs.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.rec\_points\_cs
+=========================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. autoproperty:: SrcRec.rec_points_cs
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_rec_by_new_src.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_rec_by_new_src.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.remove\_rec\_by\_new\_src
+===================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.remove_rec_by_new_src
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_specified_recs.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_specified_recs.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.remove\_specified\_recs
+=================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.remove_specified_recs
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_src_by_new_rec.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.remove_src_by_new_rec.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.remove\_src\_by\_new\_rec
+===================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.remove_src_by_new_rec
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.reset_index.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.reset_index.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.reset\_index
+======================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.reset_index
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_box_region.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_box_region.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.select\_by\_box\_region
+=================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.select_by_box_region
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_datetime.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_datetime.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.select\_by\_datetime
+==============================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.select_by_datetime
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_depth.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_depth.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.select\_by\_depth
+===========================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.select_by_depth
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_distance.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_distance.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.select\_by\_distance
+==============================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.select_by_distance
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_phase.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.select_by_phase.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.select\_by\_phase
+===========================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.select_by_phase
diff --git a/...dules/src_rec/pytomoatt.src_rec.SrcRec.select_one_event_in_each_subgrid.rst.txt b/...dules/src_rec/pytomoatt.src_rec.SrcRec.select_one_event_in_each_subgrid.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.select\_one\_event\_in\_each\_subgrid
+===============================================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.select_one_event_in_each_subgrid
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.src_points.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.src_points.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.src\_points
+=====================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. autoproperty:: SrcRec.src_points
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.update.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.update.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.update
+================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.update
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.update_num_rec.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.update_num_rec.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.update\_num\_rec
+==========================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.update_num_rec
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.write.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.write.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.write
+===============================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.write
diff --git a/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.write_receivers.rst.txt b/_sources/modules/src_rec/pytomoatt.src_rec.SrcRec.write_receivers.rst.txt
@@ -0,0 +1,6 @@
+pytomoatt.src\_rec.SrcRec.write\_receivers
+==========================================
+
+.. currentmodule:: pytomoatt.src_rec
+
+.. automethod:: SrcRec.write_receivers