Skip to content

Commit 4fd391e

Browse files
committed
Correct spelling and add sections
This commit corrects some spelling and grammar and adds some sections: * Support * Contributing - Building the docs * CSEM ModEM Version * Spherical ModEM Version
1 parent 339603b commit 4fd391e

5 files changed

Lines changed: 309 additions & 111 deletions

File tree

docs/source/contributing.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
Contributing
2+
=========================
3+
4+
Users are welcome to contribute to ModEM and we welcome contributions!
5+
6+
We highly recommend opening a GitHub Issue first so that new contributions can be
7+
discussed with ModEM authors, especially for large pull requests.
8+
9+
Contributions can be made via a `GitHub pull request <_github_pr>`_ at the ModEM
10+
repository: https://github.com/magnetotellurics/ModEM/compare.
11+
12+
.. _github_pr: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
13+
14+
Steps To Open a Pull Request (PR)
15+
----------------------------------
16+
17+
See: `Contributing to a project`_.
18+
19+
.. _Contributing to a project : https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project
20+
21+
Tips & Testing
22+
---------------
23+
24+
* Please keep pull requests to reasonable sizes (consider breaking up large PR's
25+
into small ones)
26+
* If you able, please test your changes using both the GNU gfortran compiler and
27+
Intel ifort repository (but Gfortran at the minimum if you don't have access
28+
to Intel).
29+
* Contribute any relative documentation to this Documentation (See
30+
:ref:`building-the-docs`)
31+
* Run the unit tests in the ``unit_testing`` directory (Currently not added)
32+
33+
.. _building-the-docs:
34+
35+
Building this Documentation
36+
----------------------------
37+
38+
This `Sphinx <_sphinx_page>`_ documentation can easily be built if you have Sphinx installed. If you
39+
have Python and Pip installed, you can install Sphinx by:
40+
41+
.. code-block:: bash
42+
43+
$ pip install -U sphinx
44+
45+
For more information on installing Sphinx see: https://www.sphinx-doc.org/en/master/usage/installation.html.
46+
47+
After making changes to the documentation, you can build locally for testing by doing the following:
48+
49+
.. code-block:: bash
50+
51+
$ cd ModEM/docs
52+
$ make html
53+
54+
The HTML files will be built in ``ModEM/docs/build``. You can open these locally
55+
and view them and ensure they look correct. You do not need to (and will not be
56+
able to) commit the built HTML files.
57+
58+
If you change the documentation, please ensure that it builds without errors.
59+
60+
.. _sphinx_page: https://www.sphinx-doc.org/en/master/

docs/source/csem_modem.rst

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
CSEM Version of ModEM
2+
----------------------
3+
4+
.. warning::
5+
6+
The CSEM version of ModEM is not fully validated and has only been used in
7+
some instances. We cannot guarantee correct or accurately results with it.
8+
9+
Please see the warning above. The CSEM version is really not yet ready for
10+
production, but we are providing it here for future development and testing.
11+
12+
The CSEM version of ModEM is available on the ``CSEM`` branch of ModEM:
13+
14+
.. code-block:: bash
15+
16+
$ git checkout CSEM
17+
18+
The CSEM version requires one of two submodules that are not apart of ModEM:
19+
20+
* Dipole1D - Apart of OCCAM1DCSEM - `provided by SCRIPPS <_dipole1d>`_.
21+
* EM1D - Provided by Rita Streich's - But not yet avaliable for public release.
22+
23+
For more information on the CSEM version of ModEM see the README on the CSEM
24+
branch: https://github.com/magnetotellurics/ModEM/blob/CSEM/README.md
25+
26+
.. _dipole1d: https://marineemlab.ucsd.edu/Projects/Occam/1DCSEM/
27+
28+
29+
Configuring and Compiling with Dipole1D
30+
----------------------------------------
31+
32+
The license associated with Dipole1D disallows us from including it in our
33+
source code; however, the configure script (``/f90/CONFIG/configure``)
34+
contains code to automatically retrieve it for you. The configure script has
35+
the following options:
36+
37+
.. code-block:: bash
38+
39+
$ cd ModEM/f90/
40+
$ ./CONFIG/configure
41+
Usage: ./CONFIG/Configure with the following options:
42+
Compiler: Choose from supported compilers: [ gfortran | ifort ]
43+
Makefile: Provide a name for your output Makefile name.
44+
[Debug or Release]: Choose whether you want to compile the Debug or Release version.
45+
[MPI or Serial]: Choose whether you want to compile the parallel (MPI) or serial version.
46+
[MF or SP or SP2]: Choose between the Matrix Free (MF), or the Modified System of Eqs 1 (SP), or the Modified System of Eqs 2 (SP2) of the code.
47+
[MT or MT+CSEM]: Compile MT or MT+CSEM. In Case of MT+CSEM, choose in the following option whether Dipole1D or EM1D or both will be used to get for the secondary field formulation.
48+
[Dipole1D or EM1D]: (Optional) - Choose whether you have Dipole1D, or EM1D in the source files folder '/3D_MT/CSEM_module'
49+
50+
To configure with Dipole1D run:
51+
52+
.. code-block:: bash
53+
54+
$ cd ModEM/f90
55+
$ ./CONFIG/configure ./CONFIG/Configure gfortran Makefile Release MPI MF MT+CSEM Dipole1D
56+
Dipole1D is not currently in ./3D_MT/CSEM_module/Dipole1D
57+
Would you like to have this script automatically download it now? [Yes/No]
58+
59+
You will be presented with the above prompt, type 'Yes' to automatically
60+
download Dipole1D, then you'll be able to type ``make`` to compile:
61+
62+
.. code-block:: bash
63+
64+
$ make
65+

0 commit comments

Comments
 (0)