This section describes the installation process of Milena. Do not forget that Milena is a library, not a program. Therefore, no program will be installed.
Milena’s examples and tests are compiled on the following platforms:
We guaranty that Milena compiles on these platforms, e.g. Linux and Unix platforms. It may compiles on other platforms though but we have not tested. If you did, and you succeeded, please let us know in order to update this section.
Milena is known NOT to work with GCC-2.95.
Milena is actively developed under Unix systems. As a result, the build system is based on the Autotools. Autotools make sure that every dependencies are resolved before compiling or installing a program.
Milena is different from usual libraries in a way that nothing needs to be compiled to use it. The library itself is composed of headers which must be included when you need them. Then, your application will be compiled with the parts of the library used in that program. That’s all.
So, why do we have a build system? It is useful for installing the library on your system, generating the doc and compiling the test suite and the examples.
If you got the sources from a package/tarball, you can skip this section. Go to section .
If you downloaded the sources from the SVN repository, you must launch a script before configuring the build directory.
Run the following:
$ cd /my/path/to/olena $ ./bootstrap
Running ’bootstrap’ can take a while. Some files are generated during this process. When it’s done, you are ready to configure the build directory.
First, make sure you are at the root directory of the milena source:
$ cd /my/path/to/olena
First, create and enter a build directory:
$ mkdir build $ cd build
We are now about to configure the build directory. This process will create the necessary files to compile documentation, examples and tools and prepare the installation.
Note that once the configuration ends the build directory cannot be moved elsewhere without following the following steps again.
Important Note: the installation path prefix must be chosen at this step. By default, Milena will be installed in /usr/local but you may like to install it elsewhere. To do so, pass the option --prefix=/installation/path/prefix to the configure script (see below). Replace ’/installation/path/prefix’ with the wanted installation path prefix.
now, you can run:
$ ../configure
OR
$ ../configure --prefix=/installation/path/prefix
The configure script will perform various tests. If there is no dependency issues, the last lines shown before the prompt are:
config.status: creating config.h config.status: executing depfiles commands $
And if you type the following command, a ’0’ is printed out.
$ echo $? 0 $
The build directory is now configured, the library can be installed.
First, be sure to be in the build directory. If you followed the previous steps, the build directory should be in the Milena sources root directory.
$ cd /my/path/to/olena/build
If you did not change the default install path prefix, set to /usr/local, you will need to have administrator privileges to perform the installation. Then, you may type:
$ sudo make install
You will be prompted for the administrator password.
Otherwise, if you set the install path prefix to a directory own by your user, simply type:
$ make install
When the installation is finished, you are done. Milena is installed on your system. But maybe you would like to build the examples? This is described in section .
A description of the installation content is also available in section .
The library itself does not need to be compiled, therefore installing Milena does not require compilation.
Though, some examples and tools are provided with the library and must be compiled if you want to use them.
Examples are part of the documentation. The sources are located in milena/doc/examples.
To compile the examples simply run:
$ cd /my/path/to/olena/build/milena/doc/examples $ make
These examples can produce outputs and images. May be you would like to run all the examples and take a look at the outputs? To do so, run:
$ cd /my/path/to/olena/build/milena/doc/examples $ make examples
Text and image outputs will be respectively stored in build/milena/doc/outputs and build/milena/doc/figures.
Few tools are provided with Milena. They can be considered as full program examples.
Currently two tools are available:
| area_flooding.cc | |
| seed2tiling.cc | |
To build these tools, run:
$ cd /my/path/to/olena/build/milena/tools $ make
The test suite used for Milena’s development is shipped with the library. It is usually useless for simple users and tends to be used by developers extending the library.
In order to build and run it, just do the following:
$ cd /my/path/to/olena/build/milena/tests $ make check
Running the test suite is memory and CPU consuming and will take a while.
Once installed, Milena’s files are located in the installed path prefix you passed to the configure script or in the default path /usr/local.
In the installation path prefix, Milena’s files are located in:
1.5.6