Welcome to Hermes2D!

This is a README file for Linux.

Documentation
=============

Hermes2D Sphinx documentation (tutorial, benchmarks, examples) can be found in
the directory 'doc/'. Type 'make html' there to build it. The documentation is
available online at http://hpfem.org/hermes2d/doc/index.html.

Developer documentation can be compiled by running 'doxygen' in 'src/'.


Compilation
===========

If you are using a Debian-based system, install the required libraries first:

$ apt-get install cmake g++ gfortran libjudy-dev freeglut3-dev libsuitesparse-dev libglew1.5-dev python-dev python-numpy python-scipy cython python-matplotlib

(Note: cmake has to be at least version 2.6 or later, matplotlib has to be at
least 0.98.5.2 or higher.)

Configure:

$ cmake .

Build:

$ make

If you have more than one CPU, you can use "make -j N" where N is
the number of CPUs of your computer.

Tests
-----

To execute all tests, do:

$ make test

Note that some of the tests take a long time to finish. To just execute the
short running tests, do:

$ make test-quick


More options
------------

You can turn on and off various components to build, just create the CMake.vars
file and add the following:

set(WITH_EXAMPLES NO)
set(WITH_PYTHON YES)

(and any other option that you would like to change, see CMakeLists.txt for the
whole list).

You can also easily generate it from a script (e.g. a debian/rules file) by:

python -c 'print "set(COMPLEX no)\nset(WITH_EXAMPLES no)\nset(WITH_TUTORIAL no)\nset(WITH_PYTHON yes)\nset(WITH_GLUT no)\nset(WITH_UTIL no)"' > CMake.vars

If you are on OS X, you have to disable GLUT as the glut library is not easily
installable on OS X. To do so, just put the following line into your
CMake.vars:

set(WITH_GLUT NO)


For development, it is good to say (in global CMake.vars):

	set(DEBUG YES) to compile debug versions
	set(RELEASE YES) to compile release versions

Then type:

$ make debug    (to build debug versions)
$ make release  (to build release versions)


Install Hermes2D
----------------

cmake -DCMAKE_INSTALL_PREFIX=~/usr .
make
make install