DART icon indicating copy to clipboard operation
DART copied to clipboard

Dart tutorial update: Transition to DART_LAB Section_06

Open jlaucar opened this issue 11 months ago • 9 comments

Description:

The DART Tutorial is seriously out-of-date. It also duplicates much of the material found elsewhere, in particular in the DART_LAB tutorial. This pull request replaces key portions of the DART tutorial by creating a sixth section of the DART_LAB tutorial. The section allows users to reproduce all of the things done with Lorenz_96 in the first 5 DART_LAB sections using DART. It also describes a few additional capabilities like observation space diagnostics. It does not reproduce all the material in the old DART tutorial. Much of that is available in other DART documentation, but there are some parts that will eventually need to be transitioned in some fashion.

Fixes issue

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ x] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ x] Documentation update

Documentation changes needed?

  • [ ] My change requires a change to the documentation.
    • [x ] I have updated the documentation accordingly.
    • Note: When the final documents are commited into the DART_LAB presentations directory, the .rst file for the DART_LAB index will also need to be updated.

Tests

Please describe any tests you ran to verify your changes.

Checklist for merging

  • [ ] Updated changelog entry
  • [ ] Documentation updated
  • [ ] Update conf.py

Checklist for release

  • [ ] Merge into main
  • [ ] Create release from the main branch with appropriate tag
  • [ ] Delete feature-branch

Testing Datasets

  • [ ] Dataset needed for testing available upon request
  • [ ] Dataset download instructions included
  • [ ] No dataset needed

jlaucar avatar Jan 27 '25 16:01 jlaucar

Kevin and Helen are requested reviewers for this. At present, only the code and input file changes have been pushed. A powerpoint version of the section 6 slides is available but not under git control. I suggest that Kevin reviews the powerpoint and runs through the associated exercises. Then I will update the powerpoint and share with Helen who will identify resources to translate it into .rst. The rst will then be pushed and Kevin and I can recheck it before final pull approval. I will share the powerpoint with Kevin via separate email.

jlaucar avatar Jan 27 '25 16:01 jlaucar

Closing this until there is documentation. The file names need to be changed to not have :

hkershaw-brown avatar Jan 27 '25 17:01 hkershaw-brown

I recently pushed a change getting rid of the colons.

jlaucar avatar Jan 27 '25 17:01 jlaucar

yeah you missed some Screenshot 2025-01-27 at 12 06 03 PM

hkershaw-brown avatar Jan 27 '25 17:01 hkershaw-brown

Now have removed colons from the creation input files in the main lorenz_96 directory, also.

On Mon, Jan 27, 2025 at 10:06 AM Helen Kershaw @.***> wrote:

yeah you missed some Screenshot.2025-01-27.at.12.06.03.PM.png (view on web) https://github.com/user-attachments/assets/8d3858c2-16c2-4dbc-a511-0cff8ddb66cb

— Reply to this email directly, view it on GitHub https://github.com/NCAR/DART/pull/810#issuecomment-2616388056, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANDHUIX45RBM7JPI7MUNZ7T2MZRTBAVCNFSM6AAAAABV6QYEC6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJWGM4DQMBVGY . You are receiving this because you authored the thread.Message ID: @.***>

jlaucar avatar Jan 27 '25 17:01 jlaucar

Comments from Kevin and Helen have been addressed. Powerpoint (not under git control) was updated and a DART_LAB_Section06.pdf was added to the DART_LAB/presentation directory. Note that Kevin and Helen commented on the .rst derivative that Helen created but changes were made to Powerpoint only. Updates to the .rst should be part of a separate pull request.

The comments from Kevin and Helen with responses are below. Kevin identified many concerns with the DART matlab diagnostics, but those are not part of this pull request and have not been addressed. They may need to be extracted and placed in a separate issue.

kevin_helen_comments.docx

jlaucar avatar Apr 10 '25 17:04 jlaucar

Helen, The new section is an addition to DART_LAB. However, the full intent is that the DART tutorial is out-of-date and should disappear from the trunk along with some of the input.nml and other files that were designed to support the tutorial. There was huge amounts of overlap between DART_LAB and the DART tutorial.

On Wed, Apr 23, 2025 at 10:19 AM Helen Kershaw @.***> wrote:

@.**** commented on this pull request.

This doesn't address the existing tutorial at all. There are two versions of the tutorial, one the documentation docs https://docs.dart.ucar.edu/en/latest/theory/readme.html or the website https://dart.ucar.edu/tutorials/dart-tutorial/

Is this pull request an addition to DART_lab rather than an update the to DART tutorial?

— Reply to this email directly, view it on GitHub https://github.com/NCAR/DART/pull/810#pullrequestreview-2787946490, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANDHUIU3UUDO352Z4P7JY632264SXAVCNFSM6AAAAABV6QYEC6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDOOBXHE2DMNBZGA . You are receiving this because you modified the open/close state.Message ID: @.***>

jlaucar avatar Apr 23 '25 16:04 jlaucar

Helen, The new section is an addition to DART_LAB. However, the full intent is that the DART tutorial is out-of-date and should disappear from the trunk along with some of the input.nml and other files that were designed to support the tutorial. There was huge amounts of overlap between DART_LAB and the DART tutorial.

so my question is, is this a 3rd version of the DART tutorial (where we have 3 versions for some indefinite amount of time) or is the intent of this pull request to remove the existing DART tutorial?

hkershaw-brown avatar Apr 23 '25 16:04 hkershaw-brown

The exisiting DART tutorial should be removed with this pull is my intent. That obviously needs reviewing.

On Wed, Apr 23, 2025 at 10:48 AM Helen Kershaw @.***> wrote:

hkershaw-brown left a comment (NCAR/DART#810) https://github.com/NCAR/DART/pull/810#issuecomment-2824924542

Helen, The new section is an addition to DART_LAB. However, the full intent is that the DART tutorial is out-of-date and should disappear from the trunk along with some of the input.nml and other files that were designed to support the tutorial. There was huge amounts of overlap between DART_LAB and the DART tutorial.

so my question is, is this a 3rd version of the DART tutorial (where we have 3 versions for some indefinite amount of time) or is the intent of this pull request to remove the existing DART tutorial?

— Reply to this email directly, view it on GitHub https://github.com/NCAR/DART/pull/810#issuecomment-2824924542, or unsubscribe https://github.com/notifications/unsubscribe-auth/ANDHUIRB4KAOAMDFWJDMJ7D22674TAVCNFSM6AAAAABV6QYEC6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQMRUHEZDINJUGI . You are receiving this because you modified the open/close state.Message ID: @.***>

jlaucar avatar Apr 23 '25 16:04 jlaucar

@jlaucar closing this pull request for now, reopen if/when it is being worked on.

hkershaw-brown avatar Jun 09 '25 14:06 hkershaw-brown