Necessary libraries to compile V_Sim on Unix platforms:
-------------------------------------------------------

The following libraries are required to compile V_Sim:
- GTK, development files (usually called libgtk2.0-dev in Debian-like distributions)
  The corresponding dependencies are also required (this includes pkg-config,
  GLIB development files) ;
- OpenGL, development files (manely gl.h, glu.h and glx.h).
The following packages are not mandatory:
- NetCDF, development files (for the ETSF support) ;
- Openbabel, development files (from version 2.0.0) ;
- gtk-doc, for the built-in documentation of the API ;
- ABINIT, with binding support for C (from version5.8.x).


Installing V_Sim on Unix like platforms:
----------------------------------------

I suppose that you have downloaded v_sim-3.0.tar.gz in some working-directory
and then ungzipped and untarred it:
> gzip -d -c v_sim-3.0.tar.bz2 | tar xvf -
or, if your tar command supports it:
> tar -jxvf v_sim-3.0.tar.bz2

Now, I suppose you are reading this INSTALL file in:
> working-directory/v_sim-3.0_package

Please cd working-directory/v_sim-3.0_package then type:
> ./configure
> make
> make install
> make clean

In the above ./configure has many options available. Type ./configure --help for
a short explanation. It understands all the GNU basic arguments plus some
specific ones for V_Sim :
- use --prefix=install_directory to specify your installation directory (/usr/local is
  default).
- use --enable-debug-messages to compile V_Sim with debug message (default is
  disable).
- use --enable-gtk-doc to build the documentation of the API (default is disable).
  There are some other less important option to customize V_Sim more precisely.

From version 3.3, plug-ins can be compiled with V_Sim. Several are shipped with the V_Sim package:
- use --with-etsf-file-format to build the support of ETSF files. It requires the
  NetCDF library (runtime and devel files).
- use --with-openbabel to add support of all file format available with OpenBabel
  library. It requires this last library (runtime and devel files).
- use --with-xsf to add support of XCrysDen Structure File format (from version 3.4).
- use --with-abinit to add support of ABINIT input files (from version 3.4).
  This doesn't create an external plug-in, but the support is compiled directly
  inside V_Sim. From version 3.5 it also import the symmetry analysis.
- use --with-cube to add support of Cube File format, structures and densities
  (from version 3.5).

When 'make install' is done, it will copy all the following files :
- to $(prefix)/bin, it will copy the binary v_sim.
- to $(prefix)/etc/v_sim, it will copy v_sim.par.
- to $(prefix)/share/v_sim, it will copy v_sim.res, v_sim.rc and the directory
  pixmaps.
- to $(prefix)/share/doc/v_sim, it will copy some legal informations and the directory
  APIreference (if --enable-gtk-doc has been given).
- to $(prefix)/lib/v_sim/plug-ins, it will copy the compiled plug-ins.


Compiling from SVN sources:
---------------------------

Before doing configure make makeinstall, as stated before, it is necessary to
generate the build system with the autotools. It requires to have installed:
- autotools (automake and autoconf) ;
- gtk-doc ;
- intltool ;
- libtool.

Then after the svn co, issue:
./autogen.sh in V_Sim source directory.

