CIME Users Guide

CIME User's Guide

1.0 Introduction and Overview

• 1.2 CIME directory structure and overview of contents
  • 1.2.1 Style definitions
  • 1.2.2 CIME version naming
  • 1.2.3 Prerequisites
• 1.3 CIME components and component sets
  • 1.3.1 CESM specific compsets (pointer to a table)
  • 1.3.2 ACME specific compsets (pointer to a table)
• 1.4 CIME grids
  • 1.4.1 CESM specific grids (pointer to a table)
  • 1.4.2 ACME specific grids (pointer to a table)
• 1.5 CIME supported machines
  • 1.5.1 CESM supported machines (pointer to a table)
  • 1.5.2 ACME supported machines (pointer to a table)
• 1.6 Input data
• 1.7 Diagnostics
• 1.8 CIME quick start

2. Creating and Setting up a Case

• 2.1 How to create a new case
  • 2.1.1 Component Set Naming Convention
  • 2.1.2 Overall Model Grid Naming Convention
  • 2.1.3 Using create_newcase
• 2.2 How to set up a case and customize the PE layout
  • 2.2.1 Calling case.setup
  • 2.2.2 Changing the PE layout
• 2.3 Multi-instance component functionality
• 2.4 Modifying an xml file
• 2.5 Cloning a case (Experts only)

3. Building a case

• 3.1 How do I build my model?
• 3.2 Input data
  • 3.2.1 User-created input data
  • 3.2.2 Using the input data server
• 3.3 Rebuilding the model

4. Running a case

• 4.1 Customizing runtime settings
  • 4.1.1 Controlling starting, stopping and restarting a run
  • 4.1.2 Customizing component-specific namelist settings
  • 4.1.3 Controlling output data
• 4.2 Load balancing a case
  • 4.2.1 Model timing data
  • 4.2.2 Using model timing data
• 4.3 How do I run a case?
  • 4.3.1 Setting the time limits
  • 4.3.2 Submitting the run
  • 4.3.3 Restarting a run
  • 4.3.4 Data flow during a model run
• 4.4 Testing a case

5. Porting and Validating CIME on a new platform

• 5.1 Porting Overview
• 5.3 Step 2: Enabling out-of-the box capability for your machine
• 5.4 Step 3: Port Validation

6. Use Cases and FAQs

• 6.1 BASICS: A basic example
• 6.2 BASICS: How do I set up a branch or hybrid run?
• 6.3 BASICS: What calendars are supported in CIME?
• 6.4 BASICS: How do I change processor counts and component layouts on processors?
• 6.5 BASICS: What are CIME xml variables and CIME environment variables?
• 6.6 BASICS: How do I modify the value of CIME xml variables?
• 6.7 BASICS: Why aren't my $CASEROOT xml variable changes working?
• 6.8 BASICS: How do I run multiple cases all using a single executable?
• 6.9 BASICS: How do I use the ESMF library and ESMF interfaces?
• 6.10 BASICS: Why is there file locking and how does it work?
• 6.11 BASICS: What are the directories and files in my case directory?
• 6.12 IO: What is pio?
• 6.13 IO: How do I use pnetcdf?
• 6.14 CAM: How do I customize CAM output fields?
• 6.15 CAM: How do I customize CAM forcings?
• 6.16 CAM/CLM: How do I change history file output frequency and content for CAM and CLM during a run?
• 6.17 CAM: How do I use B compset history output to create SST/ICE data files to drive an F compset?
• 6.18 POP/CICE: How are CICE and POP decompositions set and how do I override them?
• 6.19 POP: How do I initialize POP2 with a spun-up initial condition?
• 6.20 DRIVER: Is there more information about the coupler/driver implementation?
• 6.21 DRIVER: How do I pass in new fields between components?
• 6.22 EXPERTS: How do I add a new user-defined component set?
• 6.23 EXPERTS: How do I add a new user-defined grid?
• 6.24 EXPERTS: How do I carry out data assimilation using CAM and DART?
• 6.25 EXPERTS: How do I add a new CIME model component?

7. CIME Testing

• 7.1 Testing overview
• 7.2 Using create_production_test
• 7.3 Using query_tests
• 7.4 Using create_test
• 7.5 Debugging Tests That Fail

8. Troubleshooting

• 8.1 Troubleshooting create_newcase
• 8.2 Troubleshooting job submission problems
• 8.4 Additional Troubleshooting Information

9.0 Glossary

top