Skip to content

Commit a70ac27

Browse files
authored
Merge pull request #569 from CliMA/he/2m-api-docs
update 2M API docs format
2 parents 957af82 + 8fa1fdc commit a70ac27

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

docs/bibliography.bib

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -747,3 +747,15 @@ @article{Gunn1949
747747
year={1949},
748748
publisher={American Meteorological Society}
749749
}
750+
751+
@article{WackerSeifert2001,
752+
title = {Evolution of rain water profiles resulting from pure sedimentation: Spectral vs. parameterized description},
753+
journal = {Atmospheric Research},
754+
volume = {58},
755+
number = {1},
756+
pages = {19-39},
757+
year = {2001},
758+
issn = {0169-8095},
759+
doi = {10.1016/S0169-8095(01)00081-3},
760+
author = {Ulrike Wacker and Axel Seifert},
761+
}

docs/src/API.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,24 @@ Microphysics1M.snow_melt
4141
# 2-moment precipitation microphysics
4242
```@docs
4343
Microphysics2M
44-
Microphysics2M.LiqRaiRates
44+
```
45+
## Size distributions
46+
47+
### Parameters
48+
```@docs
4549
Microphysics2M.pdf_cloud_parameters
4650
Microphysics2M.pdf_rain_parameters
51+
```
52+
53+
### Size distributions
54+
```@docs
4755
Microphysics2M.size_distribution
4856
Microphysics2M.get_size_distribution_bound
57+
```
58+
59+
## Rates
60+
```@docs
61+
Microphysics2M.LiqRaiRates
4962
Microphysics2M.autoconversion
5063
Microphysics2M.accretion
5164
Microphysics2M.liquid_self_collection

0 commit comments

Comments
 (0)