Merge pull request #7 from ACCESS-NRI/update_nuopc_doc

Update nuopc_config parser documentation

Author: micaeljtoliveira

src/access/parsers/nuopc_config.py

@@ -3,10 +3,8 @@
 
 """Utilities to handle NUOPC configuration files.
 
-The `nuopc.runconfig` files use by the CESM driver, and thus by ACCESS-OM3, are a mixture of two file formats: Resource
-Files and Fortran Namelists.
-
-At the top-level, one has the Resource Files as implemented in ESMF. From the ESMF documentation:
+The `nuopc.runconfig` files used by the CESM driver, and thus by the NUOPC-based ACCESS models, are a mixture of formats.
+ At the top-level, one has the Resource Files as implemented in ESMF. From the ESMF documentation:
 
     A Resource File (RF) is a text file consisting of list of label-value pairs. There is a limit of 1024 characters per
     line and the Resource File can contain a maximum of 200 records. Each label should be followed by some data, the
@@ -50,7 +48,7 @@
 See https://earthsystemmodeling.org/docs/release/ESMF_8_6_0/ESMF_refdoc/node6.html#SECTION06090000000000000000 for
 further details.
 
-The CESM driver then uses tables as defined in Resource Files to store Fortran Namelists instead of simple values:
+The CESM driver then uses tables as defined in Resource Files to store lists of key-value pairs instead of simple values:
 
     DRIVER_attributes::
      Verbosity = off
@@ -69,6 +67,9 @@
      ocn2glc_levels = 1:10:19:26:30:33:35
     ::
 
+This format of key-value pairs does not seem to be documented and, although it resembles Fortran namlists, it is not.
+For example, the keys are case-sensitive, which is not the case in Fortran namelists. The format used to store arrays
+of values is also not the same as in Fortran namelists.
 """
 
 from pathlib import Path