Testing the code here

Running everything

To run all tests (unit tests, system tests and pylint), simply run make all from this directory.

Python environment

One way to get a python environment for this to work together on cheyenne is to use

ncar_pylib

Another way is to use the file conda_env_ctsm_py.txt to setup a python environment. Comments in the file tell how to do this on cheyenne.

Unit and system tests

Unit and system tests can be run in one of two ways; these do the same thing, but support different options:

1. via make test

   You can specify a few arguments to this:

   • python version: make python=python3.9 test (defaults to python3; you should expect errors if trying to run with python2)
   • verbose: make verbose=true test
   • debug: make debug=true test

   Note that unit tests and system tests can be run separately with make utest or make stest, or they can all be run with make test.

2. via ./run_ctsm_py_tests

   You can specify various arguments to this; run ./run_ctsm_py_tests -h for details

pylint

You can run pylint on everything in the ctsm package with make lint.

Note, that the listing of errors with pylint is very specific to the version of pylint being used. Using a python environment as detailed earlier is important in order to get a clean run of pylint.

black

You can run a check for the black formatting with make black. This won't change the code, but check if it would be reformatted with black.