TESTING Version 1.2.1 Date 8 Nov 2024
By Andres Payo and David Favis-Mortlock, both British Geological Survey.
CoastalME (Coastal Modelling Environment) is a Free Open Source and Software for geospatial modelling to simulate decadal and longer coastal morphological changes.
It is an engineering tool for advanced modellers seeking to simulate the interaction of multiple coastal landforms and different types of human interventions.
Payo et al., (2017) described in detail the rationale behind CoastalME and demonstrated how it can be used to integrate; the Soft Cliff and Platform Erosion model SCAPE, the Coastal Vector Evolution Model COVE and the Cross Shore model CSHORE.
The software is written in C++ following the object oriented paradigm and has been documented using Doxygen.
The C++ source code is available for download under GNU open source license.
- Main site: https://www.osgeo.org/projects/coastalme/ - Developer docs, links to other resources
- Wiki site: https://earthwise.bgs.ac.uk/index.php/Category:Coastal_Modeling_Environment - User docs, links to other resources
- Master GIT repository: https://github.com/apayo/CoastalME - Master code
- Testing GIT repository: https://github.com/davefavismortlock/CoastalME_TESTING - For the very latest (possibly untested) CoastalME source code. Warning! Use at your own risk!
- Bug tracker: https://github.com/apayo/CoastalME/issues
- CoastlME Discussions forum
- Which GiHub-discussion tool should I use?
CoastalME builds easily using Linux. If you wish to run CoastalME on Windows, then we currently recommend using the Windows Subsystem Linux (WSL) software to do this.
Create a local copy of the github repository, for example by downloading a zipfile, then unpacking it or cloning. We suggest unpacking it to something like "/home/YOUR NAME/Projects/CoastalME/", this is your CoastalME folder.
git clone https://github.com/apayo/CoastalME
In a terminal window (i.e. at a command-line prompt) move to the CoastalME folder.
Then move to the the src folder Then run run_cmake.sh.
cd CoastalME/src
./run_cmake.sh
If you get the Permission denied message -bash: ./run_cmake.sh: Permission denied you will have to grant permission using chmod a+x run_cmake.sh, chmod a+x cshore/make_cshore.sh and then ./run_cmake.sh
If you see error messages re. missing software (for example, telling you that CMake cannot be found or is too old, or GDAL cannot be found or is too old) then you need to install or update the software that is causing the problem.
Run make install make install. This will create an executable file called cme in the CoastalME folder.
Edit cme.ini to tell CoastalME which input file to read (for example, in/simple_fast/simple_fast.dat)
Run cme ./cme. Output will appear in the out/ folder.
To test that your installation is running OK, you can run a suite of pre defined tests by running the following commands
chmod a+x run_test_suite.sh
./run_test_suite.sh
The chmod comand will ensure that you have permission to execute the run_test_suite.sh file.
Once you have CoastalME (CME) up and running, you can reduce the quantity of output (it can be overwhelming!) in several ways.
-
Change "Content of log file" in the main CME input file for any of the test suite runs (the name of this main input file is listed in cme.ini, both are simple text files). If you set "Content of log file" to zero, then CME won't output a log file; setting it to 4 (all output) is really only useful to developers.
-
Change "GIS vector files to output" and "GIS vector files to output" in the main CME input file. These are both set to "all" in the test suite files on GitHub. Instead of "all" you can list the space-separated codes for only the output that you want to see. A list of CME GIS output codes is in codes.txt"
Enjoy!
See 
Payo, A., Favis-Mortlock, D., Dickson, M., Hall, J. W., Hurst, M. D., Walkden, M. J. A., Townend, I., Ives, M. C., Nicholls, R. J., and Ellis, M. A.: Coastal Modelling Environment version 1.0: a framework for integrating landform-specific component models in order to simulate decadal to centennial morphological changes on complex coasts, Geosci. Model Dev., 10, 2715–2740, https://doi.org/10.5194/gmd-10-2715-2017, 2017.
See BUILDING.md
See CONTRIBUTING.md
Devised by Andres Payo and David Favis-Mortlock. Lead developer and Version Control Administrator is David Favis-Mortlock