=========================
Documentation Resources
=========================

This page provides links to additional documentation resources.


Example Files
=============

Example scripts demonstrating esys-escript usage are available for download:

* `Example Scripts (ZIP) <../escript_examples.zip>`_
* `Example Scripts (TAR.GZ) <../escript_examples.tar.gz>`_

These examples cover topics from the user guide including:

* Basic PDE solving
* Diffusion problems
* Wave equations
* Visualization with weipa
* Parallel computing with MPI


User Guide (PDF)
================

The comprehensive user guide is available as a PDF document:

* `User Guide (PDF) <../user/user.pdf>`_


External Resources
==================

GitHub Repository
-----------------

* `Source Code <https://github.com/LutzGross/esys-escript.github.io>`_
* `Issues and Bug Reports <https://github.com/esys-escript/esys-escript.github.io/issues>`_
* `Releases <https://github.com/esys-escript/esys-escript.github.io/releases>`_


Related Projects
----------------

* `gambit <https://github.com/AndreaCodd/gambit>`_ - Potential Field Data Inversion
* `fingal <https://github.com/LutzGross/fingal>`_ - Electrical Resistivity Data Inversion
* `Yade <https://yade-dem.org/>`_ - Discrete Element Method
* `MINTpy <https://github.com/insarlab/MintPy>`_ - InSAR Time Series Analysis


Third-Party Tools
-----------------

**Mesh Generation:**

* `gmsh <https://gmsh.info/>`_ - 3D finite element mesh generator

**Visualization:**

* `VisIt <https://visit-dav.github.io>`_ - Interactive visualization tool
* `ParaView <https://www.paraview.org/>`_ - Data analysis and visualization
* `Mayavi <https://docs.enthought.com/mayavi/mayavi/>`_ - 3D scientific visualization

**Solver Libraries:**

* `Trilinos <https://trilinos.github.io/>`_ - Parallel solver framework
* `p4est <https://www.p4est.org/>`_ - Adaptive mesh refinement


Publications
============

If you use esys-escript in your research, please consider citing:

* R Schaa, L Gross, J du Plessis, *PDE-based geophysical modelling using finite elements:
  examples from 3D resistivity and 2D magnetotellurics*, Journal of Geophysics and Engineering,
  Volume 13, Issue 2, April 2016, Pages S59-S73.
  `DOI:10.1088/1742-2132/13/2/S59 <https://doi.org/10.1088/1742-2132/13/2/S59>`_

* L. Gross, L. Bourgouin, A.J. Hale, H.-B. Muhlhaus, *Interface modeling in incompressible
  media using level sets in Escript*, Physics of the Earth and Planetary Interiors,
  Volume 163, Issues 1-4, 2007, Pages 23-34.
  `DOI:10.1016/j.pepi.2007.04.004 <https://doi.org/10.1016/j.pepi.2007.04.004>`_
