.. role::  raw-html(raw)
    :format: html

.. |rocket-icon| replace:: :raw-html:`<svg style="width: 1.2rem;rotate: 315deg;" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--!Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2024 Fonticons, Inc.--><path fill="#0f418e" d="M130 480c40.6 0 80.4-11 115.2-31.9L352 384l-224 0 0 96h2zM352 128L245.2 63.9C210.4 43 170.6 32 130 32h-2v96l224 0zM96 128l0-96H80C53.5 32 32 53.5 32 80v48h8c-22.1 0-40 17.9-40 40v16V328v16c0 22.1 17.9 40 40 40H32v48c0 26.5 21.5 48 48 48H96l0-96h8c26.2 0 49.4-12.6 64-32H456c69.3 0 135-22.7 179.2-81.6c6.4-8.5 6.4-20.3 0-28.8C591 182.7 525.3 160 456 160H168c-14.6-19.4-37.8-32-64-32l-8 0zM512 243.6v24.9c0 19.6-15.9 35.6-35.6 35.6c-2.5 0-4.4-2-4.4-4.4V212.4c0-2.5 2-4.4 4.4-4.4c19.6 0 35.6 15.9 35.6 35.6z"/></svg>`


.. _lexis-portal:


.. _quick_start:

###########
Quick Start
###########
We would like to rocket fast |rocket-icon| guide you through
the initial steps of using the LEXIS platform via the web portal.
Our goal is to help you get the basics quickly with some prepared examples.

.. image:: FirstStepsImages/fsteps_show_guide.png
   :target: ../../_images/fsteps_show_guide.png
   :width: 240
   :align: center
   :alt: Open guided tour in web application

You can also view our guided tour that will quickly introduce you
to all the important stuff. It can be optionally opened
in the top right submenu.
So without further ado, lets get to supercomputing!

Before even getting to the portal, you are required to log in to your user account.
**The login button can be found in the top right corner**
at `portal.lexis.tech <https://portal.lexis.tech>`_. To log
in, you can use either `MyAccessID <https://wiki.geant.org/display/MyAccessID/MyAccessID+Home>`_
*(eduGAIN, eIDAS)*, or `B2ACCESS <https://eudat.eu/service-catalogue/b2access>`_
*(eduGAIN, ORCID and Social Identities)*.

.. image:: FirstStepsImages/fsteps_sign_in_options.png
   :target: ../../_images/fsteps_sign_in_options.png
   :width: 240
   :align: center
   :alt: Login in application
  

After logging in, you need to **request an access** to a LEXIS Demonstration Project.
To do this, click on the blue button in the middle of the screen,
or go to *Projects* in the navigation menu on the left and
then click the blue button on the right side.

.. figure:: img/access_or_create_project.png
   :width: 240
   :align: center
   :alt: Access or Create LEXIS project

A window will pop up. Enter 'demo_project' and wait a while
until you are granted an access.
This project contains all the necessary components
so you can get right to the supercomputing.

.. figure:: img/create_project_form.png
   :width: 360
   :align: center
   :alt: Access or Create LEXIS project (Create Form)

We can now try running one HPC job.
Navigate to *Applications/Custom HPC Jobs* to find prepared *Estimate PI in R* job.
Click on the little *down arrow* to see the content of the *Job script*.
Now click on the green button *Create Workflow*.

.. figure:: img/find_custom_hpc_jobs.png
   :width: 360
   :align: center
   :alt: Where to find Custom HPC Jobs

You can see the script written in R language. 
This is the script we want to run. As the name suggests,
it tries to estimate the number :math:`\pi`.
If you are familiar with the R language, you can check
the code. Otherwise, let's get to running it.
Fill in the name and optionally add some description, then *Continue*.

.. figure:: img/create_job_script_for_r_1.png
   :width: 360
   :align: center
   :alt: Creating job script 1

Choose the cluster (Barbora) and partition (qcpu). Right now,
we won't concern ourselves with other options and *Continue*.

.. figure:: img/create_job_script_for_r_2.png
   :width: 360
   :align: center
   :alt: Creating job script 2

Here, we leave all two options unchecked and *Continue* again.

.. figure:: img/create_job_script_for_r_3.png
   :width: 360
   :align: center
   :alt: Creating job script 3

On Advanced options, we won't make any changes and *Continue* for the last time.

.. figure:: img/create_job_script_for_r_4.png
   :width: 360
   :align: center
   :alt: Creating job script 4

We can see the summary of everything we entered and now we can *Create* the Workflow.

.. figure:: img/create_job_script_for_r_5.png
   :width: 360
   :align: center
   :alt: Creating job script 5

The Workflow we created is found under *Workflows* menu.
Click on the magnifying glass icon to show the details for this workflow.

.. figure:: img/create_workflow_from_job_r_1.png
   :width: 360
   :align: center
   :alt: Creating workflow from job script 1

There is the green *Create Workflow Execution* button we're going to click on.

.. figure:: img/create_workflow_from_job_r_1-5.png
   :width: 360
   :align: center
   :alt: Creating workflow from job script 1-5

We give a name to our execution of this workflow and as there is no input file
needed, we *Continue* and *Continue* again. On this last part, we see a summary
for this workflow and as we do not want to change anything, we click on
the green *Create* button at the bottom. 

.. figure:: img/create_workflow_from_job_r_2.png
   :width: 360
   :align: center
   :alt: Creating workflow from job script 2

And now we see our workflow is running!

.. figure:: img/create_workflow_from_job_r_3.png
   :width: 360
   :align: center
   :alt: Creating workflow from job script 3

This was just a simple showcase of how to get basic things working.
If you are interested in creating your own jobscripts, uploading your own datasets,
and others, check the comprehensive :ref:`howto_guide`!