Coastal Modeling System (CMS)

CMS is a coastal modeling system that couples a wave, circulation, and morphology model together to get better predictions in the near-shore.

CMS is developed by the USACE - Coastal and Hydraulics Laboratory

Documentation for the CMS is available from the CIRP Wiki.

Building/Editing

Windows platform

Building CMS on Windows requires use of the Microsoft Visual Studio GUI. This repository was created using the Intel Fortran compiler. The versions of the GUI and compiler primarily being used are as follows:

• MS Visual Studio 2019 or 2022
• Intel oneAPI 2021.4 (vs2019) or 2024.1 (vs2022)

Once the sofware has been installed, the user should load the appropriate solution file for the UI.

Linux platform

To build CMS On linux you must have CMAKE software above 2.8.

1. cd source
2. cmake .
3. make

This will leave you with an executable named 'cms' in your local working directory

To clean all of the intermediate files and old executable, type 'make clean' from the "source" directory.

Note: Linux builds have not been fully tested on HPC platform and some extra configuration may be necessary.

File/Folder structure

Below is a list of folders and descriptions of the contents.

• docs - this folder contains the documentation files needed for the CMS Documentation page that is in progress.
• Intel_vs2019 - this folder contains the solution file needed to load into Visual Studio 2019.
• Intel_vs2022 - this folder contains the solution file needed to load into Visual Studio 2022.
• GCTP - this project folder contains library code needed to map information between horizontal projections.
• SPCS83 - this project folder contains library code needed for changes related to the State Plane coordinate system.
• UTM2GEO - this project folder contains library code needed for converting to/from geographic coordinate space.
• source - contains subfolders for all the main CMS code functionality separated into process type.
• external_libraries - subfolders containing binary libraries to link with (no source).
• testing - contains CI/CD tests

Additional files in the main folder and their descriptions:

• README.md - this file.
• UNLICENSE.md - contains information regarding the use of this repository and the third-party licenses.
• CMS Terms and Conditions.txt - additional terms and conditions.
• .gitlab-ci.yml - contains needed continuous integration build information.
• pyproject.toml - contains needed information for the ReadTheDocs documentation pages.

Additional files in the "source" folder and their descriptions:

• CMakeLists.txt - contains information for compiling on Linux using CMake.
• logsheet.txt - contains information about changes between versions of CMS.
• readme.txt - contains information about configuration settings for Visual Studio on Windows and proper usages of the CMS executable from the command line.