From 505a76a0fb1a72ab58138457f6d4d38a91d76639 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Tue, 20 Dec 2022 15:22:00 -0700 Subject: [PATCH 1/5] Fix broken link in DART tutorial --- guide/matlab-observation-space.rst | 29 ++++++++++++++++++++++++----- theory/readme.rst | 3 +-- 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/guide/matlab-observation-space.rst b/guide/matlab-observation-space.rst index 0ce6494281..21e1d281aa 100644 --- a/guide/matlab-observation-space.rst +++ b/guide/matlab-observation-space.rst @@ -1,9 +1,27 @@ -##################################### -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') + +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 +259,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>`__ From 6371f9536394f779a2febb918c66a48a561fff02 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Tue, 20 Dec 2022 15:29:29 -0700 Subject: [PATCH 2/5] Update CHANGELOG to describe bug fix. --- CHANGELOG.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 96c69f7603..9fea97d1df 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -22,6 +22,11 @@ individual files. The changes are now listed with the most recent at the top. +**December 20 2022 :: Bug-fix for broken link in DART Tutorial. Tag v10.6.1** + +- Fixes a 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** - GitHub actions for pull requests which checkout, compile and run a From 1a8aa0bdb52511d156e08f5169fcbf72f606c540 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Tue, 20 Dec 2022 15:30:23 -0700 Subject: [PATCH 3/5] Update conf.py with bug fix semantic version --- conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 --------------------------------------------------- From 2cfed704e046c4410d7007d72a62193a860ae735 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Tue, 20 Dec 2022 18:53:43 -0700 Subject: [PATCH 4/5] Add instructions about startup.m file --- guide/matlab-observation-space.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/guide/matlab-observation-space.rst b/guide/matlab-observation-space.rst index 21e1d281aa..e3f255dc4c 100644 --- a/guide/matlab-observation-space.rst +++ b/guide/matlab-observation-space.rst @@ -18,6 +18,11 @@ path to your DART installation: 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 =========================== From 8ace87ccc39ab745afe73307f7d483d221540c0d Mon Sep 17 00:00:00 2001 From: Helen Kershaw Date: Wed, 21 Dec 2022 09:49:17 -0500 Subject: [PATCH 5/5] update changelog with pull #440 and missing tag from previous release --- CHANGELOG.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 9fea97d1df..63c012ab4c 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -22,12 +22,13 @@ individual files. The changes are now listed with the most recent at the top. -**December 20 2022 :: Bug-fix for broken link in DART Tutorial. Tag v10.6.1** +**December 21 2022 :: Documentation update for CLM and the DART Tutorial. Tag v10.6.1** -- Fixes a link within the documentation to a section describing how to +- 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** +**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.