Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs on globus personal utilities #263

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
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
3 changes: 2 additions & 1 deletion docs/Information_data_transmission.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
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 Globus Connect Personal: :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 Connect 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/>`_.
Loading