Skip to content

Commit

Permalink
Improve NCI ARE docs
Browse files Browse the repository at this point in the history
  • Loading branch information
omad committed Aug 17, 2023
1 parent d4f1d3f commit feb79f6
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 44 deletions.
1 change: 1 addition & 0 deletions redirects.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
"setup/NCI/install.rst" "setup/NCI/basics.rst"
"setup/NCI/nci_basics.rst" "setup/NCI/advanced.rst"
"setup/NCI/projects.rst" "setup/NCI/account.rst"
1 change: 0 additions & 1 deletion setup/NCI/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,3 @@ on the National Computational Infrastructure (NCI).
account
basics
advanced
projects
6 changes: 3 additions & 3 deletions setup/NCI/account.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ institutional email address.


.. important::
When signing up, you need to join some :ref:`data_access` projects
to access the DEA data.
When signing up, you must join some :ref:`nci_data_access` projects
to access DEA data.



Expand All @@ -40,7 +40,7 @@ commercial entities contact the `DEA Helpdesk`_ to help determine requirements.
.. _DEA Helpdesk: mailto:[email protected]


.. _data_access:
.. _nci_data_access:

Data Access
===========
Expand Down
53 changes: 29 additions & 24 deletions setup/NCI/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,49 +9,52 @@ Basics - JupyterLab and Virtual Desktop
Australian Research Environment
===============================

The easiest access to Digital Earth Australia on the NCI is via their
:term:`Australian Research Environment<ARE>`. It lets you use your web browser to
run a complete Virtual Desktop or execute code in JupyterLab Notebooks.
The easiest access to Digital Earth Australia on the NCI is via the
:term:`Australian Research Environment<ARE>`. Through your web browser you can
access a Virtual Desktop environment or execute code in JupyterLab Notebooks.

It's also possible to access DEA on the NCI's Gadi_ :term:`HPC` Supercomputer, but unless
you're experienced with :term:`SSH` and HPC systems, it's much easier to get
started on :term:`ARE`.
For more information on ARE see the `NCI's
ARE User Guide <https://opus.nci.org.au/display/Help/ARE+User+Guide>`_.

It's also possible to use DEA on the NCI's Gadi_ :term:`HPC` Supercomputer,
however unless you're experienced with :term:`SSH` and HPC systems, it's much
easier to get started with :term:`ARE`.


.. _Gadi: https://nci.org.au/our-systems/hpc-systems/

Launching JupyterLab from ARE
=============================

The NCI's Australian Research Environment (ARE) online portal allows users to
quickly connect to Digital Earth Australia from a web browser.
To launch a JupyterLab session, follow the instructions in `Starting JupyterLab
App (ARE User Guide) <https://opus.nci.org.au/display/Help/3.1+Starting+JupyterLab+App>`_
page in the NCI Help. See below for the settings required to use DEA .

To get started with the ARE portal, please follow the NCI
`ARE User Guide <https://opus.nci.org.au/display/Help/ARE+User+Guide>`_.
.. note:: To run an ARE session you must be part of a project at
NCI with compute capacity. DEA does not currently
provide access to such a project.

1. After successfully logging into ARE, you will see the ARE Dashboard.
Access to DEA
-------------

2. From here, choose **JupyterHub** to launch a new session.
The first time you start a JupyterLab session, there are some settings required
to access DEA.

3. The first time you start a session, there are a few options you need to configure.
**Storage**

**Storage**

Type `gdata/v10` into the **Storage**, then use the dropdown to select other
projects containing data you wish to access.
Type `gdata/v10` into the :guilabel:`Storage` box, then use the dropdown to select other
projects containing data you wish to access. See :ref:`nci_data_access`.

.. figure:: are_highlight_v10_storage_setting.png

**DEA Environment**
**DEA Environment**

Scroll down and expand the **Advanced** options, and set:
Scroll down and expand :guilabel:`Advanced options...`.

**Module directories** to ``/g/data/v10/public/modules/modulefiles``.
Set :guilabel:`Module directories` to ``/g/data/v10/public/modules/modulefiles``.

**Modules** to ``dea``.
Set :guilabel:`Modules` to ``dea``.

As seen here:

.. video:: /_static/are_jupyterhub_launch_setup.webm
:loop:
Expand All @@ -66,12 +69,14 @@ Virtual Desktops with ARE


Setting up Digital Earth Australia
==================================
----------------------------------

In the terminal window run the command::

sh /g/data/v10/public/digitalearthau/install.sh

This will download the latest version of the `Digital Earth Australia notebooks repository <https://github.com/GeoscienceAustralia/dea-notebooks/tree/stable>`_ into your VDI home directory (e.g. ``~/dea-notebooks``).
This will download the latest version of the `Digital Earth Australia notebooks
repository <https://github.com/GeoscienceAustralia/dea-notebooks/tree/stable>`_
into your home directory (e.g. :file:`~/dea-notebooks`).


16 changes: 0 additions & 16 deletions setup/NCI/projects.rst

This file was deleted.

0 comments on commit feb79f6

Please sign in to comment.