.. _`matlab-quickstart`:

==================
MATLAB Quick Start
==================

.. 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>`

.. admonition:: Docker Usage

    - The information contained 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>`

.. _`matlab-quickstart-quickstart`:

Quick Start
-----------

.. _`matlab-quickstart-gui`:

Interactive GUI Session
~~~~~~~~~~~~~~~~~~~~~~~

- Interactive GUI sessions are done via Open On Demand (OOD).
    - You can use the ``Matlab`` application.
    - You can also use the ``Compute RIS Desktop`` application.
- You can find out more about OOD here: :ref:`Compute Quick Start <compute-quick-start>`.
- Fill out the fields with the appropriate information (explained in the quick start).
- Launch the job through the methods described in the quick start.
- If you use the ``Matlab`` application, Matlab will be started up automatically.
- If you use the ``Compute RIS Desktop`` application, please follow the steps below.
    - Once in an interactive session using the following commands to load and launch MATLAB.

    .. code::

        module load MATLAB
        matlab

    - Versions available can be seen via the following command.

    .. code::

        module avail MATLAB

.. _`matlab-quickstart-cli`:

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

.. Note::

    If you are a member of more than one compute group, you will be prompted to specify an LSF User Group with ``-G group_name`` or by setting the ``LSB_SUB_USER_GROUP`` variable.

- If you wish to use MATLAB in an interactive command-line session, you can do so via the THPC terminal.
- You can find out about using the THPC terminal :ref:`here.<ris-thpc-quickstart-cli>`
- You load Matlab just like in the OOD version.

.. code::

    module load MATLAB

Earlier Versions:
-----------------

These are previous versions of Matlab that are still available but no longer directly supported. Please refer to the latest version if you would like direct support.

- Standalone Matlab Images:
    - 2022a: `us.gcr.io/ris-appeng-shared-dev/matlab2022a`
    - 2021a: `us.gcr.io/ris-appeng-shared-dev/matlab2021a`
    - 2020b: `us.gcr.io/ris-appeng-shared-dev/matlab2020b`

.. toctree::
    :maxdepth: 1

    deprecated-tools/matlab-thpc-quickstart
    deprecated-tools/matlab-quickstart-deprecated