fix #568 : updated the tutorial notebook about Session objects

Author: alixdamman

doc/source/_static/compare_tutorial.png

@@ -216,6 +216,8 @@ Miscellaneous improvements
 * added documentation and examples for :py:obj:`where()`, :py:obj:`maximum()`
   and :py:obj:`minimum()` functions (closes :issue:`700`)
 
+* updated the ``Working With Sessions`` section of the tutorial (closes :issue:`568`).
+
 
 Fixes
 -----

doc/source/changes/version_0_30.rst.inc

@@ -99,10 +99,6 @@ cells:
 
     A ``LArray`` object represents a multidimensional array with labeled axes.
 
-    See the [LArray](../api.rst#larray) section of the API Reference to explore all methods of LArray objects.
-    
-    To know how to save and load arrays in CSV, Excel or HDF format, please refer to the [Loading and Dumping Arrays](tutorial_IO.ipynb#Loading-and-Dumping-Arrays) section of the tutorial.
-    
     ### Create an array from scratch
 
     To create an array from scratch, you need to provide the data and a list
@@ -151,7 +147,7 @@ cells:
 - markdown: |
     ### Array creation functions
 
-    Arrays can also be generated in an easier way through creation functions (#ref needed):
+    Arrays can also be generated in an easier way through [creation functions](../api.rst#array-creation-functions):
 
     -  `ndtest` : creates a test array with increasing numbers as data
     -  `empty` : creates an array but leaves its allocated memory
@@ -290,17 +286,19 @@ cells:
     ```
 
 
+- markdown: |
+    ### More on LArray objects
+    
+    To know how to save and load arrays in CSV, Excel or HDF format, please refer to the [Loading and Dumping Arrays](tutorial_IO.ipynb#Loading-and-Dumping-Arrays) section of the tutorial.
+    
+    See the [LArray](../api.rst#larray) section of the API Reference to explore all methods of LArray objects.
+
+
 - markdown: |
     ## Session
 
     A ``Session`` object is a dictionary-like object used to gather several arrays, axes and groups. 
     A session is particularly adapted to gather all input objects of a model or to gather the output arrays from different scenarios. Like with arrays, it is possible to associate metadata to sessions.
-    
-    See the [Session](../api.rst#session) section of the API Reference to explore all methods of Session objects.
-    
-    To know how to save and load sessions in CSV, Excel or HDF format, please refer to the [Loading and Dumping Sessions](tutorial_IO.ipynb#Loading-and-Dumping-Sessions) section of the tutorial.
-    
-    To see how to work with sessions, please read the [Working With Sessions](tutorial_sessions.ipynb#Working-With-Sessions) section of the tutorial.
 
 
 - markdown: |
@@ -326,7 +324,7 @@ cells:
 
     # add metadata after creation
     s_pop.meta.title = 'Demographic Model of Belgium'
-    s_pop.meta.description = 'Modelize the demography of Belgium'
+    s_pop.meta.description = 'Models the demography of Belgium'
 
     # print content of the session
     print(s_pop.summary())
@@ -370,6 +368,16 @@ cells:
     </div>
 
 
+- markdown: |
+    ### More on Session objects
+    
+    To know how to save and load sessions in CSV, Excel or HDF format, please refer to the [Loading and Dumping Sessions](tutorial_IO.ipynb#Loading-and-Dumping-Sessions) section of the tutorial.
+    
+    To see how to work with sessions, please read the [Working With Sessions](tutorial_sessions.ipynb#Working-With-Sessions) section of the tutorial.
+    
+    Finally, see the [Session](../api.rst#session) section of the API Reference to explore all methods of Session objects.
+
+
 # The lines below here may be deleted if you do not need them.
 # ---------------------------------------------------------------------------
 metadata:

doc/source/tutorial/tutorial_presenting_larray_objects.ipyml

@@ -156,10 +156,6 @@
     "\n",
     "A ``LArray`` object represents a multidimensional array with labeled axes.\n",
     "\n",
-    "See the [LArray](../api.rst#larray) section of the API Reference to explore all methods of LArray objects.\n",
-    "\n",
-    "To know how to save and load arrays in CSV, Excel or HDF format, please refer to the [Loading and Dumping Arrays](tutorial_IO.ipynb#Loading-and-Dumping-Arrays) section of the tutorial.\n",
-    "\n",
     "### Create an array from scratch\n",
     "\n",
     "To create an array from scratch, you need to provide the data and a list\n",
@@ -227,7 +223,7 @@
    "source": [
     "### Array creation functions\n",
     "\n",
-    "Arrays can also be generated in an easier way through creation functions (#ref needed):\n",
+    "Arrays can also be generated in an easier way through [creation functions](../api.rst#array-creation-functions):\n",
     "\n",
     "-  `ndtest` : creates a test array with increasing numbers as data\n",
     "-  `empty` : creates an array but leaves its allocated memory\n",
@@ -470,16 +466,21 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Session\n",
+    "### More on LArray objects\n",
     "\n",
-    "A ``Session`` object is a dictionary-like object used to gather several arrays, axes and groups. \n",
-    "A session is particularly adapted to gather all input objects of a model or to gather the output arrays from different scenarios. Like with arrays, it is possible to associate metadata to sessions.\n",
-    "\n",
-    "See the [Session](../api.rst#session) section of the API Reference to explore all methods of Session objects.\n",
+    "To know how to save and load arrays in CSV, Excel or HDF format, please refer to the [Loading and Dumping Arrays](tutorial_IO.ipynb#Loading-and-Dumping-Arrays) section of the tutorial.\n",
     "\n",
-    "To know how to save and load sessions in CSV, Excel or HDF format, please refer to the [Loading and Dumping Sessions](tutorial_IO.ipynb#Loading-and-Dumping-Sessions) section of the tutorial.\n",
+    "See the [LArray](../api.rst#larray) section of the API Reference to explore all methods of LArray objects."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Session\n",
     "\n",
-    "To see how to work with sessions, please read the [Working With Sessions](tutorial_sessions.ipynb#Working-With-Sessions) section of the tutorial.\n"
+    "A ``Session`` object is a dictionary-like object used to gather several arrays, axes and groups. \n",
+    "A session is particularly adapted to gather all input objects of a model or to gather the output arrays from different scenarios. Like with arrays, it is possible to associate metadata to sessions."
    ]
   },
   {
@@ -513,7 +514,7 @@
     "\n",
     "# add metadata after creation\n",
     "s_pop.meta.title = 'Demographic Model of Belgium'\n",
-    "s_pop.meta.description = 'Modelize the demography of Belgium'\n",
+    "s_pop.meta.description = 'Models the demography of Belgium'\n",
     "\n",
     "# print content of the session\n",
     "print(s_pop.summary())"
@@ -567,6 +568,19 @@
     "\n",
     "</div>\n"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### More on Session objects\n",
+    "\n",
+    "To know how to save and load sessions in CSV, Excel or HDF format, please refer to the [Loading and Dumping Sessions](tutorial_IO.ipynb#Loading-and-Dumping-Sessions) section of the tutorial.\n",
+    "\n",
+    "To see how to work with sessions, please read the [Working With Sessions](tutorial_sessions.ipynb#Working-With-Sessions) section of the tutorial.\n",
+    "\n",
+    "Finally, see the [Session](../api.rst#session) section of the API Reference to explore all methods of Session objects."
+   ]
   }
  ],
  "metadata": {