Installation

Here are the instructions to install the MyCGR software.

MyCGR works under UNIX/Linux (perhaps under Microsoft Windows via MinGW, but that was never tested).

Pre-requisites

Objective-Caml version 3.09.2 or higher is required for compilation (in particular the compiler towards native code), as well as the following tools and OCaml libraries:

  • LablGtk2 >= 2.6.0: interface with the Gtk2 library. libglade must be supported.
  • XML-Light >= 2: library to read/write XML files.
  • Cameleon2 >= 1.9.13: tools and libraries for software development in OCaml.
  • MLGraph 2.1: library to create images in [Embedded-]PostScript format.
  • OCaml-Gnuplot : interface with the Gnuplot drawing tool.
  • OCamlgsl 0.4.0: interface with the GNU Scientific Library.
  • Findlib >= 1.0.4: OCaml libraries management tool.
  • OCaml-MySQL >= 1.0.3: interface with the MySQL library.
  • Cryptokit >= 1.3: library implementing various algorithms of encoding and encoding.

LablGL(>= 1.01), interface with the ToGL and Glut libraries, is required to compile the program mycgr_tetra_draw.x which makes it possible to draw the CGR in the tetrahedron. If it is not available, this program will not be compiled.

Various computations on the quantiles, used in the tests of structure, require the installation of Scilab or Octave. The environment variable MYCGR_EXTERNAL_MATH_TOOL can be used to specify which tool to use, between "scilab" and "octave". By default, Scilab is used.

Download

Source code is available from this page.

Uncompress the archive, for example with the following command:

tar xvfj mycgr-[...].tar.bz2

The directory mycgr-[...]is then created. Change to this directory and continue to section Compilation.

Compilation

The configuration script configurechecks the availability on the system of the required libraries, and print some values. So the first thing to do is to run this script:

./configure [options]
  • the option --with-meta-root=/name/of/a/directory specifies the default directory to store the files following the naming conventions.
  • the option --prefix=/name/of/another/directory specifies where to install the compiled software.

Check that the configuration ends without error. Then launch the compilation:

make all gui ocamldoc

The programs are the files with the .x extension. The reference documentation of the OCaml library is built in the directory ocamldoc/. Then launch the installation with the following command:

make install

Beware that, depending on the directory chosen for the installation, you may not have sufficient access rights to install the file. You may need to become root or contact your system administrator.

The list of directories created and the files installed is displayed progressively.

Possible configuration of the database

A MySQL database can be used to store some intermediate results and statistics on CGR-trees.

The default used database name is mycgr. If this database must be used, you have to create it and give access rights to the concerned users. To do so, connect to the MySQL database as administrator (root) and launch the following commands, which create the database and give access rights to username from machine localhost:

create database mycgr;
grant all privileges on mycgr.* to username@localhost;

Please consult the MySQL documentation for more details.

What next ?
To start to use MyCGR, you may have a look at an overview of the available tools then read the page about first steps.