Merge branch '24-add-xios-demonstrator-section' into 'main'

Resolve "Add XIOS3 demonstrator section"

Closes #24

See merge request !22

source/conf.py

@@ -12,7 +12,7 @@ project = 'NEMO'
 author = 'NEMO System Team'
 
 # The short X.Y version
-version = '4.2.2'
+version = '5.0-beta'
 # The full version, including alpha/beta/rc tags
 release = 'release-' + version
 # NEMO gitlab repository

source/index.rst

@@ -47,6 +47,7 @@ NEMO User Guide
    setup
    diags
    tools
+   xios3demo
    mixed
 
 .. toctree::

source/install.rst

@@ -91,9 +91,10 @@ Instructions on how to install XIOS can be found on its :xios_doc:`wiki<>`.
 
 .. note::
 
-   Prior to NEMO version 4.2.0 it was recommended to use XIOS 2.5 release. However, 
+   Prior to NEMO version 4.2.0 it was recommended to use XIOS 2.5 release. However,
    versions 4.2.0 and beyond utilise some newer features of XIOS2 and users will need to
-   upgrade to the trunk version of XIOS2. Note 4.2.1 does support the use of XIOS3 by activating "key_xios3" (in this case you cannot use the tiling capability).
+   upgrade to the trunk version of XIOS2. Note 5.0-beta will also support the use of XIOS3
+   by activating "key_xios3" (in this case you cannot use the tiling capability).
 
    XIOS2 trunk can be checked out with:
   
@@ -101,6 +102,20 @@ Instructions on how to install XIOS can be found on its :xios_doc:`wiki<>`.
 
       $ svn co http://forge.ipsl.jussieu.fr/ioserver/svn/XIOS2/trunk
 
+   If you are not planning on using the tiling capabilities (i.e. ``ln_tile = .false.``,
+   always) then there will be performance and robustness gains to be had by using XIOS3
+   instead. This can be used with the same XML files as XIOS2 or you can choose to make
+   changes to the XML files to enable new features. To illustrate some of the new options,
+   v5.0 includes a demonstrator configuration which is described in :ref:`xios3demo`.
+   XIOS3 trunk can be checked out with:
+  
+   .. code-block:: console
+
+      $ svn co http://forge.ipsl.jussieu.fr/ioserver/svn/XIOS3/trunk
+
+   but remember to always run with ``ln_tile = .false.`` and compile nemo with
+   ``key_xios3`` defined.
+    
 If you find problems at this stage, support can be found by subscribing to
 the :xios:`XIOS mailing list <../mailman/listinfo.cgi/xios-users>` and sending a mail message to it.