diff --git a/docs/citing.md b/docs/citing.md index 5e5adc97..e393c30a 100644 --- a/docs/citing.md +++ b/docs/citing.md @@ -2,4 +2,4 @@ ```{warning} Citation info still to come ... -``` \ No newline at end of file +``` diff --git a/docs/gallery/index.md b/docs/gallery/index.md index 9652398c..197019fb 100644 --- a/docs/gallery/index.md +++ b/docs/gallery/index.md @@ -2,4 +2,4 @@ ```{warning} Gallery examples still to come ... -``` \ No newline at end of file +``` diff --git a/docs/install.md b/docs/install.md index 2b974a5d..30e5b179 100644 --- a/docs/install.md +++ b/docs/install.md @@ -11,7 +11,9 @@ 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: +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 @@ -19,10 +21,11 @@ conda activate invert4geom make install ``` -If you don't have or want `make` or `mamba` installed, you can accomplish the same with the following: +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] -``` \ No newline at end of file +``` diff --git a/docs/overview.md b/docs/overview.md index 20236b84..eef878ef 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -1,7 +1,25 @@ # 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*. +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 anomalous +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. +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. \ No newline at end of file +Currently, this package is only intended to perform inversions using right +rectangular prisms. Other types of volumes, such as tesseroids, are currently +not implemented.