MSI User Documentation
======================

The `Minnesota Supercomputing Institute (MSI) <https://msi.umn.edu/>`__ provides high performance computing, interactive computing, data storage, software, and research support for eligible faculty, staff, and students at the University of Minnesota.

This site focuses on how to use MSI systems day to day. For account requests, eligibility, service descriptions, and policy information, use the `main MSI website <https://msi.umn.edu/>`__.

.. note::
   MSI systems are only accessible from the UMN network. On campus, connect to ``eduroam`` or wired ethernet. Off campus, connect to the `UMN VPN <https://it.umn.edu/services-technologies/virtual-private-network-vpn>`__ before attempting to log in.

More information on our support staff can be found on `this page <msi_help>`__.

.. Tip:: Requests for additional topics or questions can be directed to our email help@msi.umn.edu.

Start Here
----------

If you are new to MSI, this sequence covers the basics:

1. :doc:`Get Started with MSI <new_users/getting-started>` for account eligibility, PI groups, and allocations.
2. :doc:`Use MyMSI <new_users/mymsi>` for group management, user agreements, primary group changes, and account settings.
3. :doc:`Learn MSI terminology <new_users/msi-terminology>` for common terms such as partitions, modules, and Tier 1/Tier 2 storage.
4. :doc:`Choose a connection method <connect/connect_login>` to use Open OnDemand, SSH, X11, or Citrix. Most new users should start with Open OnDemand.
5. :doc:`Connect to interactive compute <compute/interactive_compute>` or :doc:`submit Slurm jobs <compute/slurm_job_submission>` for batch workloads.
6. :doc:`Review storage options <storage/storage>` and :doc:`software access <software/software_modules>` before moving data or building environments.

Common Tasks
------------

If you were recently invited to join an MSI project, we recommend visiting these pages to get familiar with connecting and performing data transfers into MSI systems.

- :doc:`Open OnDemand support <compute/open-ondemand-support>` for browser-based desktops, shell access, file management, and interactive applications.
- :doc:`Connecting to Compute <connect/connect_compute>` to access running jobs from login nodes, Open OnDemand, or VS Code.
- :doc:`Job sizing and resource efficiency <compute/job_sizing>` to request the right amount of CPU, memory, and time.
- :doc:`Using a private partition <compute/private_partitions>` for labs with dedicated compute nodes and lab-specific queues.
- :doc:`File Storage <storage/storage>` for a comparison of home, project, scratch, and Tier 2 storage options.
- `MSI software catalog <https://msi.umn.edu/software/msi-software>`__ to find installed applications and module names.
- `MSI tutorials <https://msi.umn.edu/tutorials>`__ and the `MSI YouTube channel <https://www.youtube.com/@UofMMSI/videos>`__ for live and recorded training.

Access and Services
-------------------

- `Request MSI access <https://mymsi.msi.umn.edu/onboard/start>`__ if you are an eligible UMN faculty member.
- `Review MSI getting started information <https://msi.umn.edu/our-resources/getting-started>`__ for eligibility and onboarding details.
- `Learn about MSI high performance computing <https://msi.umn.edu/about-msi-services/high-performance-computing>`__ and `data storage services <https://msi.umn.edu/about-msi-services/data-storage>`__.
- `See the MSI service catalog <https://msi.umn.edu/about-msi-services/service-catalog>`__ for purchasable or specialized services.

Getting Help
------------

- Use the search box in the left sidebar to quickly find commands, references, and how-to pages.
- Visit :doc:`MSI Support Staff <msi_help>` for ticket guidance, office hours, phone support, and support channels.
- Check the `MSI status page <https://status.msi.umn.edu/posts/dashboard>`__ for maintenance notices and current service issues.
- Email `help@msi.umn.edu <mailto:help@msi.umn.edu>`__ to open a support ticket if you cannot find an answer here.
- MSI staff schedule hybrid instructional sessions year round on a range of topics. Recorded sessions are posted on the `MSI YouTube Channel <https://www.youtube.com/@UofMMSI/videos>`__

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   new_users/getting-started
   new_users/mymsi
   new_users/collaborators
   new_users/msi-terminology
   msi_help

.. toctree::
   :maxdepth: 1
   :caption: Connecting

   connect/connect_login
   connect/ssh_keys
   connect/connect_compute

.. toctree::
   :maxdepth: 1
   :caption: Compute

   compute/cluster_info
   compute/env_variables
   compute/interactive_compute
   compute/slurm_job_submission
   compute/open-ondemand-support
   compute/private_partitions
   compute/job_sizing

.. toctree::
   :maxdepth: 1
   :caption: Storage

   storage/storage
   storage/archiving_data
   storage/filezilla
   storage/manage_tier1
   storage/scratch_global
   storage/beeond
   storage/tier-2-data-management
   storage/transferring_data

.. toctree::
   :maxdepth: 1
   :caption: Software

   software/software_modules
   software/package_docs/index
   software/best-practices-conda
   software/best-practices-r
   software/galaxy
   software/r_packages/index
   software/license_reservations/index