Skip to content

Commit 412add6

Browse files
committed
attempt at visual representation of directory structure
1 parent c47f359 commit 412add6

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

docs/design/directory-structure.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,60 @@
22

33
This page lists out the directory structure for CAM-SIMA, and what the general purpose of each directory and subdirectory is.
44

5+
## Overview
6+
Linked directories represent externals submodules (except .lib/git-fleximod, which is not a submodule but instead code copied from the external repository)
7+
<small><pre>
8+
CAM-SIMA
9+
|-- .github
10+
|-- [.lib/git-fleximod](https://github.com/ESMCI/git-fleximod)
11+
|-- bin
12+
|-- [ccpp_framework](https://github.com/NCAR/ccpp-framework)
13+
|-- [ccs_config](https://github.com/ESMCI/ccs_config_cesm)
14+
|-- [cime](https://github.com/ESMCI/cime)
15+
|-- cime_config
16+
|-- components
17+
| |-- [cdeps](https://github.com/ESCOMP/CDEPS)
18+
| |-- [cice](https://github.com/ESCOMP/CESM_CICE)
19+
| |-- [cism](https://github.com/ESCOMP/CISM-wrapper)
20+
| |-- [clm](https://github.com/ESCOMP/CTSM)
21+
| |-- [cmeps](https://github.com/ESCOMP/CMEPS)
22+
| |-- [mizuRoute](https://github.com/ESCOMP/mizuRoute)
23+
| |-- [mosart](https://github.com/ESCOMP/MOSART)
24+
| |-- [rtm](https://github.com/ESCOMP/RTM)
25+
|-- docker
26+
|-- libraries
27+
| |-- [FMS](https://github.com/ESCOMP/FMS_interface)
28+
| |-- [parallelio](https://github.com/NCAR/ParallelIO)
29+
|-- [share](https://github.com/ESCOMP/CESM_share)
30+
|-- src
31+
| |-- control
32+
| |-- core_utils
33+
| |-- cpl
34+
| | |-- nuopc
35+
| |-- data
36+
| |-- dynamics
37+
| | |-- mpas
38+
| | | |-- assets
39+
| | | |-- driver
40+
| | | |-- [dycore](https://github.com/MPAS-Dev/MPAS-Model)
41+
| | |-- none
42+
| | |-- se
43+
| | | |-- dycore
44+
| | |-- tests
45+
| | | |-- initial_conditions
46+
| | |-- utils
47+
| |-- history
48+
| |-- physics
49+
| | |-- [ncar_ccpp](https://github.com/ESCOMP/atmospheric_physics)
50+
| | |-- utils
51+
| |-- utils
52+
|-- test
53+
| |-- system
54+
| |-- unit
55+
| | |-- sample_files
56+
|-- tools
57+
</pre></small>
58+
559
## Top-level external directories
660

761
These directories contain external repository source code, libraries, or tools, and usually are only present after `bin/git-fleximod update` has been run.

0 commit comments

Comments
 (0)