mirror of
https://github.com/JHUAPL/Terrasaur.git
synced 2026-01-09 22:37:58 -05:00
54 lines
1.3 KiB
ReStructuredText
54 lines
1.3 KiB
ReStructuredText
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
|
|
~~~~~~~~
|
|
|
|
Packages for use on Mac OS X and Linux are available at ...
|
|
|
|
Windows users may use the Linux package with the `Windows Subsystem for Linux <https://docs.microsoft.com/en-us/windows/wsl/>`__.
|
|
|
|
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.
|
|
|
|
Examples for use are shown at ...
|
|
|
|
Build from source
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
Source code is available at ...
|
|
|
|
Third party libraries are available at ...
|
|
|
|
Contents
|
|
~~~~~~~~
|
|
|
|
.. toctree::
|
|
|
|
tools/index |