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

New section in documentation for porting to new ocean model #432

Open
mnlevy1981 opened this issue Jul 13, 2023 · 0 comments
Open

New section in documentation for porting to new ocean model #432

mnlevy1981 opened this issue Jul 13, 2023 · 0 comments
Labels
Sphinx Documentation This issue refers to the documentation generated by sphinx in docs/

Comments

@mnlevy1981
Copy link
Collaborator

mnlevy1981 commented Jul 13, 2023

The user guide details the individual calls a MARBL driver needs to make, and the developer's guide describes how to update the MARBL driver in some specific cases, but it would be useful to have a step-by-step guide to actually get MARBL up and running. I'm picturing a list with steps like

  • Add the MARBL source code to the GCM (e.g. via git submodule)
  • Modify the GCM build system to include $MARBL_ROOT/src/*.F90
  • Start work on MARBL driver (call MARBL's initialization and adding MARBL tracers to GCM's passive tracers; initializing to zero and making sure the tracers are output in diagnostics would a useful first step. This would also be a good time to make sure MARBL logs get written by model)
  • Modify GCM infrastructure to generate marbl_in, verify that driver can read it in (changing a value from default should be reflected in log output)
  • Generate MARBL IC files and forcing on appropriate grid, initialize tracers to non-zero values

Obviously that's not a complete list, but it shows the level of detail I think would be useful to include.

@mnlevy1981 mnlevy1981 added the Sphinx Documentation This issue refers to the documentation generated by sphinx in docs/ label Jul 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Sphinx Documentation This issue refers to the documentation generated by sphinx in docs/
Projects
None yet
Development

No branches or pull requests

1 participant