diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 96c69f7603..63c012ab4c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -22,7 +22,13 @@ individual files. The changes are now listed with the most recent at the top. -**December 12 2022 :: Automated testing of pull requests** +**December 21 2022 :: Documentation update for CLM and the DART Tutorial. Tag v10.6.1** + +- Improved instructions for the CLM-DART tutorial. +- Fixes link within the documentation to a section describing how to + configure MATLAB's path to use DART MATLAB functions. + +**December 12 2022 :: Automated testing of pull requests. Tag v10.6.0** - GitHub actions for pull requests which checkout, compile and run a given model. diff --git a/conf.py b/conf.py index 6a3c47f100..29a230affc 100644 --- a/conf.py +++ b/conf.py @@ -21,7 +21,7 @@ author = 'Data Assimilation Research Section' # The full version, including alpha/beta/rc tags -release = '10.6.0' +release = '10.6.1' master_doc = 'README' # -- General configuration --------------------------------------------------- diff --git a/guide/matlab-observation-space.rst b/guide/matlab-observation-space.rst index 0ce6494281..e3f255dc4c 100644 --- a/guide/matlab-observation-space.rst +++ b/guide/matlab-observation-space.rst @@ -1,9 +1,32 @@ -##################################### -MATLAB® observation space diagnostics -##################################### +#################################### +MATLAB observation space diagnostics +#################################### -The observation-space functions are in the ``$DARTROOT/diagnostics/matlab`` -directory. Once you have processed the ``obs_seq.final`` files into a single +Configuring MATLAB +================== + +DART uses MATLAB's own netCDF reading and writing capability and does not use +any MATLAB or third-party toolboxes. + +To allow your environment to seamlessly use the DART MATLAB functions, your +MATLAB path must be set to include two of the directories in the DART +repository. In the MATLAB command prompt enter the following, using the real +path to your DART installation: + +.. code-block:: + + addpath('DART/diagnostics/matlab','-BEGIN') + addpath('DART/guide/DART_LAB/matlab','-BEGIN') + +It is convenient to put these commands in your ``~/matlab/startup.m`` so they +get run every time MATLAB starts up. You can use the example ``startup.m`` file +located at ``DART/diagnostics/matlab/startup.m``. This example startup file +contains instructions for using it. + +Summary of MATLAB functions +=========================== + +Once you have processed the ``obs_seq.final`` files into a single ``obs_diag_output.nc``, you can use that as input to your own plotting routines or use the following DART MATLAB® routines: @@ -241,3 +264,4 @@ the selected observations get highlighted there too. .. |link obs example frame 0| image:: images/science_nuggets/link_obs_example_F0.png :width: 100% + diff --git a/theory/readme.rst b/theory/readme.rst index 2c6ceae554..4ff632f358 100644 --- a/theory/readme.rst +++ b/theory/readme.rst @@ -10,8 +10,7 @@ prerequisite statistical concepts by reading The diagnostics in the tutorial use Matlab®. To learn how to configure your environment to use Matlab and the DART diagnostics, see the documentation for -`Configuring Matlab® for netCDF & DART -`__. +:doc:`/guide/matlab-observation-space`. - **Section 1:** `Filtering For a One Variable System <../_static/slides/section_01.pdf>`__ - **Section 2:** `The DART Directory Tree <../_static/slides/section_02.pdf>`__