Skip to content

Commit

Permalink
deploy: d3dd40e
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jul 18, 2024
0 parents commit 64f09cf
Show file tree
Hide file tree
Showing 126 changed files with 27,380 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -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: beae84f01b19e75435152f4c0aaf1fbe
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added .nojekyll
Empty file.
Binary file added _images/pytomoatt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
332 changes: 332 additions & 0 deletions _modules/index.html

Large diffs are not rendered by default.

442 changes: 442 additions & 0 deletions _modules/pytomoatt/attarray.html

Large diffs are not rendered by default.

477 changes: 477 additions & 0 deletions _modules/pytomoatt/checkerboard.html

Large diffs are not rendered by default.

551 changes: 551 additions & 0 deletions _modules/pytomoatt/data.html

Large diffs are not rendered by default.

550 changes: 550 additions & 0 deletions _modules/pytomoatt/model.html

Large diffs are not rendered by default.

373 changes: 373 additions & 0 deletions _modules/pytomoatt/para.html

Large diffs are not rendered by default.

1,943 changes: 1,943 additions & 0 deletions _modules/pytomoatt/src_rec.html

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions _sources/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
![](_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

```

```{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>
```
48 changes: 48 additions & 0 deletions _sources/installation.md.txt
Original file line number Diff line number Diff line change
@@ -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 .
```
8 changes: 8 additions & 0 deletions _sources/modules/attarray.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

pytomoatt.attarray
===================

.. automodule:: pytomoatt.attarray
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions _sources/modules/checkerboard.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

pytomoatt.checkerboard
=======================

.. automodule:: pytomoatt.checkerboard
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions _sources/modules/data.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

pytomoatt.data
===============

.. automodule:: pytomoatt.data
:members:
:undoc-members:
:show-inheritance:
12 changes: 12 additions & 0 deletions _sources/modules/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Module index

```{toctree}
:maxdepth: 1

para
src_rec/src_rec
data
attarray
model
checkerboard
```
8 changes: 8 additions & 0 deletions _sources/modules/model.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

pytomoatt.model
===============

.. automodule:: pytomoatt.model
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions _sources/modules/para.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

pytomoatt.para
===============

.. automodule:: pytomoatt.para
:members:
:undoc-members:
:show-inheritance:
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.add\_noise
====================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.add_noise
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.append
================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.append
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.calc\_distance
========================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.calc_distance
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.copy
==============================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.copy
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.count\_events\_per\_station
=====================================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.count_events_per_station
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.erase\_duplicate\_events
==================================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.erase_duplicate_events
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.from\_seispy
======================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.from_seispy
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.generate\_double\_difference
======================================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.generate_double_difference
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.geo\_weighting
========================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.geo_weighting
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.plot
==============================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.plot
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.read
==============================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.read
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.rec\_points
=====================================

.. currentmodule:: pytomoatt.src_rec

.. autoproperty:: SrcRec.rec_points
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.rec\_points\_cr
=========================================

.. currentmodule:: pytomoatt.src_rec

.. autoproperty:: SrcRec.rec_points_cr
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.rec\_points\_cs
=========================================

.. currentmodule:: pytomoatt.src_rec

.. autoproperty:: SrcRec.rec_points_cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.remove\_rec\_by\_new\_src
===================================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.remove_rec_by_new_src
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.remove\_specified\_recs
=================================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.remove_specified_recs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.remove\_src\_by\_new\_rec
===================================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.remove_src_by_new_rec
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.reset\_index
======================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.reset_index
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.select\_box\_region
=============================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.select_box_region
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.select\_by\_datetime
==============================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.select_by_datetime
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.select\_depth
=======================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.select_depth
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.select\_distance
==========================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.select_distance
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.select\_phase
=======================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.select_phase
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.src\_points
=====================================

.. currentmodule:: pytomoatt.src_rec

.. autoproperty:: SrcRec.src_points
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.update
================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.update
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.update\_num\_rec
==========================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.update_num_rec
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.write
===============================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.write
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.write\_receivers
==========================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.write_receivers
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pytomoatt.src\_rec.SrcRec.write\_sources
========================================

.. currentmodule:: pytomoatt.src_rec

.. automethod:: SrcRec.write_sources
Loading

0 comments on commit 64f09cf

Please sign in to comment.