.. GAMIT/GLOBK documentation master file, created by
   sphinx-quickstart on Wed Mar  6 13:09:47 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. https://www.docutils.org/docs/ref/rst/roles.html
   Only the "code" role can have its syntax highlighting changed by the :language: option
.. role:: console(code)
   :language: console
.. role:: content(code)
   :language: text
.. https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html
 .. role:: file(code)
    :language: console
 .. role:: samp(code)
    :language: text

=======================================
Welcome to GAMIT/GLOBK's documentation!
=======================================

Throughout this documentation, we use syntax highlighting to identify shell :command:`commands`, GAMIT/GLOBK :program:`programs`, program :option:`options`, file :content:`contents`, and file and directory :file:`names`; example or suggested :console:`commands` appear inline or in a box with a shell prompt :console:`$`, e.g.

.. code-block:: console

   $ sh_gamit -d 2024 001

and other boxes contain longer segments of file contents, e.g.

.. code-block:: text

   # This is a text file, like an input control file or output summary file. ***
   #
    Note that these lines are indented with a whitespace character (at least one,
    but no tab characters!), which is important in many GAMIT/GLOBK command files.

The contents of any such text boxes may be copied by hovering over the text box and clicking the copy icon at the top-right.

.. toctree::
   :caption: Quick Start Guide
   :maxdepth: 1

   /quickstart/intro
   /quickstart/prereq
   /quickstart/download
   /quickstart/compilation
   /quickstart/addl_sw
   /test_install/index

.. toctree::
   :caption: Technical Documentation
   :maxdepth: 1

   /intro/index
   GAMIT Reference Manual <http://geoweb.mit.edu/gg/docs/GAMIT_Ref.pdf>
   GLOBK Reference Manual <http://geoweb.mit.edu/gg/docs/GLOBK_Ref.pdf>
   /relnote/index

.. toctree::
   :caption: Examples

.. toctree::
   :caption: Manual Pages
   :maxdepth: 1

.. /man/scripts
.. /man/gamit
.. /man/globk

.. toctree::
   :caption: Unaffiliated External Resources
   :hidden:

   EarthScope Consortium Presentations <https://www.youtube.com/@EarthScope_presentations>
   Eric Lindsey's GAMIT/GLOBK Tutorial <https://www.planetmechanic.net/gamit-globk-tutorial>
   Abdelali Fadil's YouTube Playlist <https://www.youtube.com/playlist?list=PLwvmy9jACWW-2ijMpAFaBW2zEeC_1_SM->

..
 Indices and tables
 ==================

 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`