├── .github └── ISSUE_TEMPLATE │ ├── config.yml │ ├── other.yml │ ├── enhancement_request.yml │ └── bug_report.yml └── README.md /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: CESM forums 4 | url: https://bb.cgd.ucar.edu/cesm/forums/cam.133/ 5 | about: For support with model use, troubleshooting, etc., please use the CESM forum 6 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/other.yml: -------------------------------------------------------------------------------- 1 | name: Other 2 | description: ex. code clean-up, infrastructure updates 3 | title: "Put brief (<65 char) title here!" 4 | body: 5 | - type: dropdown 6 | id: other-type 7 | attributes: 8 | label: Issue Type 9 | description: If applicable, please add relevant label(s) 10 | multiple: true 11 | options: 12 | - Code Clean-up 13 | - Infrastructure Update 14 | - Externals Update 15 | - Documentation Update 16 | - Other (please describe below) 17 | validations: 18 | required: true 19 | - type: textarea 20 | id: issue-description 21 | attributes: 22 | label: Issue Description 23 | description: Describe what will change 24 | validations: 25 | required: true 26 | - type: dropdown 27 | id: answer-changing 28 | attributes: 29 | label: Will this change answers? 30 | description: If yes, please also add the "answer changing" label (if possible) 31 | multiple: false 32 | options: 33 | - "Yes" 34 | - "No" 35 | - "I Don't Know" 36 | validations: 37 | required: true 38 | - type: dropdown 39 | id: implemenation 40 | attributes: 41 | label: Will you be implementing this yourself? 42 | description: If Yes, please also assign this issue to yourself (if possible) 43 | multiple: false 44 | options: 45 | - "Yes" 46 | - "Yes, but I will need some help" 47 | - "No" 48 | - "Any CAM SE can do this" 49 | validations: 50 | required: true 51 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/enhancement_request.yml: -------------------------------------------------------------------------------- 1 | name: Enhancement Request 2 | description: Request an enhancement and/or open a science discussion 3 | title: "Put brief (<65 char) title here!" 4 | labels: ["enhancement"] 5 | body: 6 | - type: textarea 7 | id: enhancement-description 8 | attributes: 9 | label: What is the feature/what would you like to discuss? 10 | placeholder: ex. I'd like to entirely refactor chemistry and here's how. 11 | validations: 12 | required: true 13 | - type: textarea 14 | id: user-reference 15 | attributes: 16 | label: Is there anyone in particular you want to be part of this conversation? 17 | description: Add the user(s) with @ 18 | placeholder: ex. @confucius 19 | validations: 20 | required: false 21 | - type: dropdown 22 | id: answer-changing 23 | attributes: 24 | label: Will this change (regression test) answers? 25 | description: If yes, please also add the "answer changing" label (if possible) 26 | multiple: false 27 | options: 28 | - "Yes" 29 | - "No" 30 | - "I Don't Know" 31 | validations: 32 | required: true 33 | - type: dropdown 34 | id: implemenation 35 | attributes: 36 | label: Will you be implementing this enhancement yourself? 37 | description: If Yes, please also assign this issue to yourself 38 | multiple: false 39 | options: 40 | - "Yes" 41 | - "Yes, but I will need some help" 42 | - "No" 43 | - "Any CAM SE can do this" 44 | validations: 45 | required: true 46 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CAM: The Community Atmosphere Model 2 | 3 | CAM code is stored in this repository on branches other than main. The details are explained below. 4 | 5 | Please see the [wiki](https://github.com/ESCOMP/CAM/wiki) for complete documentation on CAM, getting started with git and how to contribute to CAM's development. 6 | 7 | This repository has four officially-supported branches: 8 | * main - contains this readme and the Code of Conduct information 9 | * cam_cesm2_2_rel - contains the current CESM2.2 CAM code 10 | * cam_cesm2_1_rel - contains the current CESM2.1 CAM code 11 | * cam_development - contains the current CAM development code (see the important note below before using this branch) 12 | 13 | There are other branches in this repo that have a `zz_` prefix which are used for special projects. Please note that use of these branches is not-supported and may very likely produce un-scientific results in certain configurations. 14 | 15 | ## How to checkout and use CAM: 16 | 17 | The instructions below assume you have cloned this repository and are in the repository directory. For example: 18 | ``` 19 | git clone https://github.com/ESCOMP/CAM 20 | cd CAM 21 | ``` 22 | ### To run CAM compatible with the CESM2.2 release: 23 | ``` 24 | git checkout cam_cesm2_2_rel_02 25 | bin/git-fleximod update 26 | ``` 27 | ### To run CAM compatible with the CESM2.1 release: 28 | ``` 29 | git checkout cam_cesm2_1_rel_41 30 | bin/git-fleximod update 31 | ``` 32 | ### To view the release branches in Github, go to the "Branch:main" pulldown menu and select the appropriate branch. 33 | 34 | ### To use unsupported CAM **development** code: 35 | 36 | ## NOTE: This is **unsupported** development code and is subject to the [CESM developer's agreement](https://www.cgd.ucar.edu/sections/cseg/policies). 37 | ``` 38 | git checkout cam6_3_162 39 | bin/git-fleximod update 40 | ``` 41 | ### CAM Documentation - https://ncar.github.io/CAM/doc/build/html/index.html 42 | 43 | ### CAM6 namelist settings - https://docs.cesm.ucar.edu/models/cesm2/settings/current/cam_nml.html 44 | 45 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: Bug Report 2 | description: File a bug report - for CAM developers' use only (all other users should use the CESM forum) 3 | title: "Put brief (<65 char) bug title here!" 4 | labels: ["bug"] 5 | body: 6 | - type: textarea 7 | id: what-happened 8 | attributes: 9 | label: What happened? 10 | description: Also - what did you expect to happen? 11 | placeholder: Tell us what you see! 12 | validations: 13 | required: true 14 | - type: textarea 15 | id: steps-to-reproduce 16 | attributes: 17 | label: What are the steps to reproduce the bug? 18 | description: How can we see this issue? 19 | placeholder: ex. Sneeze twice and then do a 5-second jig 20 | validations: 21 | required: true 22 | - type: input 23 | id: cam-tag 24 | attributes: 25 | label: What CAM tag were you using? 26 | description: Type "git describe" to see the tag 27 | placeholder: ex. cam6_3_042 28 | validations: 29 | required: true 30 | - type: dropdown 31 | id: machine 32 | attributes: 33 | label: What machine were you running CAM on? 34 | multiple: true 35 | options: 36 | - CISL machine (e.g. cheyenne) 37 | - CGD machine (e.g. izumi) 38 | - Docker container 39 | - Personal Computer 40 | - Other (please explain below) 41 | validations: 42 | required: true 43 | - type: dropdown 44 | id: compiler 45 | attributes: 46 | label: What compiler were you using? 47 | multiple: true 48 | options: 49 | - Intel 50 | - GNU 51 | - NAG 52 | - NVHPC 53 | - PGI 54 | - Other (please specify below) 55 | validations: 56 | required: true 57 | - type: input 58 | id: case-directory 59 | attributes: 60 | label: Path to a case directory, if applicable 61 | description: The full path to a case in which the error occurred 62 | placeholder: ex. /glade/scratch/3p0/where-could-he-be 63 | validations: 64 | required: false 65 | - type: dropdown 66 | id: implemenation 67 | attributes: 68 | label: Will you be addressing this bug yourself? 69 | description: If Yes, please also assign this issue to yourself (if possible) 70 | multiple: false 71 | options: 72 | - "Yes" 73 | - "Yes, but I will need some help" 74 | - "No" 75 | - "Any CAM SE can do this" 76 | validations: 77 | required: true 78 | - type: textarea 79 | id: extra-info 80 | attributes: 81 | label: Extra info 82 | description: Please provide any additional information here that you think might be relevant 83 | placeholder: ex. I am running CAM on izumi and I don't know what compiler I'm using. 84 | validations: 85 | required: false 86 | --------------------------------------------------------------------------------