ESMCI / ESMCI/cime

Document how to customize the build options

Open
#4,973 7 comments 0 reactions 0 assignees View on GitHub
Low Priority tp: documentation ty: Discussion ty: question user interface
Dominant language
Python
Stars
174
Forks
225
Avg merge
1d 16h
Merged PRs (30d)
14

Description

I couldn't find a lot of documentation on how the CIME build works in the CIME User's Guide nor in README's or comments in the code.

From what I see the options for customization are:

1. Modify: Macros.cmake, Macros.make, or env_mach_specific.xml for your case (use --keep on case.setup to preserve your changes if you have to rerun case.setup)
2. Explicitly set any of these environment variables for the build:
USER_SLIBS
USER_CPPDEFS
USER_INCLDIR
USER_CMAKE_MODULE_PATH
USER_CMAKE_OPTS
USER_MKDEPENDS_OPTS
3. Customize the files in your ccs_config in your checkout for the given machine
4. Customize specfic file compilation by adding files to the Depends.$COMPILER file in ccs_config
5. Use your own .cime directory to customize your settings
For "1" I just filed bugs: #4971 #4972

For "2" I showed that setting $USER_SLIBS does work correctly. But, haven't tried the others.

For "3" I've of course shown this works

I haven't done anything with "4", but obviously this is working.

I haven't tried "5" for a machine that ccs_config already has a definition for.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.