Skip to content

Commit 3de1a0d

Browse files
committed
Add new atmospheric_physics section with directory structure page.
1 parent a5e61eb commit 3de1a0d

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# atmospheric_physics directory structure
2+
3+
This page lists out the directory structure for the atmospheric_physics repo, and what the general purpose of each directory and subdirectory is.
4+
5+
## Top-level directories
6+
7+
These directories represent code and tools that is solely contained within the atmospheric_physics repository. If there is a sub-directory that is also an external submodule or repository it will be marked with the "(external)" label.
8+
9+
### **doc/**
10+
11+
Contains files used to document the current state of the atmospheric_physics repository, such as a `ChangeLog` and the `NamesNotInDictionary.txt` file which lists all standard names that are currently not in the official [CCPP Standard Names repo](https://github.com/ESCOMP/CCPPStandardNames).
12+
13+
### **schemes/**
14+
15+
Contains subdirectories for all of the CCPP-ized physics schemes, with the subdirectories containing the core physics scheme source code,
16+
the associated CCPP metadata files, namelist XML files, and any relevant depdendency files.
17+
18+
Note that there is a special `to_be_ccppized` subdirectory which contains source code that is needed by certain CCPP physics schemes, but which is not
19+
yet fully CCPP compliant (e.g. may have code that is host-model specific).
20+
21+
### **suites/**
22+
23+
Contains CCPP Suite Definition Files (SDFs) for official scientific and production configurations of the CAM-SIMA host model.
24+
25+
### **test/**
26+
27+
Contains code and tools used to run tests on the CCPP-ized physics schemes.
28+
29+
**Subdirectories**:
30+
31+
- cmake - Contains cmake files needed to configure and build unit tests.
32+
- docker - Contains dockerfiles needed to configure, butild, and run unit tests.
33+
- include - Contains utility source code needed to build and run unit tests.
34+
- musica - Contains test code for the CCPP-ized [Multie-Scale Infrastructure for Chemistry Modeling (MUSICA)](https://github.com/NCAR/musica) components.
35+
- test_suites - Contains test SDFs for use in CAM-SIMA snapshot regression testing.

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ nav:
3232
- Usage:
3333
- usage/creating-a-case.md
3434
- usage/history.md
35+
- Atmospheric_physics:
36+
- directory-structure.md
3537

3638
plugins:
3739
- search

0 commit comments

Comments
 (0)