PHYsique EXternalisée
This document is a presentation of the PHYEX package. It is divided into different sections:
- Developer: package organisation, how to contribute, coding norms
- Coding norms: coding norms
- Integrator: how to merge contributions
- Offline: how to compile the library and the test programs, how to use the library with python and how to use the test programs
- Plugging : how to plug the physics package in a model
- Tools: description of the check_commit_*.sh scripts (to check bit reproducibility between two commits) and of the prep_code.sh script
This document is written using the markdown language. With pandoc, each md file can be converted to HTML (pandoc -s <filename>.md -o <filename>.html) or PDF (pandoc -s <filename>.md -o <filename>.pdf). In addition, the tools directory contains the generate_standalone_doc.sh script that can build a standalone pdf or html file.
The physics was first developed for the Meso-NH model.
Then, a part of the physics have been used to build the AROME model (Seity et al, 2011).
The last evolution was to extract the physics to build the independent PHYEX package.
The following parametrisations are included in the PHYEX package (see the MesoNH documentation for references):
- turbulence scheme
- shallow convection scheme
- microphysics schemes
In addition to the parametrisations source code, test programs and a library for python binding are also provided.