ROMS/TOMS User Manual

[robertson]

Dear Users,

We have begun developement on the ROMS/TOMS users manual. Since we are a community model, we have decided to make the developement of the manual a community effort as well. We started from the old SCRUM manual and plan to upgrade its information accordingly. Please visit:

http://www.myroms.org/documentation/docs.php

to view the very rough first draft of the ROMS/TOMS users manual.

Feel free to post any corrections or suggestions in this forum under the appropriate topic(s). Keep in mind that this is a work in progress and many areas of the documentation are not yet ready to be posted on the web. We will post updates and additions to the above site as they become available. We are hoping that some of the advanced users will help us to accomplish this time-consuming task. The users are the ones who know what level of documentation is needed. We as developers can take many issues regarding ROMS/TOMS usage for granted.

Thank you for your interest in ROMS

[kate]

Hmm, did anything ever come of this?

My current draft manual is here. Again, this is a draft. It is also the manual describing (in part) my branch, not the trunk. Please let me know what I've missed , what I've gotten wrong , etc. Yes, I know about the "must update for ROMS" in the boundary condition section.

Some parts have made it to the wiki, some not.

[kate]

I was reminded that I need to acknowledge ARSC for supporting this. Anyone else? Who should I put as supporting ROMS development? ONR, right? UCLA?

[csherwood]

Hi Kate,

The USGS should be mentioned as ROMS supporters, as should the National Ocean Partnership Program.

Cheers, Chris

[kate]

Is there specific verbiage that should be used for either? ARSC has a set phrase for such things.

[csherwood]

Kate -

Nothing specific. The USGS Coastal and Marine Program has provided in-kind support as salaries of ROMS and CSTMS contributors and smaller contributions to support travel and workshops.

Happy Thanksgiving!
-Chris

[jcwarner]

I have provided a little more than just "in kind support," and so have many others.
Master/ocean.h is a place to start,
but there are countless others whom have fixed bugs that have been broken and refixed countless times.

! !
! Regional Ocean Model System (ROMS) !
! Terrain-following Ocean Model System (TOMS) !
! !
! Master program to execute ROMS/TOMS drivers in ocean mode only !
! without coupling (sequential or concurrent) to any atmospheric !
! model. !
! !
! This ocean model solves the free surface, hydrostatic, primitive !
! equations over variable topography using stretched terrain- !
! following coordinates in the vertical and orthogonal curvilinear !
! coordinates in the horizontal. !
! !
! Nonlinear Model Developers: !
! !
! Dr. Hernan G. Arango !
! Institute of Marine and Coastal Sciences !
! Rutgers University, New Brunswick, NJ, USA !
! (arango@marine.rutgers.edu) !
! !
! Dr. Alexander F. Shchepetkin !
! Institute of Geophysics and Planetary Physics !
! UCLA, Los Angeles, CA, USA !
! (alex@atmos.ucla.edu) !
! !
! Dr. John C. Warner !
! U.S. Geological Survey !
! Woods Hole, MA, USA !
! (jcwarner@usgs.gov) !
! !
! Tangent linear and Adjoint Models and Algorithms Developers: !
! !
! Dr. Hernan G. Arango (arango@marine.rutgers.edu) !
! Dr. Bruce Cornuelle (bcornuelle@ucsd.edu) !
! Dr. Emanuele Di Lorenzo (edl@eas.gatech.edu) !
! Dr. Arthur J. Miller (ajmiller@ucsd.edu) !
! Dr. Andrew M. Moore (ammoore@ucsc.edu) !
! Dr. Brian Powell (powellb@uscs.edu) !
! !

[kate]

I've updated the draft manual with a sketchy "getting started" chapter, also the svn appendix it refers to. Again, poke me if you find that something's missing.

I left the data assimilation gang out of the acknowledgments because it's not a part of this manual.

[kate]

Happy Solstice!

I've updated the manual with some boundary condition information. This is probably "good enough" for our documentation commitment to MMS, but you can still feel free to let me know of things to fix.

[kate]

A few last changes and it's no longer the DRAFT manual. I left the filename the same, though, for consistency.

[kate]

I have uploaded the manual to the wiki and made a link in the Tutorials section. I have also uploaded all my slides from the Hong Kong workshop and put in links under Tutorials. More to come when I get Dale and Gan's slides.

[kate]

There's a new Draft manual over here. Big chunks are the same as before, but I updated the ice description to be a little more consistent with the code.

[kate]

I'm working on the manual again and decided to put it on github: https://github.com/kshedstrom/roms_manual. You process it with pdflatex, but the pdf file is there too.

[kate]

I'm done updating the manual for now - it's off to BOEM for review. It's at github as in the prior message, but I guess I should change the wiki link.

[kate]

The BOEM review is done and it now has the proper BOEM report number (2016-037). Updated at github.