Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mdtanker committed Nov 21, 2023
1 parent 315f8f7 commit 1c5c8ce
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 2 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ tesseroids instead of prisms.
See the [overview](overview.md) for further description of this package and what
it can be used for.

The tutorials

<!-- prettier-ignore-start -->
[actions-badge]: https://github.com/mdtanker/invert4geom/workflows/CI/badge.svg
[actions-link]: https://github.com/mdtanker/invert4geom/actions
Expand Down
4 changes: 4 additions & 0 deletions docs/citing.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Citing Invert4geom

```{warning}
Citation info still to come ...
```
4 changes: 4 additions & 0 deletions docs/gallery/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Gallery

```{warning}
Gallery examples still to come ...
```
27 changes: 27 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1 +1,28 @@
# Install

```{warning}
Install instructions still to come ...
```

For now, clone the GitHub repository and change directories into it:

```
git clone https://github.com/mdtanker/invert4geom.git
cd invert4geom
```

assuming you have `Python` and `make` installed, as well as `mamba` (install mamba with `pip install mamba`) installed within your Python environment, run the following to install the package locally:

```
make create
conda activate invert4geom
make install
```

If you don't have or want `make` or `mamba` installed, you can accomplish the same with the following:

```
conda create --name invert4geom --yes --force antarctic-plots python=3.11
conda activate invert4geom
pip install -e .[viz,test,dev,docs]
```
6 changes: 6 additions & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Overview

Invert4geom provides a series of tools for conducting a specific style of gravity inversion. Many gravity inversions aim to model the density distribution of the subsurface. These are commonly used to identify bodies of anomolous densities, such as igneous intrusions or ore deposits. The typical way these are performed is to *discretize* the subsurface into a series of finite volumes, such as cubes or prisms, where the shape of the volumes doesn't change. The inversion then alters the density values of each of these volumes to match the observed gravity anomaly. In these inversions the *density* values changes, while the *geometry* of the volumes remains unchanged. These types of inversions may be referred to as *density inversions*. Here, instead, we are performing *geometric inversions*.

Geometric inversions are essentially the opposite. The density values of the volumes in the discretized model remain unchanged, while their geometry is altered. Here we use layers of vertical right-rectangular prisms and alter their *tops* and *bottoms* during the inversion. Typically use cases for these style of inversion are modeling the topography of the Moho, the contact between sediment and basement, or the shape of the seafloor in locations where it is not easily mapped.

Currently, this package is only intended to perform inversions using right rectangular prisms. Other types of volumes, such as tesseroids, are currently not implemented.

0 comments on commit 1c5c8ce

Please sign in to comment.