Welcome to ALMA OT tarball / zip file
=====================================

Installing the ALMA OT on Linux
-------------------------------

1. Open a terminal and extract the ALMA OT tarball

    tar xf alma-ot-c12-linux-jre-x64.tgz

2. Change directory into the setup directory and execute the `setup-unix.sh` shell script

    cd alma-ot-c12/setup
    ./setup-unix.sh
    cd ..

3. Launch the ALMA OT application from the command line

    ./alma-ot.sh

Tip: You could add the installation directory to your PATH, and/or setup an alias to execute the
script.

Please Note: If you are planning to work on large proposals (e.g. including many sources and/or
science goals) or on a Large Program you may consider increasing the maximum heap space memory
size. This will improve the performance and usability of the ALMA OT application.

The default value is typically 8 G but you can increase the maximum heap size by using the
command line option --max-heap-size. In this example we increase maximum heap space memory
size to 16 G. You can set it to higher values but please keep in mind the maximum memory
available on your computer:

   ./alma-ot.sh --max-heap-size 16

Installing the ALMA OT on MacOS
-------------------------------

Apple has introduced security measure which makes it more difficult to install unsigned software.
Therefore we recommend the following steps.

1. Install the Java runtime environment (JRE) from the eclipse foundation. They provide JRE for
   both modern (Apple aarch64 CPU) and older (Intel x64 CPU) generation hardware. It is advisable
   download the '.pkg' package because it is easier to install on your system. You can find the
   latest JRE 17 release at the following:

     https://adoptium.net/en-GB/temurin/releases/?os=mac&package=jre&version=17

2. After downloading the JRE software package. Double click on the file and it will open an
   installer application. Follow the instructions in the installer to complete the installation
   of JRE.

3. Open a terminal and extract the ALMA OT tarball

    tar xf alma-ot-c12.tgz

4. Change directory into the setup directory and execute the `setup-unix.sh` shell script

    cd alma-ot-c12/setup
    bash ./setup-unix.sh
    cd ..

5. Launch the ALMA OT application from the command line

    bash ./ALMA-OT.command

6. Or launch the ALMA OT application from finder by opening the application directory and double
   clicking on the `ALMA-OT.command` icon

Tip: You could add the installation directory to your PATH, and/or setup an alias to execute the
script.

Please Note: If you are planning to work on large proposals (e.g. including many sources and/or
science goals) or on a Large Program you may consider increasing the maximum heap space memory
size. This will improve the performance and usability of the ALMA OT application.

The default value is typically 8 G but you can increase the maximum heap size by using the
command line option --max-heap-size. In this example we increase maximum heap space memory
size to 16 G. You can set it to higher values but please keep in mind the maximum memory
available on your computer:

   bash ./ALMA-OT.command --max-heap-size 16

Installing the ALMA OT on Windows
---------------------------------

1. Right click on the `alma-ot-c12-windows-jre-x64.zip` file and select "Extract All..." to
   extract the contents
2. Go to the `alma-ot-c12/setup` directory
3. Double click `setup-windows` (may read `setup-windows.cmd`).
4. Go back to the `alma-ot-c12` directory
5. Double click `ALMA-OT` (may read `ALMA-OT.cmd`).

Please Note: If you have windows defender running on your windows OS you may see a pop-up window
warning you that "Microsoft Defender SmartScreen prevented an unrecognised app from starting."
Click on the "More info" link and then click on the "Run anyway" button to run the ALMA OT
application.

Tip: You could create a desktop or start menu shortcut, and assign them an icon of your choice.

Viewing Help
------------

The help documents (Cook Book, User Guide, and others) are available from within the OT "Help"
menu.

Troubleshooting
---------------

Please check the Troubleshooting section on the webpage from which you downloaded this tarball /
zip file, it contains information specific to this OT version.

Also, you can find a log file with output from the ALMA OT here:

1. MS Windows

    %USERPROFILE%\.almaot\ot.log 

    USERPROFILE typically points to "c:\documents and settings\yourname"

2. Linux / MacOS

    $HOME/.almaot/ot.log
