

                  MuPIF: Multi-Physics Integration Framework 
                        Copyright (C) 2010 Borek Patzak

         Czech Technical University, Faculty of Civil Engineering,
     Department of Structural Mechanics, 166 29 Prague, Czech Republic

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
===============================================================================

CONTENTS:
[1] Description
[2] What is here
[3] Pre-requisites
[4] Running Mupif examples


[1] Description
===============================================================================
Multi-Physics Integration Framework (MuPIF) is an integration framework, that 
will facilitate the implementation of multi-physic and multi-level simulations,
built from independently developed components. The principal role of the
framework is to steer individual components (applications) and to provide 
high-level data-exchange services. Each application should implement 
an interface that allows to steer application and execute data requests. 
The design supports various coupling strategies, discretization techniques, 
and also the distributed applications. 

[2] What is here
===============================================================================
The directory tree below holds source code to the MuPIF package. 

MuPIF_TOP_DIR - contains source code of the MuPIF package
|
|-- api - contains the application interfaces to external packages
|
|-- examples - contains examples and tests

[3] Pre-requisites
===============================================================================
The MuPIF requires the python interpreter.

MuPIF interfaces to MayaVi visualization toolkit 
(http://code.enthought.com/projects/mayavi/). Many examples depend on it.

MuPIF depends on application interfaces, which typically require that 
corresponding package is installed properly. See api directory for further 
instructions how to install individual packages.

[4] Running Mupif examples
===============================================================================
Please read examples/README file for instaructions.

Bugs
==============================================================================

Please mail all bug reports and suggestions to [info@oofem.org]. I will try to
give satisfaction, if the time is at least partially on my side. 


                                Enjoy
                                        Borek Patzak
