Skip to content

Commit

Permalink
fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
thast committed Oct 2, 2019
1 parent 57cb51a commit 70a5bfc
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
24 changes: 12 additions & 12 deletions content/files/dcipfile.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _dcipfile:

DCIPoctree locations and observations files
===========================================
DCIP3D locations and observations files
=======================================

Locations file
--------------
Expand All @@ -18,19 +18,19 @@ Parameter definitions:
Lines starting with ! are comments.

IPTYPE
A special directive that indicates the IP data type. This directive is only required in IP data files. The IPTYPE enables the IP inversion programs to distinguish the apparent chargeability and other similar IP measurements from the basic secondary potentials.
A special directive that indicates the IP data type. This directive is only required in IP data files. The IPTYPE enables the IP inversion programs to distinguish the apparent chargeability and other similar IP measurements from the basic secondary potentials.

- ``IPTYPE = 1`` is commonly used for IP data in which apparent chargeability is well defined (i.e. using dimensionless apparent chargeability, integrated chargeability, PFE, or phase data acquired using electrode configurations that do not produce zero crossings in the measured total potential). The following are some examples of this type of geometry: any pole-pole array (surface or borehole), surface pole-dipole or dipole-dipole array along the same traverse, gradient arrays where the potential electrodes are parallel to the current electrodes, or borehole pole-dipole or dipole-dipole array with all active electrodes in the same borehole.
- ``IPTYPE = 2`` is used for secondary potential IP data measured using any electrode geometry. This is typically used when cross-line surface data or cross-hole borehole data are inverted. For these array geometries, the apparent chargeability cannot be defined since the total potential can be zero.

- ``IPTYPE = 2`` is used for secondary potential IP data measured using any electrode geometry. This is typically used when cross-line surface data or cross-hole borehole data are inverted. For these array geometries, the apparent chargeability cannot be defined since the total potential can be zero.

- The dimensionless apparent chargeabilities (``IPTYPE = 1``) and the secondary potentials (``IPTYPE = 2``) can be mixed in the same file. Thus an IP data file can have several occurrences of IPTYPE. All the data are treated as the same type following an IPTYPE directive until a new line changes the type.

:math:`XA(i),YA(i),ZA(i)`
Location (X,Y,Z) of the :math:`i^{th}`, current electrode A (measured in metres).

:math:`XB(i),YB(i),ZB(i)`
Location (X,Y,Z) of the :math:`i^{th}`, current electrode B (measured in metres).
Location (X,Y,Z) of the :math:`i^{th}`, current electrode B (measured in metres).

:math:`XM(i,j),YM(i,j),ZM(i,j)`
Location (X,Y,Z) of the :math:`j^{th}` potential electrode M, corresponding with the :math:`i^{th}` current electrode or electrode pair (measured in metres).
Expand All @@ -41,14 +41,14 @@ IPTYPE
:math:`NC`
The total number of current electrodes or electrode pairs.


**NOTE**: The brackets :math:`[\cdots]` indicate that the enclosed parameter is optional. The Z location of the electrodes is optional if you are working only with surface data (i.e. your electrodes are draped to topography) and the IPTYPE only needs to be specified if you are working with IP data.


Examples of a locations file
----------------------------

We provide two example files below. The first file is for a simple surface dataset while the second file shows how borehole data can be incorporated.
We provide two example files below. The first file is for a simple surface dataset while the second file shows how borehole data can be incorporated.

Example of surface data locations:

Expand All @@ -65,9 +65,9 @@ Example with borehole data locations:
Observations file
-----------------

This file is used to specify the current/potential electrode locations along with the observed potential differences (voltages) and their estimated standard deviation. The general format of the observations file is identical to that of the locations file, except for the addition of the voltage and standard deviation columns to the lines specifying the location of potential electrodes M and N.
This file is used to specify the current/potential electrode locations along with the observed potential differences (voltages) and their estimated standard deviation. The general format of the observations file is identical to that of the locations file, except for the addition of the voltage and standard deviation columns to the lines specifying the location of potential electrodes M and N.

**NOTE**: The output of the forward modelling program ``DCIPoctreeFwd`` does not quite have the correct format to be considered an observation file since the final column which is supposed to contain standard deviations for the error is instead replaced with computed apparent conductivities/chargeabilities. To convert the ``DCIPoctreeFwd`` output into an observation file to be used as the input for the inversion code the column of apparent conductivities/chargeabilities needs to be deleted and proper standard deviations need to be assigned.
**NOTE**: The output of the forward modelling program ``DCIPF3D`` does not quite have the correct format to be considered an observation file since the final column which is supposed to contain standard deviations for the error is instead replaced with computed apparent conductivities/chargeabilities. To convert the ``DCIPF3D`` output into an observation file to be used as the input for the inversion code the column of apparent conductivities/chargeabilities needs to be deleted and proper standard deviations need to be assigned.

The following is the file structure of an observation file:

Expand All @@ -91,7 +91,7 @@ The parameter definitions are the same as for a locations file (discussed above)
Examples of an observations file
--------------------------------

We provide two example files below. The first file is for a simple surface dataset while the second file shows how borehole data can be incorporated.
We provide two example files below. The first file is for a simple surface dataset while the second file shows how borehole data can be incorporated.

Example of surface data observations:

Expand Down
4 changes: 2 additions & 2 deletions content/files/weight.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ W.S\ :math:`_{i}`
Cell weight for the :math:`i^{th}` cell of the smallest model component in the :ref:`model objective function <mof>`.

M
The total number of cells in the model and its associated mesh (either octree or tensor).
The total number of cells in the model and its associated mesh.

Within each part, the values are ordered in the same way as in :ref:`model file <modelFile>`, however, they can be all on one line, or broken up over several lines.
Within each part, the values are ordered in the same way as in :ref:`model file <modelFile>`, however, they can be all on one line, or broken up over several lines.

If the topography surface is supplied, the cell weights above the surface will be ignored. It is recommended that these weights be assigned a value of ``-1.0`` to avoid confusion. If ``NO_WEIGHT`` is given in the input files instead of the weights file, then all of the cell weights will be set equal (``1.0``).

Expand Down
2 changes: 1 addition & 1 deletion content/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The initial research underlying this program library was funded principally by t
DCIP3D program library content
------------------------------

The package that can be licensed includes the following executable programs for performing forward modelling, and inversion of 3D DC resistivity or induced polarization (IP) surveys. Additional functionality is included in supplementary utility programs, which can be used to create and refine octree meshes, calculate octree cell centres, remesh octree models, create weighting files, and convert octree model to non-octree model or vise-versa on both: Windows and Linux platforms. The package contains the following programs:
The package that can be licensed includes the following executable programs for performing forward modelling, and inversion of 3D DC resistivity or induced polarization (IP) surveys. Additional functionality is included in supplementary utility programs, which can be used to create weighting files on both Windows and Linux platforms. The package contains the following programs:

- ``DCIPF3D``: Forward model conductivity/chargeability models to calculate data.
- ``DCINV3D``: Invert 3D DC data to develop a conductivity models using a Gauss-Newton method
Expand Down

0 comments on commit 70a5bfc

Please sign in to comment.