https://github.com/ncar/ccpp-doc
Technical Documentation for the Common Community Physics Package (CCPP)
https://github.com/ncar/ccpp-doc
ccpp documentation
Last synced: 3 months ago
JSON representation
Technical Documentation for the Common Community Physics Package (CCPP)
- Host: GitHub
- URL: https://github.com/ncar/ccpp-doc
- Owner: NCAR
- Created: 2019-08-28T17:25:10.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-08-08T20:27:16.000Z (10 months ago)
- Last Synced: 2026-03-02T02:21:49.220Z (4 months ago)
- Topics: ccpp, documentation
- Language: HTML
- Homepage:
- Size: 3.63 MB
- Stars: 0
- Watchers: 8
- Forks: 33
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# ccpp-doc
This repository contains the technical documentation for the Common Community Physics Package (CCPP),
maintained and developed at the Developmental Testbed Center (DTC). The latest documentation, as well
as documentation for previous versions, can be viewed at
[the DTC website](https://dtcenter.org/community-code/common-community-physics-package-ccpp/documentation).
## Notes to Developers
The documentation is generated with Sphinx, using the reStructuredText (*.rst*) files in the
*CCPPtechnical/source* directory. Output can be generated in HTML or PDF formats.
## Prerequisites
In order to create the technical documentation as described below, Sphinx and its
extension sphinxcontrib-bibtex need to be installed on the system. If PDF output
is required, TeX/LaTeX must also be installed.
Sphinx can be installed in various ways (see
[https://www.sphinx-doc.org/en/master/usage/installation.html]([https://www.sphinx-doc.org/en/master/usage/installation.html])),
for example using Anaconda:
```
conda install sphinx
conda install -c conda-forge sphinxcontrib-bibtex
```
Comprehensive TeX/LaTeX distributions are provided for Windows, macOS and Linux.
For more information see [https://www.latex-project.org/get/](https://www.latex-project.org/get/).
## Creating the technical documentation
To generate the technical documentation:
1. Clone the repository.
```
git clone https://github.com/NCAR/ccpp-doc.git
```
2. Build the HTML document.
```
cd ccpp-doc/CCPPtechnical
make html
```
This will generate HTML files in *./build/html*.
3. Build the PDF document.
```
cd ccpp-doc/CCPPtechnical
make latexpdf
```
This will generate a PDF file *./build/latex/CCPPtechnical.pdf*.