|
|
@@ -1,3 +1,37 @@
|
|
|
-# Coral
|
|
|
+# Coral - simulation manager for NEMO
|
|
|
+## Purpose
|
|
|
|
|
|
-CORAL - simulation manager for NEMO - is a collaborative job submission script manager for NEMO - Nucleus for European Modelling of the Ocean
|
|
|
+Coral is a collaborative job submission script manager for the NEMO (Nucleus for European Modelling of the Ocean) modeling framework [Documentation](http://www.nemo-ocean.eu). With Coral, you can use and re-use job submission scripts designed and tested by your colleagues. You can ammend them in an easy way, and generate a submission script tailored to your needs. Then, you can share your script with your colleages.
|
|
|
+
|
|
|
+## Overview
|
|
|
+
|
|
|
+- Run 'coral -h' to get a list of Coral commands, and 'coral \<command\> -h' to get help for a specific \<command\>
|
|
|
+- Please see the [Documentation](http://www.climate.be/Coral/docs) for common usages and change log.
|
|
|
+- Having trouble? Get help with [Troubleshooting](http://www.climate.be/Coral/docs/troubleshooting.html)
|
|
|
+
|
|
|
+## Features
|
|
|
+
|
|
|
+Once Nemo and Coral are properly installed, you can create a working submission script in three commands:
|
|
|
+ - coral init: initiate a set of configuration files (with working default values on the cluster) for the experiment features, data location, restart options, etc.
|
|
|
+ - coral build: create a submission script from the configuration files
|
|
|
+ - coral submit: submit the job, with options to run tests locally, ignore automatic job resubmission, restart from scratch, etc.
|
|
|
+
|
|
|
+At each stage, you can act manually to adapt the workflow to your liking.
|
|
|
+
|
|
|
+Once the job is submitted, you can simply run 'coral status' in the run directory to get an overview of what is happening. No need to look for job ids, or output files.
|
|
|
+
|
|
|
+## Install
|
|
|
+
|
|
|
+Clone the Coral repository (for instance in the EXTERNAL directory of your NEMO install) and update your shell startup script to source the 'setup-coral.sh' file to add 'coral' to your PATH variable.
|
|
|
+
|
|
|
+## Acknowledgments
|
|
|
+
|
|
|
+- Thanks [Damien François](damien.francois@uclouvain.be) for initializing this project.
|
|
|
+
|
|
|
+## Contributors
|
|
|
+
|
|
|
+- [Damien François](damien.francois@uclouvain.be), [@pbarriat](http://www.climate.be:3000/pbarriat).
|
|
|
+
|
|
|
+## License
|
|
|
+
|
|
|
+This project is under the Creative Commons CC0 1.0 Universal License. See the [LICENSE](http://www.climate.be:3000/pbarriat/Coral/src/master/LICENSE) file for the full license text.
|
