Terrasaur documentation
=============================================

This package contains command line analysis tools contained in Terrasaur.

Prerequisites
~~~~~~~~~~~~~

The Terrasaur package requires Java 21 or later.  Some freely available versions are

* `Amazon Corretto <https://aws.amazon.com/corretto/>`__
* `Azul Zulu <https://www.azul.com/downloads/?package=jdk>`__
* `Eclipse Temurin <https://adoptium.net/>`__
* `OpenJDK <https://jdk.java.net/>`__.  Most Linux distributions and HomeBrew have OpenJDK packages.

Download
~~~~~~~~

Binary packages for use on Mac OS X and Linux are available at ...

We have not tried using the softare on Microsoft Windows, but users may try the Linux package with the `Windows Subsystem for Linux <https://docs.microsoft.com/en-us/windows/wsl/>`__.

Source code and build instructions are available at `GitHub <https://github.com/JHUAPL/Terrasaur>`.

Install
~~~~~~~

::

   cd (your destination directory)
   tar xfz Terrasaur-YYYY.MM.DD.tar.gz

The scripts/ directory contains all of the applications in the package. Running without any arguments will display a usage message.

The doc/ directory contains documentation including a javadoc directory.

Documentation and Examples
~~~~~~~~~~~~~~~~~~~~~~~~~~

`This <tools/index.html>`__ page shows the usage of each utility.

Contents
~~~~~~~~

.. toctree::

   tools/index