Improve README file (#10)

* Fix items in the installation file * Fix typo in the documentation readme * Add the van Keken example in the installation file * Add the documentation link in the readme * Replace the repository readme for the documentation readme Because it is easier to have just one readme to modify
ggciag · Jul 22, 2021 · d31a417 · d31a417
1 parent 56c8956
commit d31a417
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 144 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/files/readme.rst → README.rst b/docs/files/readme.rst → README.rst
@@ -8,13 +8,13 @@
 
 About
 -----------
-MANDYOC is a finite element code written written on top of the `PETSc`_ library  to simulate thermo-chemical convection of the Earth's mantle.
+MANDYOC is a finite element code written on top of the `PETSc`_ library  to simulate thermo-chemical convection of the Earth's mantle.
 Different linear and non-linear rheologies can be adopted, appropriately simulating the strain and stress pattern in the Earth's crust and mantle, both in extensional or collisional tectonics.
 
 Documentation
 ----------------------------
 
-On the `Documentation page <https://github.com/ggciag/mandyoc>`__, you will be able to find relevant information on how the code  works, how it was implemented, how to install it, the description of the parameters and input files, some applications and some useful examples.
+On the `Documentation page <https://ggciag.github.io/mandyoc/>`__, you will be able to find relevant information on how the code  works, how it was implemented, how to install it, the description of the parameters and input files, some applications and some useful examples.
 
 Need any help?
 ------------------------

diff --git a/docs/files/installation.rst b/docs/files/installation.rst
@@ -12,11 +12,14 @@ Dependencies
 ------------
 
 * PETSc_
+
 * gcc
+
 * make
+
 * git
 
-*Optional* dependencies:
+**Optional** dependencies:
 
 * `gfortran`
 
@@ -100,6 +103,37 @@ Next, **build and install** MANDYOC by running::
 	To print MANDYOC runtime options, run mandyoc with `-flags` command line
 	argument.
 
+Examples
+---------------
+
+Steps to run the van Keken et al. (1997)
+++++++++++++++++++++++++++++++++++
+
+#. From the `src/` folder, copy the executable to the `examples/vanKeken1997/` folder:
+
+	.. code-block:: bash
+
+		cp mandyoc ../examples/vanKeken1997/
+
+#. Go to the example folder:
+
+	.. code-block:: bash
+
+		cd ../examples/vanKeken1997/
+
+#. Modify the path of the `mpirun` in `run.sh`.
+
+#. Run the `run.sh` script:
+
+	.. code-block:: bash
+
+		sh run.sh
+
+#. To visualize the evolution of the density structure, run:
+
+	.. code-block:: bash
+
+		ipython rho_imshow.py
 
 
 .. _PETSc: https://www.mcs.anl.gov/petsc/

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 
-.. include:: files/readme.rst
+.. include:: ../README.rst
 
 .. toctree::
     :hidden: