Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions source/access.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Access to subMIT
Access to SubMIT
----------------

.. tags:: JupyterHub, VSCode, GPU

You have several options to connect to subMIT, view and edit your files, and do your work.
You have several options to connect to SubMIT, view and edit your files, and do your work.

1. **ssh** is the simplest way to connect to the login nodes, see `the starting guide <https://submit.mit.edu/submit-users-guide/starting.html>`_.
2. **`JupyterHub <https://submit.mit.edu/jupyter/hub/spawn>_`** provides another easy alternative to connect to the cluster. You can log in using your Kerberos ID, and get access to an interactive graphical interface, terminal, text editor, and more.
Expand All @@ -18,7 +18,7 @@ Jupyterhub

SubMIT has a `custom installation of JupyterHub <http://submit.mit.edu/jupyter>`_.

This is set up through the subMIT machines meaning that you have access to all of your files and data. You will have access to basic python3 configurations. In addition, if you need a more complex environment, you can run your notebooks in any conda environment that you have set up. You can check the name and location of your environments using the command ``jupyter kernelspec list``. This allows you to create the exact environment you need for your projects. An example on how to set up a conda environment is shown above, and how it is implemented in jupyter is described below.
This is set up through the SubMIT machines meaning that you have access to all of your files and data. You will have access to basic python3 configurations. In addition, if you need a more complex environment, you can run your notebooks in any conda environment that you have set up. You can check the name and location of your environments using the command ``jupyter kernelspec list``. This allows you to create the exact environment you need for your projects. An example on how to set up a conda environment is shown above, and how it is implemented in jupyter is described below.

A few examples of simple Jupyter notebooks can be found in the `Github jupyter examples <https://github.com/mit-submit/submit-examples/tree/main/jupyter>`_. Several other intro notebooks can be found in the link below:
`JupyterHub_examples <https://github.com/CpResearch/PythonDataAnalysisTutorial/tree/main/jupyter>`_
Expand Down Expand Up @@ -160,7 +160,7 @@ Visual Studio Code (VSCode) is a free, versatile source-code editor that support

* **Integrated file browser:** easily navigate and manage your files within the editor.

One of the capabilities of VSCode is its client-server mode for `remote development <https://code.visualstudio.com/docs/remote/ssh>`_ on subMIT. This functionality allows you to edit, run, and debug code on the subMIT servers directly from your personal computer. This setup provides the ease of a GUI-based development environment on your local machine while executing the code on subMIT's infrastructure.
One of the capabilities of VSCode is its client-server mode for `remote development <https://code.visualstudio.com/docs/remote/ssh>`_ on SubMIT. This functionality allows you to edit, run, and debug code on the SubMIT servers directly from your personal computer. This setup provides the ease of a GUI-based development environment on your local machine while executing the code on SubMIT's infrastructure.

For `most languages <https://code.visualstudio.com/docs/languages/overview>`_, VScode enhances your coding experience with features like:

Expand All @@ -175,18 +175,18 @@ For `most languages <https://code.visualstudio.com/docs/languages/overview>`_, V
* **Accessibility features:** `learn about accessibility in VSCode <https://code.visualstudio.com/docs/editor/accessibility>`_.


Getting Started with VSCode on subMIT
Getting Started with VSCode on SubMIT
.....................................

Microsoft provides some handy `videos <https://code.visualstudio.com/docs/getstarted/introvideos>`_ for getting started with VSCode, as well as detailed information on `remote connection <https://code.visualstudio.com/docs/remote/ssh>`_.

#. **Install VSCode:** `download and install instructions <https://code.visualstudio.com/docs/setup/setup-overview>`_

#. **SSH Configuration:** Follow the `general configuration guide <https://submit.mit.edu/submit-users-guide/starting.html#common-issues-with-keys>`_ in the subMIT User's Guide. Also have a look at the `VSCode configuration guide <https://submit.mit.edu/submit-users-guide/starting.html#connecting-to-submit-through-VSCode>`_ due to a recent VSCode upgrade which removed the compatibility with CentOS 7.
#. **SSH Configuration:** Follow the `general configuration guide <https://submit.mit.edu/submit-users-guide/starting.html#common-issues-with-keys>`_ in the SubMIT User's Guide. Also have a look at the `VSCode configuration guide <https://submit.mit.edu/submit-users-guide/starting.html#connecting-to-submit-through-VSCode>`_ due to a recent VSCode upgrade which removed the compatibility with CentOS 7.

#. **Remote-SSH Extension:** Available in the VSCode Extensions tab or on the `VSCode website <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh>`_.

