mnlevy1981 / MARBL

Marine Biogeochemistry Library
Other
0 stars 0 forks source link

test_set_interior: document the new test! #14

Closed mnlevy1981 closed 4 years ago

mnlevy1981 commented 5 years ago

The documentation should highlight the fact that this is an example of the full process necessary to bring MARBL into a new GCM (just wrap the interior_tendency_compute() and surface_flux_compute() calls in a time-stepping loop). It clearly shows what needs to be initialized, and how to determine what forcing is necessary.

mnlevy1981 commented 5 years ago

Definitely need to update usr-guide/GCM-interface/surface_flux.rst and usr-guide/GCM-interface/interior_tend.rst to use examples from the new test rather than POP. Also need to look for things like usr-guide/GCM-interface/init.rst (which refers to *.input files that have been renamed to *.settings in this PR). At first glance, I don't think there is any new documentation to write, though.

mnlevy1981 commented 5 years ago

Cleaned up init.rst in 5c442b9

mnlevy1981 commented 4 years ago

Last few tasks are laid out in a MARBL meeting agenda

mnlevy1981 commented 4 years ago

Also, we discussed cleaning up the marbl_io_read calls. So rough to-do list:

mnlevy1981 commented 4 years ago

Per #25 going to wait for later issue to address saved state documentation

mnlevy1981 commented 4 years ago

done as-of 6d1b272