Setup outline for basic user training

Author: maarten-ic

docs/source/conf.py

@@ -125,6 +125,8 @@
     "sphinxcontrib.mermaid",  # Draw graphs using Mermaid.js
 ]
 
+todo_include_todos = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates", sphinx_autosummary_accessors.templates_path]
 

docs/source/courses/basic/analyze.rst

@@ -0,0 +1,34 @@
+Analyze with IMASPy
+===================
+
+.. TODO:: Add content
+
+Load data
+---------
+
+Open IMAS database entry
+''''''''''''''''''''''''
+
+Load a time slice
+'''''''''''''''''
+
+Plot data
+---------
+
+Access data
+'''''''''''
+
+Get coordinate information
+''''''''''''''''''''''''''
+
+Plot data against coordinates
+'''''''''''''''''''''''''''''
+
+Plot time-dependent data
+------------------------
+
+Load full IDS
+'''''''''''''
+
+Create time-dependent plot
+''''''''''''''''''''''''''

docs/source/courses/basic/create.rst

@@ -0,0 +1,16 @@
+Create with IMASPy
+==================
+
+.. TODO:: Add content
+
+Create an empty IDS
+-------------------
+
+Populate fields
+---------------
+
+Sanity check the IDS
+--------------------
+
+Store IDS on disk
+-----------------

docs/source/courses/basic/explore.rst

@@ -0,0 +1,13 @@
+Explore with IMASPy
+===================
+
+.. TODO:: Add content
+
+Explore which IDSs are available
+--------------------------------
+
+Explore the structure and contents of an IDS
+--------------------------------------------
+
+Load an IDS and explore which data exists
+-----------------------------------------

docs/source/courses/basic/setup.rst

@@ -0,0 +1,5 @@
+IMASPy 101: setup IMASPy
+========================
+
+.. TODO:: Refer to :ref:`Installing IMASPy`; add instructions for obtaining the
+    training data sets (SDCC public DB/tarball(?)).

docs/source/courses/basic/transform.rst

@@ -0,0 +1,16 @@
+Transform with IMASPy
+=====================
+
+.. TODO:: add content
+
+Load a time slice
+-----------------
+
+Apply the transformation
+------------------------
+
+Store a time slice
+------------------
+
+Bringing it all together
+------------------------

docs/source/courses/basic_user_training.rst

@@ -0,0 +1,17 @@
+IMASPy 101
+==========
+
+In this IMASPy training, we introduce you to the basic concepts and features of
+IMASPy.
+
+.. TODO:: Expand introduction.
+
+.. toctree::
+    :caption: Training contents
+    :maxdepth: 1
+
+    basic/setup
+    basic/analyze
+    basic/explore
+    basic/transform
+    basic/create

docs/source/index.rst

@@ -32,6 +32,12 @@ It provides:
    api_overview
    mdsplus
 
+.. toctree::
+   :hidden:
+   :caption: IMASPy training courses
+
+   courses/basic_user_training
+
 
 README
 ------