Skip to content

Add "scripting tips" section to the documentation? #1127

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

Closed
glwagner opened this issue Nov 1, 2020 · 1 comment
Closed

Add "scripting tips" section to the documentation? #1127

glwagner opened this issue Nov 1, 2020 · 1 comment
Labels
documentation 📜 The sacred scrolls

Comments

@glwagner
Copy link
Member

glwagner commented Nov 1, 2020

Interacting with modeling software via scripts is novel for some users. We (and many others) are accumulating knowledge in this area, including:

  • Scripting philosophy and its advantages.
  • Literate scripting style for "paper-like" code, tutorials and pedagogical applications.
  • Best practices for parameter exploration (eg how to replicate the functionality of a parameter file or namelist in your script, and why divorcing parameter lists from model setup should be considered carefully).
  • Best practices for reproducibility (naming conventions, using output directories, checkpointing, script reuse).
  • The use of external packages to achieve these goals (like ArgParse, or perhaps DrWatson).

Oceananigans tries to give users great power and flexibility for designing numerical experiments. However, with this power comes great responsibility for users to write and use their scripts for Good. We can possibly help by adding some documentation. I also think the writers of said documentation might benefit if said documentation stimulates community input / outside contributions to these best practices.

cc @ali-ramadhan @navidcy @kpamnany @kburns

@glwagner glwagner added the documentation 📜 The sacred scrolls label Nov 4, 2020
@glwagner
Copy link
Member Author

glwagner commented Mar 5, 2022

Closing this; let's keep track on #1852

@glwagner glwagner closed this as completed Mar 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📜 The sacred scrolls
Projects
None yet
Development

No branches or pull requests

1 participant