Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leonfoks committed Oct 11, 2024
1 parent a88b0ee commit dd44686
Show file tree
Hide file tree
Showing 9 changed files with 5 additions and 1,535 deletions.
3 changes: 2 additions & 1 deletion docs/_sources/content/getting_started/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ If you require parallel file reading and writing, you will also need to install

If you need to install the parallel IO version of the code, we would recommend that you start with a clean install of Python. This makes it easier to determine whether you have installed and linked the correct version of the parallel HDF5 library.


There are two versions when installing GeoBIPy, a serial version, and a parallel version. Since GeoBIPy uses a Fortran backend for forward modelling frequency domain data, you will need to have a Fortran compiler installed. Make sure that the compiler can handle derived data types since I make use of object oriented programming in Fortran.


Installing a serial version of GeoBIPy
======================================
This is the easiest installation and provides access to a serial implementation of the code.
Expand All @@ -28,6 +28,7 @@ You should then be able to import modules from geobipy. For this type of instal

**Side note:** Let's say you ran a production run on a parallel machine with MPI and parallel HDF capabilities. You generated all the results, copied them back to your local machine, and wish to make plots and images. You will only need to install the serial version of the code on your local machine to do this.


Installing a parallel version of GeoBIPy
========================================
Installing the parallel version of the code is a little trickier due to the dependencies necessary between the OpenMPI and/or HDF libraries, and how Python's mpi4py and h5py wrap around those.
Expand Down
4 changes: 1 addition & 3 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,9 @@ Application outside of these data types is in development.
Currently there are two types of data that we have implemented; frequency domain electromagnetic data,
and time domain electromagnetic data.
The package comes with a frequency domain forward modeller, but it does not come with a time domain forward modeller.
See the section :ref:`Installing_time_domain_forward_modeller` for more information.


.. toctree::
:maxdepth: 2
:caption: Contents:
content/api/api
content/getting_started

1 change: 0 additions & 1 deletion docs/content/getting_started/getting_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
<title>Getting Started &mdash; geobipy 2.3.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=fd3f3429" />


<!--[if lt IE 9]>
Expand Down
1 change: 0 additions & 1 deletion docs/content/getting_started/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
<title>Installing GeoBIPy &mdash; geobipy 2.3.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=fd3f3429" />


<!--[if lt IE 9]>
Expand Down
1,524 changes: 0 additions & 1,524 deletions docs/genindex.html

Large diffs are not rendered by default.

4 changes: 1 addition & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
<title>Welcome to GeoBIPy: Geophysical Bayesian Inference in Python &mdash; geobipy 2.3.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />


<!--[if lt IE 9]>
Expand Down Expand Up @@ -80,8 +79,7 @@ <h1>Welcome to GeoBIPy: Geophysical Bayesian Inference in Python<a class="header
Application outside of these data types is in development.</p>
<p>Currently there are two types of data that we have implemented; frequency domain electromagnetic data,
and time domain electromagnetic data.
The package comes with a frequency domain forward modeller, but it does not come with a time domain forward modeller.
See the section <a class="reference internal" href="content/getting_started/installation.html#installing-time-domain-forward-modeller"><span class="std std-ref">Installing the time domain forward modeller</span></a> for more information.</p>
The package comes with a frequency domain forward modeller, but it does not come with a time domain forward modeller.</p>
</section>


Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
1 change: 0 additions & 1 deletion docs/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
<title>Search &mdash; geobipy 2.3.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />



Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

0 comments on commit dd44686

Please sign in to comment.