#. **Connect to subMIT:** Click the green "Open a Remote Window" button in the lower-left of the VSCode window. Select "submit" from the menu (VSCode automatically reads your ssh config file). Then, simply "open" a folder or workspace. Opening a folder is typically more convenient than opening a single code file. Remember: VSCode is now connected to subMIT, so you are looking at and navigating your files on the subMIT servers, not on your laptop/desktop.
#. **Connect to SubMIT:** Click the green "Open a Remote Window" button in the lower-left of the VSCode window. Select "submit" from the menu (VSCode automatically reads your ssh config file). Then, simply "open" a folder or workspace. Opening a folder is typically more convenient than opening a single code file. Remember: VSCode is now connected to SubMIT, so you are looking at and navigating your files on the SubMIT servers, not on your laptop/desktop.

#. **Note:** Only run *light* calculations in VSCode; VSCode is intended for editing/debugging, not production runs. If the execution of your code will consume significant resources (time, memory, processors, ...) then please run it outside VSCode using `Slurm or HTCondor <https://submit.mit.edu/submit-users-guide/running.html>`_. For example, you can debug using a smaller subset of data than a production run.

Expand Down
10 changes: 5 additions & 5 deletions source/acknowledging.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
Acknowledging subMIT
Acknowledging SubMIT
--------------------


It is very helpful for us to have a record of publications that made use
of subMIT resources (be those the physical hardware, or the human support
of SubMIT resources (be those the physical hardware, or the human support
that we provide).

If possible, please send an e-mail letting us know you've published a
preprint or paper (to submit-help@mit.edu) that made use of our resources.

We would also appreciate it if you could acknowledge subMIT in your
We would also appreciate it if you could acknowledge SubMIT in your
publications, where appropriate, with the following language:

*This work made use of resources provided by subMIT at MIT Physics.*
*This work made use of resources provided by SubMIT at MIT Physics.*

In addition, you can cite the following preprint::

Expand All @@ -27,4 +27,4 @@ In addition, you can cite the following preprint::
}

We will also periodically send around e-mails to the users lists reminding
users to let us know about any recently published papers.
users to let us know about any recently published papers.
2 changes: 1 addition & 1 deletion source/backup.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Data backup
-----------

In this section we will to discuss the backup policy of subMIT. In short, the only space that has a conventional backup is the home directory for users (/home/submit). The directories under work (/work/submit) and data (/ceph/submit/data) have intrinsic resilience by raiding and erasure coding but are not backed up. The subMIT team is making its best effort to keep data safe but due to the size a full backup is not feasible.
In this section we will to discuss the backup policy of SubMIT. In short, the only space that has a conventional backup is the home directory for users (/home/submit). The directories under work (/work/submit) and data (/ceph/submit/data) have intrinsic resilience by raiding and erasure coding but are not backed up. The SubMIT team is making its best effort to keep data safe but due to the size a full backup is not feasible.

If there is a particular emergency situation involving backups please contact submit-help@mit.edu.

Expand Down
10 changes: 5 additions & 5 deletions source/conda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ You can then write your code, let's say in a file called ``example.jl``, and run
Conda for C++
=============

Natively, subMIT currently has a C++ compiler, ``g++``. While Conda doesn’t directly install C++ as a standalone compiler, it can install related tools (like GCC [GNU Compiler Collection] or Clang) and libraries for building C++ projects, e.g.
Natively, SubMIT currently has a C++ compiler, ``g++``. While Conda doesn’t directly install C++ as a standalone compiler, it can install related tools (like GCC [GNU Compiler Collection] or Clang) and libraries for building C++ projects, e.g.

.. code-block:: sh

Expand All @@ -88,7 +88,7 @@ You can then write your code, let's say in a file called ``example.cpp``, and co
Conda for FORTRAN
=================

Natively, subMIT currently has a FORTRAN compiler, ``gfortran``. Similarly to C++, Conda can install FORTRAN compilers, such as a specific version of ``gfortran``, through the command:
Natively, SubMIT currently has a FORTRAN compiler, ``gfortran``. Similarly to C++, Conda can install FORTRAN compilers, such as a specific version of ``gfortran``, through the command:

.. code-block:: sh

Expand Down Expand Up @@ -132,7 +132,7 @@ To run a script called ``example.R`` in R, use ``Rscript example.R``.
Conda for Java
==============

Java is also natively installed on subMIT. If you wish a different version, you can for example install it using
Java is also natively installed on SubMIT. If you wish a different version, you can for example install it using

.. code-block:: sh

Expand All @@ -149,7 +149,7 @@ Some, but not all, Java-related libraries are available via Conda, e.g.
Conda for Perl
==============

