Skip to content

Commit 8afa2b7

Browse files
authored
add "Acknnowledgement and citations" section to README.md (#405)
1 parent 9435aa2 commit 8afa2b7

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,47 @@ Could not find NC_M4 using the following names: m4, m4.exe
299299
```
300300
Try installing `m4` (e.g., using [MSYS2](https://packages.msys2.org/package/m4?repo=msys&variant=x86_64) on Windows).
301301
302+
## Acknowledgement and citations
303+
304+
We would greatly appreciate citation of the PartMC model description paper (Riemer et al., 2009)
305+
and the PyPartMC description paper (D’Aquino et al., 2024) if PyPartMC was used in your study.
306+
The citations are:
307+
- Riemer, N., M. West, R. A. Zaveri, R. C. Easter: Simulating the evolution of soot
308+
mixing-state with a particle-resolved aerosol model
309+
J. Geophys. Res., 114, D09202, 2009, DOI: [10.1029/2008JD011073](https://doi.org/10.1029/2008JD011073)
310+
- D’Aquino, Z., S. Arabas, J. H. Curtis, A. Vaishnav, N. Riemer, M. West: PyPartMC: A
311+
pythonic interfact to a particle-resolved, Monte Carlo aerosol simulation framework
312+
SoftwareX, 25, 101613, 2024, DOI: [10.1016/j.softx.2023.101613](https://doi.org/10.1016/j.softx.2023.101613)
313+
314+
The following paragraph provides a more substantial description of PartMC (text released into the public domain and can be freely copied by anyone for any purpose):
315+
316+
> PartMC is a stochastic, particle-resolved aerosol box model. It tracks the
317+
composition of many computational particles (10⁴ to 10⁶) within a well-mixed air
318+
volume, each represented by a composition vector that evolves based on physical
319+
and chemical processes. The physical processes—including Brownian coagulation,
320+
new particle formation, emissions, dilution, and deposition—are simulated using a
321+
stochastic Monte Carlo approach via a Poisson process while chemical processes are
322+
simulated deterministically for each computational particle. The weighted flow
323+
algorithm (DeVille, Riemer, and West, 2011, 2019) enhances efficiency and reduces
324+
ensemble variance. Detailed numerical methods are described in Riemer et al.
325+
(2009), DeVille et al. (2011, 2019), and Curtis et al. (2016). PartMC is open-source
326+
under the GNU GPL v2 and available at
327+
[github.com/compdyn/partmc](https://github.com/compdyn/partmc).
328+
>
329+
> References:
330+
> - Curtis, J. H., M. D. Michelotti, N. Riemer, M. T. Heath, M. West: Accelerated
331+
simulation of stochastic particle removal processes in particle-resolved aerosol
332+
models, J. Computational Phys., 322, 21-32, 2016, DOI: [10.1016/j.jcp.2016.06.029](https://doi.org/10.1016/j.jcp.2016.06.029)
333+
> - DeVille, L., N. Riemer, M. West, Convergence of a generalized weighted flow
334+
algorithm for stochastic particle coagulation, J. Computational Dynamics, 6, 69-94,
335+
2019, DOI: [10.3934/jcd.2019003](https://doi.org/10.3934/jcd.2019003)
336+
> - DeVille, R. E. L., N. Riemer, M. West, The Weighted Flow Algorithm (WFA) for
337+
stochastic particle coagulation, J. Computational Phys., 230, 8427-8451, 2011,
338+
DOI: [10.1016/j.jcp.2011.07.027](https://doi.org/10.1016/j.jcp.2011.07.027)
339+
> - Riemer, N., M. West, R. A. Zaveri, R. C. Easter, Simulating the evolution of soot
340+
mixing-state with a particle-resolved aerosol model, J. Geophys. Res., 114, D09202,
341+
2009., DOI: [10.1029/2008JD011073](https://doi.org/10.1029/2008JD011073)
342+
302343
## Credits
303344
304345
#### PyPartMC:

0 commit comments

Comments
 (0)