search

COSIMA / cosima-recipes

A cookbook of recipes (i.e., examples) for analysing ocean and sea ice model output
https://cosima-recipes.readthedocs.io
Apache License 2.0
44 stars 65 forks source link

Where to put model development examples? #308

Closed ashjbarnes closed 1 month ago

ashjbarnes commented 9 months ago

I'm looking to migrate a NCI-centric example notebook that walks users through how to use the "regional_mom6" package from that repo to COSIMA-recipes.

However, I've noticed that all of the examples here are for analysing output rather than setting up models. This is also mentioned in the README

If you made a notebook for analysing something that is not already included in the recipes, then please consider contributing back to the repository.

so it doesn't sound like a notebook for creating a new experiment quite fits. Any ideas as to where I should put it to make it visible and helpful? Perhaps we make a new category to store the scripts for setting up our wonderful models (many of these are separate repos on COSIMA)

ashjbarnes commented 9 months ago

If we chose to make a new tab under model development, then we could include a bunch of existing notebooks to kick things off. For example, Auslake, John Reilly's lovely nested EAC, Luwei's work in progress and maybe Chris Chapman's New Caledonia run. That might keep things a bit more organised than a mix of mom5/6 analysis as well as model dev notebooks all together

anton-seaice commented 9 months ago

In tutorials there are examples about not analysis things - building new cookbooks etc, so adding a model set-up notebook in there would be fine I think.

For more examples, we could rename Documented Examples to Analysis Examples and then add a new folder. I would call the new folder Model Configuration or Model Setup. Model development sounds to me like software development on the model code.

ashjbarnes commented 9 months ago

That sounds good! Yeah model configuration folder and then some "regional model setup" examples. I'll make a PR including a couple of regional model configurations in a Model Configuration folder, and if reviewers aren't happy with new folder for now they can move them to Documented examples

ashjbarnes commented 9 months ago

This is pending the approval of my PR on the regional-mom6 repo https://github.com/COSIMA/regional-mom6/pull/83 as the example notebook I've made won't work until the package is updated

navidcy commented 1 month ago

I'm closing this as is outdated now. The PR#338 will add an example using the regional-mom6 package which is now included in the conda analysis environment.