.. _cheatsheet:

Jupyterlab Cheatsheet
=====================

Please have a look as well at the :ref:`faq` for more extended questions and how to.

.. function:: First time registration

Register in the IMAXT archive in https://imaxt.ast.cam.ac.uk

.. function:: Access the server

Go to https://imaxtlab.ast.cam.ac.uk and log in using your archive credentials.

.. function:: Ending your session

When you finish with your notebook session, logout (menubar ``File`` -> ``Log Out``)

.. function:: Starting a notebook

Either form the Launcher (menubar ``File`` -> ``New Launcher``) or from the
menubar ``File`` -> ``New`` -> ``Notebook``. For more information see the main
:ref:`jupyterlab` documentation.

.. function:: Running software

The primary use of the Jupyter Notebooks is to run code as Python or R notebooks.
Software can also be run from the command line of a terminal.

Open a terminal from the Launcher or using the menubar, ``File`` -> ``Terminal``.

.. function:: Long running processes

Processes stop running when you logout from the system. In order to have scripts
running for longer see :ref:`lrp`.

.. function:: Directory paths

* Your home directory in Jupyterlab is ``/home/username``
* Your data storage is ``/storage/username``
* Your shared storage is in ``/home/username/Shared`` (use this to share notebooks
  with other users as everyone can see this).
* Tutorials will go to ``/home/username/Tutorials``

where ``username`` is your archive username.

**Please keep your home directory for notebooks and your data storage for data.**

.. function:: Notebook backups

Your last 10 saved notebooks are backed up in the same directory as your
notebook with name ``.notebook_name.py*``. You can access those from the terminal
window.

.. function:: Copy data

Use sftp: ``sftp -P 2222 username@imaxt.ast.cam.ac.uk``. After authentication you can
access ``/home/username`` and ``/storage/username``. For more information follow
:ref:`sftp`.

.. function:: Start RStudio

You can start RStudio in two ways:

* Select RStudio in the Launcher  (``File`` -> ``New Launcher``).
* From the menubar ``IMAXT`` -> ``Launch RStudio``