.. _qsg_compilation:

Compilation
===========

We provide a script, :program:`install_software`, to compile GAMIT/GLOBK.
You can download this file from the same server as the source code or extract it from the :file:`com.\ |rel|\ .tar.gz` file before running it, e.g. from your :file:`{<source>}` directory:

.. code-block:: console
   :substitutions:

   $ tar xfzv com.|rel|.tar.gz com/install_software
   $ com/install_software

If you downloaded a copy of :program:`install_software` directly from our server you will need to make it executable before running, e.g. from your :file:`{<source>}` directory:

.. code-block:: console

   $ chmod +x install_software

Either way, read carefully the questions the script asks and provide the information it requires.
If the X11 libraries and headers cannot be found automatically, you will need to stop the compilation and edit :file:`libraries/Makefile.config` (in your :file:`{<source>}` directory) before re-running :program:`install_software`.
Specifically, you will need to edit the :content:`X11LIBPATH` and :content:`X11INCPATH` lines near the top of the file;
typical locations for the required files for common operating systems are provided, so you may only need to uncomment the relevant lines, e.g. for macOS:

.. code-block:: text

   X11LIBPATH /usr/X11/lib
   X11INCPATH /usr/X11/include

Once the :program:`install_software` script completes successfully, you will see instructions to set up environment variables to run GAMIT/GLOBK, which is the last step of the installation.