.. _`ris-huygens`:

=======
Huygens
=======

.. contents::
   :depth: 1
   :local:

.. admonition:: Compute Resources

    - Have questions or need help with compute, including activation or issues?
      Follow `this link. <https://washu.atlassian.net/servicedesk/customer/portal/2/group/6/create/43>`__
    - :ref:`User Agreement <compute-user-agreement>`

.. _`ris-huygens-docker`:

.. admonition:: Docker Usage

    - The information on this page assumes that you have a knowledge base of
      using Docker to create images and push them to a repository for use. If
      you need to review that information, please see the links below.
    - :ref:`Docker and the RIS Compute Service <docker-on-compute>`
    - :ref:`Docker Basics: Building, Tagging, & Pushing A Custom Docker Image <ris-docker-basics>`

.. _`ris-huygens-software`:

Image Details
-------------

- huygenspro - https://svi.nl/Huygens-Professional
- hucore (command line interface) - https://svi.nl/Huygens-Core  (This is the only command that will run in the CLI without needing a GUI/display)
- essential - https://svi.nl/Huygens-Essential
- huygensloc - https://svi.nl/Huygens-Localizer

.. _`ris-rhuygens-gui`:

Interactive GUI Session
-----------------------

- Interactions GUI sessions are done via the ``Custom noVNC Image`` application in Open On Demand (OOD).
- You can find out more about OOD here: :ref:`Compute Quick Start <compute-quick-start>`.
- The Docker Image field should be filled in with the information below.

.. code::

    ghcr.io/washu-it-ris/huygens:<tag>

.. _`huygens-docker-tag`:

.. admonition:: Huygens Docker Tag

    The ``<tag>`` will refer to the version of Huygens in the Docker container.

- Fill out the rest of the fields with the appropriate information (explained in the quick start).
- Launch the job through the methods described in the quick start.
- Once in an interactive session use the following commands in the terminal, depending on which version you want.

Huygens Professional

.. code::

    > huygenspro

Huygens Essential

.. code::

    > essential

Huygens Localizer

.. code::

    > huygensloc

- The terminal command and GUI should look like the following.

.. image:: images/huygens.startup.png

.. admonition:: License Information

    - If no trial license or purchased license available, software will run In freeware version.
    - Per SVI support team, manual login is required unless a node-locked license string is properly set up.
    - This functionality does not have a universal solution for the RIS community/cluster at this time.
    - To attempt this solution, license location should be mounted as follows:
        - ``/path/to/huygens_license_folder/:/opt/huygens/huygensLicense``
        - where the license file is named ``huygensLicense``

Interactive Command-Line Session
--------------------------------

- If you wish to use Huygens in an interactive command-line session, you can do so with the following commands.

.. code::

    > bsub -Is -a 'docker(ghcr.io/washu-it-ris/huygens:<tag>)' -q general-interactive /bin/bash

- Once in the container, you can run the command line version of Huygens with the following command.

.. code::

    > hucore

.. _`huygens-versions`:

Available Versions
------------------

Current Versions
~~~~~~~~~~~~~~~~

- ghcr.io/washu-it-ris/huygens
    - 24.10

Earlier Versions
~~~~~~~~~~~~~~~~

Earlier versions are still available but no longer directly supported by RIS.
Please refer to the latest version for direct support.

- ghcr.io/washu-it-ris/huygens
    - 24.04.0