research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fixing up doxygen documentation

Browse source
This commit is contained in:
Nicholas Malaya 2012-07-18 23:28:05 +00:00
parent 3e9ee5ccbe
commit e25c671ee8
4 changed files with 1630 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/Makefile.am
View file

@ -1,5 +1,4 @@
EXTRA_DIST = cantera.dox cantera.page txt_common fig_common
EXTRA_DIST += install.page tutorial.page
SUBDIR = doxygen
dist-hook:
rm -rf `find $(distdir)/ -name .svn`

4
doc/doxygen/Makefile.am
View file

@ -1,6 +1,4 @@
#txt_common fig_common
EXTRA_DIST = Cantera.txt
#EXTRA_DIST += install.page tutorial.page
EXTRA_DIST = Cantera.txt cantera.page cantera.doc
dist-hook:
rm -rf `find $(distdir)/ -name .svn`

1540
doc/doxygen/cantera.dox Normal file
View file

File diff suppressed because it is too large Load diff

88
doc/doxygen/cantera.page Normal file
View file

@ -0,0 +1,88 @@
/*! \mainpage The CORE Library
<b>Version \version</b>, Build Date: \builddate
Built by: \builduser on \buildhost
<hr>
\section overview Overview
Thank you for your interest in CORE. To aid in usage, this manual is
further divided into the following subsections:
<ul>
<li> \subpage model "Library Overview" </li>
<li> \subpage install "Installation/Linkage" </li>
<li> \link core.h C/C++ Interface \endlink </li>
<li> \subpage apif "Fortran Interface" </li>
<li> \link tut "Tutorial" </li>
</ul>
<!-- \subpage apiF Fortran API -->
<!-- \subpage examples Examples -->
\section bugs Reporting Bugs
Bugs in the code and errors or omissions in the documentation can be
reported to nick@ices.utexas.edu. Requests and contributions are
welcome at the same e-mail address. All bug reports should include:
<ul>
<li>the version number of the library,
<li>the hardware and operating system,
<li>the compiler used, including version number and compilation options,
<li>a description of the bug behavior, and ideally,
<li>a short program which reproduces the bug.
</ul>
\section licence License
Copyright (C) 2010 The PECOS Development Team
\copydoc LicenseLGPL
\section acknowledgements Acknowledgments
\copydoc Acknowledgments
\section pecos-center More Information About PECOS
\copydoc About2
*/
/*! \page model Library Overview
\copydoc LicenseLGPL
This is a chemical kinetics library.
<h2>Chemical Kinetics Overview</h2>
This library is designed to simplify the process of accessing chemical kinetics.
<h2>PECOS Center Background</h2>
The Center for Predictive Engineering and COmputational Sciences (PECOS) is a DOE-funded Center
of Excellence within the Institute for Computational Engineering and Sciences (ICES)
at The University of Texas at Austin. PECOS is one of five such centers sponsored under
the Predictive Science Academic Alliance Program (PSAAP) of the National Nuclear Security
Administration’s Advanced Simulation and Computing Program.
PECOS brings together an interdisciplinary, multi-university team with partners at the
DOE National Labs and NASA. The goal of the PECOS Center is to develop the next generation
of advanced computational methods for predictive simulation of multiscale, multiphysics phenomena,
and to apply these methods to the analysis of vehicles reentering the atmosphere. In pursuing
this research, PECOS is advancing the science and modeling of atmospheric reentry, and
the science of predictive simulation.
<h2> Developers </h2>
Developers of the library include:
Sylvain Plessis
<a href="mailto:nick@ices.utexas.edu">Nicholas Malaya</a>
Chris Simmons
<h2> Citing </h2>
Please add the following citation.