Perl is also natively installed on subMIT. If you wish a different version, you can for example install it using
Perl is also natively installed on SubMIT. If you wish a different version, you can for example install it using

.. code-block:: sh

Expand All @@ -166,7 +166,7 @@ To import Perl libraries, such as ``perl-dbi``, run
Conda for Ruby
==============

Ruby is not natively installed on subMIT. You can install it through
Ruby is not natively installed on SubMIT. You can install it through

.. code-block:: sh

Expand Down
8 changes: 4 additions & 4 deletions source/intro.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
Introduction and creating an account
------------------------------------

Welcome to the subMIT users guide! This will guide you on how to make an account to access the submit machines and how to create basic and more advanced workflows for applications. We have examples and tutorials to help you get going.
Welcome to the SubMIT users guide! This will guide you on how to make an account to access the submit machines and how to create basic and more advanced workflows for applications. We have examples and tutorials to help you get going.

Introduction
~~~~~~~~~~~~

The subMIT login pool is designed to let users login safely prepare and tests their research computing tasks and submit them to the large computing resources of their choice. There are for now a limited number of resources connected but we are working on quickly expanding the available resources.
The SubMIT login pool is designed to let users login safely prepare and tests their research computing tasks and submit them to the large computing resources of their choice. There are for now a limited number of resources connected but we are working on quickly expanding the available resources.

We have HTcondor connection to the Tier-2 computing cluster, the Tier-2 integration cluster (aka Tier-3) in building 24, the engaging cluster and the OSG. For CMS users the global CMS queue is also seamlessly integrated.

What do I need for an account if I have an MIT kerberos?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To make login convenient and secure we allow login to the subMIT pool using ssh keys only. Go to our `submit portal <https://submit-portal.mit.edu>`_ to upload your ssh key (or a number of keys). Upload of ssh keys is secured through MIT touchstone authentication.
To make login convenient and secure we allow login to the SubMIT pool using ssh keys only. Go to our `submit portal <https://submit-portal.mit.edu>`_ to upload your ssh key (or a number of keys). Upload of ssh keys is secured through MIT touchstone authentication.

What do I need for an account if I don't have an MIT kerberos?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -23,4 +23,4 @@ You will need to obtain an MIT guest account. A sponsor -- usually a faculty you
How to get help?
~~~~~~~~~~~~~~~~

If you have any trouble, you can contact submit-help via email at submit-help@mit.edu.
If you have any trouble, you can contact the help team via email at submit-help@mit.edu.
14 changes: 7 additions & 7 deletions source/monit.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
Monitoring at submit
Monitoring at SubMIT
--------------------

.. tags:: Slurm, Condor

This section will detail the monitoring available at submit. Here we will detail how you can keep track of the submit machines as you work as well as monitor your condor jobs.
This section will detail the monitoring available at SubMIT. Here we will detail how you can keep track of the submit machines as you work as well as monitor your condor jobs.

The main submit page
The main SubMITt page
~~~~~~~~~~~~~~~~~~~~

On the main `submit page <http://submit.mit.edu/>`_ you can find interesting links useful for monitoring. Most of these links are explained in more detail below.
On the main `SubMIT page <http://submit.mit.edu/>`_ you can find interesting links useful for monitoring. Most of these links are explained in more detail below.

Ganglia Monitoring for submit
Ganglia Monitoring for SubMIT
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Ganglia is a distributed monitoring system for high-performance computing systems such as submit. The Ganglia monitoring can be found through a link on the main submit page or can be found directly `here <http://submit08.mit.edu/ganglia/>`_. Information on the individual servers can be found at the bottom of the page or through the following `link to servers <http://submit08.mit.edu/ganglia/?c=Submits>`_.
Ganglia is a distributed monitoring system for high-performance computing systems such as SubMIT. The Ganglia monitoring can be found through a link on the main SubMIT page or can be found directly `here <http://submit08.mit.edu/ganglia/>`_. Information on the individual servers can be found at the bottom of the page or through the following `link to servers <http://submit08.mit.edu/ganglia/?c=Submits>`_.

CondorMon
~~~~~~~~~
Expand All @@ -30,7 +30,7 @@ To monitor your slurm jobs you can use the slurm monitoring `SlurmMon <https://s
Summary Plots for SubMIT
~~~~~~~~~~~~~~~~~~~~~~~~

There are additional summary plots to help keep track of the growth and health of the SubMIT system `Submit Monitoring Tools <http://submit.mit.edu/home_monitor/index.php>`_.
There are additional summary plots to help keep track of the growth and health of the SubMIT system `SubMIT Monitoring Tools <http://submit.mit.edu/home_monitor/index.php>`_.

Monitoring for the T3
~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading