OpenFLUID sources
=================

The OpenFLUID source tree is organized as follow
- cmake : CMake files included in main build system 
- doc/manuals : latex sources of the manuals
- doc/API-doxygen : doxygen files for API documentation
- doc/examples : latex sources of the examples documentation
- po : i18n files
- resources/examples : examples of simulation functions, with build system files
- resources/packaging : files used for packaging
- resources/graphics : source graphics used in documentation
- share : shared resources at runtime
- src/apps/openfluid-engine : sources of the openfluid-engine application
- src/apps/openfluid-builder : sources of the openfluid-builder application
- src/openfluid : sources of the OpenFLUID framework


The required libraries are:
for the OpenFLUID framework libraries: 
  - C++ STL
  - Boost (system, filesystem)
  - libXML2
  - Glibmm 
  - libCURL
  - GDAL/OGR
for openfluid-engine application: 
  - OpenFLUID framework libraries
  - C++ STL
  - Boost (system, filesystem, program_options, date_time, regex)  
for openfluid-builder application: 
  - OpenFLUID framework libraries
  - C++ STL
  - Boost
  - Gtkmm


For unit testing, the Boost unit testing framework is also required (unit_test_framework)


For building Latex documents, required tools and packages are:
- pdflatex
- latex2html
- packages: a4wide, babel, ltxtable, pgf/tikz, tabularx, verbatim
- fonts: cmbright


Further information is available on the OpenFLUID community web site:  
  http://www.umr-lisah.fr/openfluid/community/