Skip to content

Documentation: references to work/workshop_setup.csh #1140

Description

@hkershaw-brown

What's the issue?

📚 Please describe the problem you’ve noticed in the documentation.
workshop_setup.csh referenced in several docs, e.g. lorenz_96 readme.rst,
workshop_setup.cshs do not exist.

Where did you find the issue?

Provide the location(s) of the issue:

[hkershaw:pull_1121](fixsystem) > rg workshop_setup.csh .
./CHANGELOG.rst
1727:-  all models with a ``workshop_setup.csh`` now build the same set of

./models/simple_advection/readme.rst
47:The simple advection model has a ``work/workshop_setup.csh`` script that compiles 

./models/lorenz_63/readme.rst
48:The Lorenz 63 model has a ``work/workshop_setup.csh`` script that compiles and 

./models/pe2lyr/README
17:2) Go to DART/models/pe2lyr/work and run 'csh ./workshop_setup.csh'
34:   executables by running 'csh ./workshop_setup.csh'

./models/9var/readme.rst
27:The 9-variable model has a ``work/workshop_setup.csh`` script that compiles 

./models/lorenz_84/readme.rst
30:The Lorenz 84 model has a ``work/workshop_setup.csh`` script that compiles and runs 

./models/lorenz_96_2scale/readme.rst
26:The Lorenz 96 2-scale model has a ``work/workshop_setup.csh`` script that 

./models/lorenz_96/readme.rst
56:The Lorenz 96 model has a ``work/workshop_setup.csh`` script that compiles and 
61:Be aware that the ``input.nml`` file is modified by the ``workshop_setup.csh``

./models/forced_lorenz_96/readme.rst
27:The *forced_lorenz_96* model has a ``work/workshop_setup.csh`` script that 
32:Be aware that the ``input.nml`` file is modified by the ``workshop_setup.csh`` script.

./models/lorenz_04/readme.rst
42:The Lorenz 05 model has a ``work/workshop_setup.csh`` script that compiles and 

./models/rose/readme.rst
18:DART/models/rose/work/workshop_setup.csh script is SUPPOSED to fail without the
[hkershaw:pull_1121](fixsystem) > find . -name 'workshop_setup.csh'
[hkershaw:pull_1121](fixsystem) > find . -name 'workshop_setup.sh' 
./models/lorenz_63/work/workshop_setup.sh
./models/9var/work/workshop_setup.sh
./models/simple_advection/work/workshop_setup.sh
./models/lorenz_84/work/workshop_setup.sh
./models/forced_lorenz_96/work/workshop_setup.sh
./models/lorenz_96_2scale/work/workshop_setup.sh
[hkershaw:pull_1121](fixsystem) > rg workshop_setup.sh .           
[hkershaw:pull_1121](fixsystem) > 

What needs to be fixed?

Share what’s incorrect, unclear, missing, or outdated.

According to this comment, "all of the workshop_setup scripts will disappear with the
update to the DART tutorial that is now underway"
#789 (comment)
DART tutorial is underwent, still have workshop_setup.sh scripts. Needed? Not needed?
For sure the doc references to workshop_setup.csh are outdated.

Suggestions for improvement

If you have any ideas to fix or generally improve this documentation, please share them.
Here are several:

  • one place for workshop scripts & docs rather than all over the repo.
  • No workshop scripts
  • Move workshops to a different repo

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions