/farmR/src/java/dox/main.dox

 1/*!
 2 *  
 3 * \mainpage JFM A Linear Programming Toolkit for Farm Economics.
 4 * 
 5 * JFM is a toolkit for building and solving farming models. It is mainly designed to 
 6 * allow programmers to create their own custom farm models, but it also comes with a 
 7 * sample standalone application called \ref wfmapp that is ready to use. 
 8 * 
 9 * - \ref whatis : For a brief introduction to the project and its origins. 
10 * - \ref lptutorial : For a quick introduction to linear programming. 
11 * - \ref install : For installation instructions on Mac OS X and links to source code. 
12 * - \ref wfmapp : For instructions on how to use the supplied example application. 
13 * - \ref api : To get started building custom model applications. 
14 * - \ref xmlschema : To see how the input format for data works.
15 * - \ref constraints : A list of all the constraints used by JFM
16 * 
17 * \page xmlschema Writing an xml input file 
18 * 
19 *  This section of the documentation isn't done yet 
20 *  
21 * A useful reference containing large amounts of farming data for the UK is;
22 * \verbatim The Agricultural Pocketbook. John Nix (2007) \endverbatim 
23 * 
24 * */