.. _`ris-compute-recipes`:

Compute Topics
==============

.. contents::
   :depth: 2
   :local:

Overview
--------

- These pages are use cases and examples of utilization of the RIS Compute Platform and have been separated into different topics.

Advanced Topics
---------------

- The following page describes creating a secure ssh keypair between the RIS Compute Platform and your local machine.
- This sets up for a "password free" login to the RIS Compute Platform.

.. toctree::
    :maxdepth: 2

    recipes/ssh-keypair

- The following describes Docker as it relates to the RIS Compute Platform.

.. toctree::
    :maxdepth: 2

    recipes/docker-on-compute

- The following documentation goes into depth on the options available for running jobs and includes some examples.

.. toctree::
    :maxdepth: 2

    recipes/job-execution-examples

- The following documentation discusses using different queues and the LSF configurations based around that usage.

.. toctree::
    :maxdepth: 2

    recipes/lsf-queues

- The following documentation discusses the differences between slurm and LSF to ease transition between using the different queue systems.

.. toctree::
    :maxdepth: 2

    recipes/slurm-to-lsf

- The following is documentation about using parallel computing on the RIS Compute Platform.

.. toctree::
    :maxdepth: 2

    recipes/parallel-computing

- The following is documentation on the Docker environment variables used within the RIS Compute Platform.

.. toctree::
    :maxdepth: 2

    recipes/docker-wrapper-env-vars

- The following documentation covers frequently asked questions about the Recipes section.

.. toctree::
    :maxdepth: 2

    recipes/recipe-faq

- The following is documentation on using port forwarding with gui docker images on the RIS Compute Platform.

.. toctree::
    :maxdepth: 2

    recipes/port-forwarding-gui

- The following is documentation on the IBM LSF RTM.

.. toctree::
    :maxdepth: 2

    recipes/ris-rtm-web-interface

- The following is documentation on using the Compute Platform for software development.

.. toctree::
    :maxdepth: 2

    workshops/ris-software-development

.. _`ris-compute-recipes-tutorials`:

Application Tutorials
----------------------

- The following pages are tutorials on how to use specific applications on the RIS Compute Platform.

.. toctree::
    :maxdepth: 1

    recipes/tools/ofed-tutorial
    recipes/tools/cuda-tutorial
    recipes/tools/intel-oneapi-tutorial
    recipes/tools/conda-environment-tutorial

Applications and tools
----------------------

- The following are public maintained Docker images that RIS has checked for compatibility with the RIS Compute Platform.

.. Note::

   Not all software has test cases and so the compatibility has been tested to the best ability that RIS can.

.. toctree::
    :maxdepth: 2

    recipes/ris-vetted-compute-apps

- The following are Docker images or Docker files that have been developed in collaboration with RIS staff.

.. toctree::
   :maxdepth: 2

   recipes/ris-supported-containers

Storage on the RIS Compute Platform
-----------------------------------

- The following is documentation about the relationship between the RIS Compute Platform and the RIS Storage Platform.

.. toctree::
    :maxdepth: 2

    recipes/ris-compute-storage-volumes

- The following documentation describes moving data between compute clusters.

.. toctree::
    :maxdepth: 2

    recipes/data-between-computes.rst