mainpage doxy

HySoP/DoxyConf/mainpage.doxygen

@@ -14,24 +14,101 @@ The library is also supposed to provide a common framework to the following libr
 - ...
 
 
+===================================================================================================================
+
 \section parmepyInstall Install :
 
-- Download parmepy.tgz
-- untar and change to directory
-- run python install :
+\subsection reqInstall Requirements
+
+- a fortran compiler and a proper mpi implementation
+- fftw 
+- cmake > 2.8
+- a python implementation including numpy and mpi4py.
+
+The install consists in 3 steps. First configuration of the package, makefile, setup.py and other files generation, then build of the underlying fortran libraries and of the python package and finally copy of the required files in the appropriate place.
+
+We denote :
+
+- SOURCEDIR as the directory which contains the sources (and this INSTALL file)
+- BUILDDIR the directory where the package will be configured and build
+- INSTALLDIR the directory where the package will be installed.
+Those 3 locations must be different. 
+
+\subsection config configuration : 
+
+You need to generate some makefile and a setup.py that fits with your platform, your compilers, 
+the libraries versions and so on. That will take place in BUILDDIR.
+
+  -# get SOURCEDIR (i.e. download the package any way you want)
+  -# create BUILDDIR.  Any place, preferably local to your machine for efficiency reasons.
+  -# enforce a fortran compiler using FC environment variable
+  -# Change to BUILDDIR and run cmake
+
+\code
+mkdir BUILDIR 
+cd BUILDDIR
+export FC=mpif90
+cmake SOURCEDIR
+\endcode
+
+At the end of this step BUILDDIR contains all makefiles, setup.py and other required files for compilation.
+
+Some useful options for cmake : 
+
+- -DFFTW_DIR : where to find fftw if it's not in a "standard" place.
+- -DWITH_SCALES=ON/OFF : to compile a parmepy version including scales (default = on)
+- -DWITH_PPM=ON/OFF : to compile  a parmepy version including scales (default = off)
+- -DWITH_TESTS=ON/OFF: enable testing (i.e. prepare target "make test", default = off)
 
+example :
 \code
-tar -zxvf parmepy.tgz
-cd parmepy
-python setup.py install --user
+mkdir /home/mylogin/buildParmes
+cd /home/mylogin/buildParmes
+export FC=mpif90
+module load cmake-2.8
+cmake -DFFTW_DIR=/softs/install/fftw3.1 ~/Softs/Parmes
 \endcode
 
+\subsection buildparmepy Build
+
+You need to build the underlying fortran libraries (mainly libparmes) and the python package.
+Just run "make" to do both.
+make python-build will run only python package building.
+
+\subsection installparmepy Install
+
+Run : 
+\code
+make python-install
+\endcode
+
+\subsection summaryInstall Summary 
+
+Default process :
+\code
+mkdir BUILDDIR
+cd BUILDDIR
+export FC=mpif90
+cmake SOURCEDIR
+make -jN 
+make python-install
+\endcode
+
+Note : -jN for make command runs the build process on N processus. Choose a value of N that fits with your machine.
+
+Other useful commands :
+
+- make python-cleaninstall : to remove all installed files for the current build.
+- make clean : to clean the build (remove modules, .o ...)
+
+===================================================================================================================
+
 \section parmepyuse Use
 
 Use as a classical python package :
 
 \code
-import ParMePy as PP
+import parmepy as PP
 print PP.Box
 \endcode
 and so on ...