Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize notebook names? #96

Closed
TeaganKing opened this issue Apr 25, 2024 · 2 comments · Fixed by #147
Closed

Standardize notebook names? #96

TeaganKing opened this issue Apr 25, 2024 · 2 comments · Fixed by #147
Labels
common utility documentation Improvements or additions to documentation hackathon

Comments

@TeaganKing
Copy link
Collaborator

It may be useful to have some standard notebook names (eg, obs comparisons, basic diagnostics, etc) across components.

One issue that prompted this is that seaice has a notebook titled seaice, which is confusing in the config file.

@TeaganKing TeaganKing added common utility documentation Improvements or additions to documentation labels Jul 23, 2024
@TeaganKing
Copy link
Collaborator Author

A suggestion could be added to the contributing wiki page & existing notebook names could be updated

@TeaganKing
Copy link
Collaborator Author

One potential naming convention could be as follows: <region>_<variable>_<metric>_<comparisons>.ipynb

Notebooks will already be categorized under a header for, eg, atm, so the component is not needed in the title of the notebook.

Some examples of this might be renaming NMSE_PSL.ipynb and LIWG_SMB_diagnostic.ipynb to Global_PSL_NMSE_compare_obs_lens.ipynb and Greenland_SMB_visual_compare_obs.ipynb, respectively.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
common utility documentation Improvements or additions to documentation hackathon
Projects
None yet
1 participant