Skip to content

Commit 56dc614

Browse files
committed
Add '/' to directory-structure headings.
1 parent 577d36f commit 56dc614

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

docs/design/directory-structure.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ These directories contain external repository source code, libraries, or tools,
88

99
Please note that any modifications to the source code in these directories should generally be made outside of CAM-SIMA and instead in the associated external repository listed below.
1010

11-
### **bin**
11+
### **bin/**
1212

1313
Contains the `git-fleximmod` tool for downloading needed source code and software from external repositories. More information on `git-fleximod` can be found [here](https://github.com/ESMCI/git-fleximod).
1414

15-
### **ccpp_framework**
15+
### **ccpp_framework/**
1616

1717
Contains the core [CCPP-framework](https://github.com/NCAR/ccpp-framework) source code and tools.
1818

19-
### **ccs_config**
19+
### **ccs_config/**
2020

2121
Contains the configuration files used by CIME to properly configure and build a CAM-SIMA (or CESM) case. The Github repository associated with this directory can be found [here](https://github.com/ESMCI/ccs_config_cesm).
2222

23-
### **cime**
23+
### **cime/**
2424

2525
Contains the [Common Infrastructure for Modeling the Earth (CIME)](https://github.com/ESMCI/cime) tools and associated libraries. Used by CAM-SIMA and CESM for the general configuration and building of a simulation (or "case").
2626

27-
### **components**
27+
### **components/**
2828

2929
Contains the following other CESM components:
3030
- [Community Data Models for Earth Prediction Systems (CDEPS)](https://github.com/ESCOMP/CDEPS)
@@ -37,95 +37,95 @@ Contains the following other CESM components:
3737
- [River Transport Model (RTM)](https://github.com/ESCOMP/RTM)
3838

3939

40-
### **libraries**
40+
### **libraries/**
4141

4242
Contains the following external libraries:
4343
- [Flexible Modeling System (FMS)](https://github.com/ESCOMP/FMS_interface.git)
4444
- [Parallel IO (PIO)](https://github.com/NCAR/ParallelIO)
4545

46-
### **share**
46+
### **share/**
4747

4848
Contains source code [shared across all CESM components](https://github.com/ESCOMP/CESM_share).
4949

5050
## Top-level CAM-SIMA directories
5151

5252
These directories represent code and tools that is solely contained within the CAM-SIMA repository. If there is a sub-directory that is also an external submodule or repository it will be marked with the "(external)" label.
5353

54-
### **cime_config**
54+
### **cime_config/**
5555

5656
Contains the SIMA-specific python and XML configuration routines used by CIME and the CCPP-framework to properly configure and build a CAM-SIMA simulation, including the CCPP-generated caps and namelist files.
5757

58-
**Subdirectories**:
58+
**Subdirectories/**:
5959

6060
- testdefs - Location of the CAM-SIMA regression test list and associated files used by CIME during regression (system) testing.
6161
- testmods_dirs/cam - Location of CAM-SIMA case configuration files used during CIME regression testing.
6262

63-
### **docker**
63+
### **docker/**
6464

6565
Contains files needed to run certain CAM-SIMA configurations in a docker container.
6666

67-
### **src**
67+
### **src/**
6868

6969
Contains all of the SIMA-specific source code needed to run the model. Additional details can be found below in the "Source directories" section.
7070

71-
### **test**
71+
### **test/**
7272

7373
Contains everything needed to perform software testing and validation of CAM-SIMA source code.
7474

7575
**Subdirectories**:
7676

77-
- system - Includes scripts needed to run CIME (integration) regression tests.
78-
- unit - Includes scripts and source code needed to run CAM-SIMA unit tests.
79-
- sample_files - Contains files that are used to validate the unit test results.
77+
- system/ - Includes scripts needed to run CIME (integration) regression tests.
78+
- unit/ - Includes scripts and source code needed to run CAM-SIMA unit tests.
79+
- sample_files/ - Contains files that are used to validate the unit test results.
8080

81-
### **tools**
81+
### **tools/**
8282

8383
Contains non-required scripts and source code that may be useful for CAM-SIMA development.
8484

8585
## **Source (src) directories**
8686

8787
This section lists all of the directories underneath the "src" top-level directory.
8888

89-
### **control**
89+
### **control/**
9090

9191
Contains all of the source code needed for general model configuration, organization, and workflow, i.e. all of the "control" systems.
9292

93-
### **cpl**
93+
### **cpl/**
9494

9595
Contains all of the source code needed for SIMA to interact with a coupler
9696

9797
**Subdirectories**:
9898

99-
- nuopc - Contains the source code needed to interact with the [NUOPC](https://earthsystemmodeling.org/nuopc/) coupler, which is brought in via the CMEPS external.
99+
- nuopc/ - Contains the source code needed to interact with the [NUOPC](https://earthsystemmodeling.org/nuopc/) coupler, which is brought in via the CMEPS external.
100100

101-
### **data**
101+
### **data/**
102102

103103
Contains all of the source code needed to manage internal model data. This includes auto-generated registry and initial conditions files code, physical constants, and atmospheric composition and thermodynamic properties.
104104

105-
### **dynamics**
105+
### **dynamics/**
106106

107107
Contains all of the dynamical core (dycore) source code.
108108

109109
**Subdirectories**:
110110

111-
- mpas - Contains all of the source code needed for SIMA to properly couple to the [MPAS dynamical core](https://github.com/MPAS-Dev/MPAS-Model).
112-
- dycore (external) - External submodule that contains the MPAS dycore code.
113-
- none - Contains the "null" dycore source code, which allows physics and chemistry routines to be forced with atmospheric data coming directly from input files as opposed to dycore calculations.
114-
- se - Contains all of the source code needed for SIMA to properly couple to the [Spectral Element dynamical core](https://ncar.github.io/CAM/doc/build/html/cam5_scientific_guide/dynamics.html#spectral-element-dynamical-core).
115-
- dycore - Contains the internal SE dycore source code files.
116-
- tests - Contains the source code needed to configure analytic initial conditions for dycores.
117-
- initial_conditions - Contains source code needed to configure specific analytic initial conditions formulations.
118-
- utils - Contains utility code used by all dycores in SIMA.
111+
- mpas/ - Contains all of the source code needed for SIMA to properly couple to the [MPAS dynamical core](https://github.com/MPAS-Dev/MPAS-Model).
112+
- dycore/ (external) - External submodule that contains the MPAS dycore code.
113+
- none/ - Contains the "null" dycore source code, which allows physics and chemistry routines to be forced with atmospheric data coming directly from input files as opposed to dycore calculations.
114+
- se/ - Contains all of the source code needed for SIMA to properly couple to the [Spectral Element dynamical core](https://ncar.github.io/CAM/doc/build/html/cam5_scientific_guide/dynamics.html#spectral-element-dynamical-core).
115+
- dycore/ - Contains the internal SE dycore source code files.
116+
- tests/ - Contains the source code needed to configure analytic initial conditions for dycores.
117+
- initial_conditions/ - Contains source code needed to configure specific analytic initial conditions formulations.
118+
- utils/ - Contains utility code used by all dycores in SIMA.
119119

120-
### **physics**
120+
### **physics/**
121121

122122
Contains all of the SIMA physics and chemistry source code.
123123

124124
**Subdirectories**:
125125

126-
- ncar_ccpp (external) - External submodule that contains all of the code in the [atmospheric_physics](https://github.com/ESCOMP/atmospheric_physics) repo.
127-
- utils - Contains SIMA-specific utility routines for working with the CCPP-framework and CCPP-ized physics routines.
126+
- ncar_ccpp/ (external) - External submodule that contains all of the code in the [atmospheric_physics](https://github.com/ESCOMP/atmospheric_physics) repo.
127+
- utils/ - Contains SIMA-specific utility routines for working with the CCPP-framework and CCPP-ized physics routines.
128128

129-
### **utils**
129+
### **utils/**
130130

131131
Contains source code for generic SIMA utility routines that can be used throughout the model.

0 commit comments

Comments
 (0)