CMIT2 Documentation

You can get help for developing and running the CMIT 2 code in several places:

• See the README for general information on the Coupled Magnetosphere Ionosphere Thermosphere model (CMIT 2.5) (aka LTR).
• To learn how to run the code, consult the LTR wiki.
• To learn more about the guts of the code (numerics, how to use individual functions, etc.) generate the Doxygen documentation (see below).

Building the Doxygen Documentation

We try to use Doxygen whenever practical to document components of the CMIT code. This documentation is most useful for developmental purposes, rather than "how do I run the code"-type questions, which should be answered in the LTR wiki.

To generate all Doxygen documenation, make sure you have Doxygen installed and build the "documentation" target from the master Makefile.

      cd /path/to/LTR-para
      gmake documentation
    

Accessing the Doxygen Documentation

You may access the Doxygen-generated documentation for each of the components below once you have built the documentation:

• LFM - Lyon Fedder Mobarry (LFM) parallel (MPI) Magnetosphe model
• common - CMIT-2.5 (LTR) common code
• MIX - Magnetosphere-Ionosphere Coupler/Solver