Home
This official community version of ROMS is developed and maintained at Rutgers, The State University of New Jersey, New Brunswick, New Jersey, USA. Currently, this git repository contains the following branches:
- master: Tagged versions and the latest stable release version of ROMS
- develop: Main developing branch of ROMS. Not recommended for public consumption but passes the internal tests. It is intended for ROMS superusers and beta testers.
- feature branches: Research and new development branches recommended to superusers and beta testers.
The ROMS framework is intended for users interested in ocean modeling. It requires an extensive background in ocean dynamics, numerical modeling, and computers to configure, run, and analyze the results to ensure you get the correct solution for your application. Therefore, we highly recommend users register at https://www.myroms.org and set up a username and password to access the ROMS forum, email notifications for bugs/updates, technical support from the community, trac code maintenance history, tutorials, workshops, and publications. The User's ROMS forum has over 24,000 posts with helpful information. Technical support is limited to registered users. We do not provide user technical support, usage, or answers in GitHub.
This GitHub version becomes the official git repository for downloading, updating, improving, and correcting defects/bugs to the ROMS source code. Also, it is the version used in the ROMS-JEDI interface hosted at https://github.com/JCSDA-internal, which is currently private.
Use the following command to download the ROMS source code:
git clone https://github.com/myroms/roms.git
The idealized and realistic ROMS Test Cases and the Matlab processing software can be downloaded from:
git clone https://github.com/myroms/roms_test.git
git clone https://github.com/myroms/roms_matlab.git
We highly recommend that Users clone all the ROMS repositories from the same root directory in their computer and define the ROMS_ROOT_DIR variable in their computer shell logging environment, specifying where the UUsercloned/downloaded the ROMS source code, Test Cases, and Matlab processing software:
setenv ROMS_ROOT_DIR MyDownlodLocationDirectory
The build scripts will use this environmental variable when compiling any of the ROMS Test Cases without the need to customize the location of the ROMS source code. Also, it is used for loading the path of Matlab scripts in the startup.m configuration file.