Skip to content

Commit 9a8486e

Browse files
committed
Add configuration file for Fortran Documenter (FORD)
This enables us to generate documentation for MPAS dynamical core.
1 parent 1dbcd72 commit 9a8486e

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed
+33
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)