Skip to content

Commit

Permalink
Add docs on globus personal utilities
Browse files Browse the repository at this point in the history
  • Loading branch information
satyaog authored Dec 17, 2024
1 parent b07d2ab commit 87bf4ab
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/Information_data_transmission.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Data Transmission
=================


Multiple methods can be used to transfer data to/from the cluster:

* ``rsync --bwlimit=10mb``; this is the favored method since the bandwidth can
be limited to prevent impacting the usage of the cluster: `rsync
<https://cl-cheat-sheet.readthedocs.io/en/latest/#rsync>`_
* Digital Research Alliance of Canada: `Globus <https://docs.alliancecan.ca/wiki/Globus>`_
* Setup a Globus personal endpoint: :ref:`globus_connect_personal`
51 changes: 46 additions & 5 deletions docs/Userguide_data_transfer.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,53 @@
.. _globus_connect_personal:

Data Transmission using Globus Connect Personal
===============================================


Mila doesn't own a Globus license but if the source or destination provides a
Globus account, like Digital Research Alliance of Canada for example, it's
possible to setup Globus Connect Personal to create a personal endpoint on the
Mila cluster by following the Globus guide to `Install, Configure, and
Uninstall Globus Connect Personal for Linux
<https://docs.globus.org/how-to/globus-connect-personal-linux/>`_.
Mila cluster and then transfer data to and from the Mila cluster.

Some utilities have been made available to help setup a Globus personal
endpoint:


Login and add a Globus personal endpoint
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: sh
# login to your globus account
/network/datasets/scripts/globus_utils.sh globus whoami
# add a globus personal endpoint
/network/datasets/scripts/globus_utils.sh add_endpoint --name "mila-cluster"
Start a Globus personal endpoint
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: sh
/network/datasets/scripts/globus_utils.sh start_endpoint --dir PATH/TO/DATA
.. note::
The endpoint used will be the one precedently added. The utility does not
allow multiple endpoints per user

.. note::
It's best to use a cpu allocation to handle the Globus personal endpoint.
Once the personal endpoint is setup, execute the following command to run in
slurm:

.. code-block:: sh
sbatch --ntasks=1 --cpus-per-task=4 --mem=8G /network/datasets/scripts/globus_utils.sh start_endpoint --name "mila-cluster"
Do more with Globus Personal
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This endpoint can then be used to transfer data to and from the Mila cluster.
To understand better how Globus Personal works and do more with Globus, follow
the Globus guide to `Install, Configure, and Uninstall Globus Connect Personal
for Linux <https://docs.globus.org/how-to/globus-connect-personal-linux/>`_.

0 comments on commit 87bf4ab

Please sign in to comment.