Getting Started with CARDAMOM
“Installing” CARDAMOM
Get code from Github
Get invite from CARDAMOM team to join https://github.com/CARDAMOM-framework
Go to https://github.com/CARDAMOM-framework/CARDAMOM_2.1.6c
Click on green “Code” button, and select git clone with ssh
Example
Step 1. type “cd /Users/[yourusername]/”, in your mac terminal, for example (or alternatively go to the preffered directory for storing CARDAMOM code).
Step 2. type “git clone https://github.com/CARDAMOM-framework/CARDAMOM_2.1.6c” mac terminal.
See Git Clone FAQ below for troubleshooting
Do not use .zip approach (!) unless you only intend to download code once, and do not anticipate collaborating with team.
Compiling CARDAMOM
First sreo
Tips
If you are working on a new machine, make sure to re-install required packages like python, homebrew, etc
FAQ
Q: “i get “Error: could not find any nc-config command.” or something like that, what do I do?”
brew install netcdf
Q: “git clone doesn’t work, because github needs a key: what do I do now?”.
A: To get a github key, follow instructions here: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account
Get fatal error when typing “git clone https://github.com/CARDAMOM-framework/CARDAMOM_2.1.6c”, what should I do?
(NOTE: make link to CARDAMOM GITHUB.md, Shuang’s user guide).
SOON TO BE REQUIRED:
Install homebrew (if you don’t already have it: https://brew.sh)
Install netcdf library (if you don’t already have it)
*type “brew install netcdf” in terminal window (Mac), see step (1) for installing brew. *
Anthony, Alex: setenv(‘CARDAMOM_NC_CONFIG_PATH’,’/usr/local/bin/nc-config’)
For PC: no supported solution yet… (Paul: add potential windows solution)
You may also need
“brew install python” (even for matlab users)
Install pip on macos https://www.geeksforgeeks.org/how-to-install-pip-in-macos/
“pip3 install netcdf4”
Demos below will compile CARDAMOM and run short assimilation runs and forward runs for testing. There are options in both Python and Matlab. Check Appendix for additional tools written in Matlab and Python.
CARDAMOM Github User Must Read
After you clone the CARDAMOM repository to your local, please take a minute to go through the first section in CARDAMOM_GIT_MUST_READ.md. We recommand all users to follow the instructions in order to effectively maintain the CARDAMOM github environment.