AER-RC / MT_CKD

AER continuum model for water vapor and other gases.
15 stars 10 forks source link

Documentation #2

Closed Nicholaswogan closed 2 years ago

Nicholaswogan commented 2 years ago

I think the README needs improved documentation. I think it should say something like the following


MT_CKD

MT_CKD is an empirical parameterization of the "water vapor continuum" absorption. This parameterization is used in combination with other opacity sources (line absorption, Rayleigh scattering, etc.) to model how radiation passes through gases (e.g. see the LBLRTM model).

This repository contains a Fortran program which will compute MT_CKD absorption coefficients as a function of wavelength and temperature.

Building and Usage

Clone this repository, and update the submodules:

git clone https://github.com/AER-RC/MT_CKD.git
cd MT_CKD
git submodule init
git submodule update

Navigate to the build directory, and build.

cd build
make -f make_cntnm <target>

The value of <target> depends on your OS and Fortran compiler. For example, to build on MacOS with gfortran, use make -f make_cntnm osxGNUdbl. To see all options run make -f make_cntnm.

After running make, an executable is produce in the root directory of the repository.... etc [EXPLAIN HOW TO RUN].


Nicholaswogan commented 2 years ago

Which commit justifies closing this? @pernak18