Revise qe section for aiida-quantumespresso v3.3.0 (#316)

* Revise qe section for aiida-quantumespresso v3.3.0 * Update versions on main page
aiidateam · Feb 10, 2021 · 074d08f · 074d08f
1 parent cbda6f2
commit 074d08f
Show file tree

Hide file tree

Showing 4 changed files with 195 additions and 130 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,14 +6,17 @@ AiiDA ABC tutorial
 +-----------------+-----------------------------------------------------------------------------------------------------------+
 | Related resources                                                                                                           |
 +=================+===========================================================================================================+
-| python packages | `aiida-core 1.4.3`_, `aiida-quantumespresso 3.2.1`_, `AiiDAlab docker 21.02.1`_                           |
+| AiiDAlab        | `AiiDAlab docker stack 21.02.1`_, `AiiDAlab k8s deployment`_                                              |
++-----------------+-----------------------------------------------------------------------------------------------------------+
+| python packages | `aiida-core 1.5.2`_, `aiida-quantumespresso 3.3.0`_                                                       |
 +-----------------+-----------------------------------------------------------------------------------------------------------+
 | codes           | `Quantum ESPRESSO 6.0.0`_                                                                                 |
 +-----------------+-----------------------------------------------------------------------------------------------------------+
 
-.. _AiiDAlab docker 21.02.1: https://github.com/aiidalab/aiidalab-docker-stack/releases/tag/v21.02.1
-.. _aiida-core 1.4.3: https://pypi.org/project/aiida-core/1.4.3/
-.. _aiida-quantumespresso 3.2.1: https://github.com/aiidateam/aiida-quantumespresso/releases/tag/v3.2.1
+.. _AiiDAlab docker stack 21.02.1: https://github.com/aiidalab/aiidalab-docker-stack/releases/tag/v21.02.1
+.. _AiiDAlab k8s deployment: https://github.com/aiidalab/aiidalab-k8s
+.. _aiida-core 1.5.2: https://pypi.org/project/aiida-core/1.5.2/
+.. _aiida-quantumespresso 3.3.0: https://pypi.org/project/aiida-quantumespresso/3.3.0/
 .. _Quantum ESPRESSO 6.0.0: https://github.com/QEF/q-e/releases/tag/qe-6.0.0
 
 This is the content of the virtual AiiDA tutorial organised for the University of ABC on the 10th of February 2021.
@@ -48,6 +51,12 @@ If you have time left after going through the first two sections, you can have a
    ./source/sections/qe
    ./source/sections/data
    ./source/sections/install
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Appendices
+   :numbered:
+
    ./source/sections/basics
 
 In-depth tutorial

diff --git a/docs/source/sections/basics.rst b/docs/source/sections/basics.rst
@@ -1,4 +1,4 @@
-.. _BIGMAP_2020_Basics:
+.. _basics:
 
 *******************
 Provenance Tutorial
@@ -12,7 +12,7 @@ At the end of it you will know how to:
 * Run and monitor the status of processes.
 * Explore and visualize the provenance graph.
 
-.. _BIGMAP_2020_Basics:provenance:
+.. _basics:provenance:
 
 Provenance
 ==========
@@ -35,7 +35,7 @@ The green ellipses are ``Data`` nodes, the blue ellipse is a ``Code`` node, and
 The provenance graph allows us to not only see what data we have, but also how it was produced.
 During this tutorial we will be using AiiDA to generate the provenance graph in :numref:`fig_intro_workchain_graph` step by step.
 
-.. _BIGMAP_2020_Basics:data_nodes:
+.. _basics:data_nodes:
 
 Data nodes
 ==========
@@ -139,7 +139,7 @@ Besides this information, the ``verdi node show`` command also shows the (empty)
 
   Try to use again ``verdi node show`` on the ``Int`` node above, just with the first part of the UUID (that you got from the first call to ``verdi node show`` above).
 
-.. _BIGMAP_2020_Basics:calcfunction:
+.. _basics:calcfunction:
 
 Calculation functions
 =====================
@@ -234,7 +234,7 @@ As a final step, let's have a look at the provenance of this simple calculation.
 The provenance graph can be automatically generated using the verdi CLI.
 Let's generate the provenance graph for the ``multiply`` calculation function we have just run:
 
-.. _BIGMAP_2020_Basics:calcfunction:graph:
+.. _basics:calcfunction:graph:
 
 .. code-block:: console
 
@@ -454,7 +454,7 @@ You can see more details on any process, including its inputs and outputs, using
     retrieved       154  FolderData
     sum             155  Int
 
-.. _BIGMAP_2020_Basics:submit:
+.. _basics:submit:
 
 Submitting to the daemon
 ========================
@@ -550,7 +550,7 @@ Let's wait for the ``CalcJob`` to complete and then use ``verdi process list --a
 
     Info: last time an entry changed state: 7s ago (at 15:05:31 on 2020-11-29)
 
-.. _BIGMAP_2020_Basics:workflow:
+.. _basics:workflow:
 
 Workflows
 =========

diff --git a/docs/source/sections/data.rst b/docs/source/sections/data.rst
@@ -1,4 +1,4 @@
-.. _2020_virtual_intro:data:
+.. _data:
 
 *******************************************
 Working with data and querying your results
@@ -245,7 +245,7 @@ What next?
 You now have a first taste of the type of problems AiiDA tries to solve.
 Here are some options for how to continue:
 
-* Get a more detailed view of how to manipulate AiiDA objects in the :ref:`extra section<BIGMAP_2020_Basics>` of this tutorial.
+* Get a more detailed view of how to manipulate AiiDA objects in the :ref:`extra section<basics>` of this tutorial.
 * Continue with the `in-depth tutorial`_.
 * Download the `Quantum Mobile`_ virtual machine and try running the tutorial on your laptop instead.
 * Try `setting up AiiDA`_ directly on your laptop.