Skip to content

Commit fd841b5

Browse files
authored
Improve code documentation for MPAS dynamical core (#356)
### Tag name (required for release branches): None ### Originator(s): kuanchihwang ### Descriptions (include the issue title, and the keyword ['closes', 'fixes', 'resolves'] followed by the issue number): Improve code documentation for MPAS dynamical core. * Add license header to each module * Add descriptions to each module * Keep code comments up-to-date * Add support for auto-generating API documentation by using Fortran Documenter (FORD) ### Describe any changes made to the build system: None ### Describe any changes made to the namelist: None ### List any changes to the defaults for the input datasets (e.g., boundary datasets): None ### List all files eliminated and why: None ### List all files added and what they do: * `A src/dynamics/mpas/assets/ford-config.md` * Add configuration file for Fortran Documenter (FORD) ### List all existing files that have been modified, and describe the changes: * `M src/dynamics/mpas/driver/dyn_mpas_subdriver.F90` * Add license header to each module * Add descriptions to each module * Improve code documentation * `M src/dynamics/mpas/dyn_comp.F90` * Add license header to each module * Add descriptions to each module * Improve code documentation * `M src/dynamics/mpas/dyn_coupling.F90` * Add license header to each module * Add descriptions to each module * Improve code documentation * `M src/dynamics/mpas/dyn_grid.F90` * Add license header to each module * Add descriptions to each module * Improve code documentation * `M src/dynamics/mpas/stepon.F90` * Add license header to each module * Add descriptions to each module ### Regression tests: This is a documentation-only PR. No changes are expected to any existing tests.
1 parent 3699359 commit fd841b5

File tree

6 files changed

+419
-304
lines changed

6 files changed

+419
-304
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
project: MPAS Dynamical Core
3+
summary: MPAS dynamical core solves the fully compressible non-hydrostatic equations of atmospheric motion.
4+
author: CAM-SIMA & MPAS Developers
5+
github: https://github.com/ESCOMP/CAM-SIMA
6+
website: https://sima.ucar.edu
7+
src_dir: ..
8+
exclude_dir: ../assets
9+
../dycore
10+
output_dir: ./ford
11+
extensions: F90
12+
f90
13+
fixed_extensions: F
14+
f
15+
fixed_length_limit: false
16+
fpp_extensions: F
17+
F90
18+
preprocess: true
19+
preprocessor: gfortran -E
20+
display: private
21+
protected
22+
public
23+
graph: true
24+
lower: true
25+
proc_internals: true
26+
search: false
27+
sort: alpha
28+
source: true
29+
---
30+
31+
Model for Prediction Across Scales (MPAS) is one of the supported atmospheric dynamical cores in Community Atmosphere Model - System for Integrated Modeling of the Atmosphere (CAM-SIMA). CAM-SIMA is the next-generation atmospheric component of Community Earth System Model (CESM).
32+
33+
This auto-generated documentation provides a developer's guide to the Fortran interface and subdriver of MPAS dynamical core.

0 commit comments

Comments
 (0)