This is an example of a CMEC module that complies with the CMEC-MDTF standard. The module is called "CMECTEST" and contains two configurations: C1 and C2.
The CMEC Module Manager can be used to install this module with the following command:
python setup_module.py CMECTEST
Another option is to use git clone to obtain a local copy of this repository. Alternatively, to obtain a released version, go to the "Releases" section in the sidebar.
The module is run via cmec-driver command line program (code repository), which has its own installation instructions.
This module depends on numpy, xarray, netcdf4, and matplotlib along with other modules from the Python standard library. An environment called '_CMEC_test_env' must be created which includes these packages.
A yaml file is provided with the source code to help create this environment:
conda env create -f test_env.yaml
A script is provided to generate a test data file of approximately 1 Mb in size.
The command is:
python make_test_data.py model_directory
"model_directory" can be the name of any existing directory. A file called "test_data_set.nc" will be written under that directory.
Activate an environment with cmec-driver installed.
cmec-driver register path/to/example_cmec_module/
Activate an environment with cmec-driver installed. If an output directory does not already exist, create one. Use the model_directory that contains the test data set from the "Create test data" section.
cmec-driver run model_directory/ output/ CMECTEST/C1 CMECTEST/C2
Navigate into the "output" folder to view the results. Each configuration will produce an html page that can be viewed in a browser.
Please note that the following files are not required CMEC files: "LICENSE", "NOTICE".
If forking this repository to use as a template for a future module, you may with to "detach" your fork from the example_cmec_repository. For help, see GitHub Support.
The CMEC example module is distributed under the terms of the BSD 3-Clause License.
LLNL-CODE-831161