Compiling from Source

In order to compile TexGen and all of its modules, the following software is required:

The following programs are needed to build TexGen:

• CMake
• SWIG

The following libraries are needed to link to TexGen:

• VTK
• wxWidgets
• OpenCascade
• Python

However to perform a minimum build of TexGen with none of the additional modules you only require CMake and a C++ compiler. It is recommended to begin with a minimum build, once that is working try adding modules one at a time. A list of modules along with dependencies is shown below:

• Python interface: Python, SWIG
• Renderer: VTK
• Export: OpenCascade
• GUI: wxWidgets, Renderer, Python interface
• Unit tests: CPPUnit

A graphical representation of the modules and their dependencies can also be found in the TexGen API.

If you want to get the source code from the Subversion repository you will need to install Subversion by following the instructions below. Note that this is the very latest development source and so may it contain some bugs and unfinished features. However it is very easy to keep up to date with the latest version of TexGen using this method and will allow you to keep any modifications you have made to the source when updating. If you find a bug or implement new features that may be usefull to the rest of the community they can also be submited as patch and incorporated into TexGen following review.

Alternatively the stable source code can be downloaded as a tarball. Download the latest file release named texgen-3.x.x.tar.gz.

Windows compile

Microsoft Visual Studio C++

Todo...

Unix compile

Notes

If you are installing to a system where you don't have root access (i.e. this computer does not belong to you) you won't be able to install the software using the default configure script. This is because by default software is installed to the /usr/local directory. If you are not a systems administrator then you will quite rightly not have write access to this folder. All is not lost! You can still install software into your home directory. In order to do this you should always call the configure script with the following parameter: --prefix=$HOME. This goes for all the software to be installed below. All executables will then be placed in ~/bin, libraries in ~/lib, includes in ~/include, etc...

In the guide below the parameter is included in italic. If you do in fact have root access then it is recommended to omit this parameter and install to the default directory so that other users will also have access to the software.

Get TexGen from Subversion repository

Install Subversion

Download Subversion and unpack. Open a shell in extracted folder and type:

./configure --with-ssl --prefix=$HOME
make
make install

Notes:

• You will need to install Subversion with SSL support since TexGen is hosted on sourceforge which uses SSL. If you don't configure with the --with-ssl flag you will get an error when trying to checkout TexGen in the next step.
• If you have trouble installing the latest version of Subversion, try installing version 1.3 as it does not require a seperate dependencies package.

Checkout

Open a shell in folder you wish to place TexGen (e.g. ~/):

svn checkout https://texgen.svn.sourceforge.net/svnroot/texgen/TexGen/trunk/ TexGen

Notes:

• The first parameter tells SVN to get the files for the first time
• The second parameter is the location of the TexGen svn repository
• The final parameter is the subfolder to put the files in

Update

The checkout command only needs to performed once. SVN keeps track of where the code was originally obtained and can update to the latest version without having to re-specify the location. In order to do that open a shell in the folder where TexGen was originally checkout (e.g. ~/TexGen) and type:

svn update

or if you are in a hurry you can type the shorter version:

svn up

Compile source

Install CMake

Download CMake and unpack. Open a shell in extracted folder and type:

./configure --prefix=$HOME
make
make install

Compile TexGen core

Open a shell in the folder with the TexGen source code (e.g. ~/TexGen):

mkdir bin
cd bin
ccmake ../

Press 'c' to configure. When a warning pops up telling you it can't find such and such a file press 'e' to close it. You will now need to specify which components of TexGen to build and where their dependencies can be found. Use the up and down arrows to move the caret and press enter to modify options. Do this to set BUILD_GUI, BUILD_PYTHON_INTERFACE and BUILD_RENDERER to OFF. You are basically telling CMake not to attempt to build these components, which means that you won't need to have installed their dependencies.

Similarly to the --prefix=$HOME parameter to the configure script, you can tell CMake to install TexGen to your home directory by changing CMAKE_INSTALL_PREFIX to ~/. Note that it won't actually install anything until you get type make install.

Now press 'c' again to update the changes.

Hopefully now that all the additional modules have been switched off no errors will be shown. Press 'g' to generate the makefiles and exit. At the shell type:

make
make install

Note that at this point you have only built and installed the TexGen Core library which doesn't actually do anything on its own. If you plan to incorporate TexGen into your own C++ program then this is enough, however if you would like to interface with TexGen from a Python script or Graphical User Interface then follow the steps below.

Compiling optional modules

Python interface

Download Python and unpack. Open a shell in the extracted folder and type:

./configure --prefix=$HOME
make
make install

Download SWIG and unpack. Open a shell in the extracted folder and type:

./configure --prefix=$HOME
make
make install

Open a shell in the folder where you called ccmake from for the first time (e.g. ~/TexGen/bin):

ccmake ../

Use the up and down arrows to reach BUILD_PYTHON_INTERFACE and press Enter to set it to ON. Then press 'c' to configure. You will probably get a warning saying you need to specify the location of SWIG and/or Python, press 'e' to close it.

Set the PYTHON_INCLUDE_PATH, PYTHON_LIBRARY, PYTHON_SITEPACKAGES_DIR, SWIG_DIR and SWIG_EXECUTABLE parameters correctly where necessary. If you have installed packages to your home directory then they should look something like this:

PYTHON_INCLUDE_PATH: ~/include/python2.5 PYTHON_LIBRARY: ~/ PYTHON_SITEPACKAGES_DIR: ~/lib/python2.5/site-packages SWIG_DIR: ~/bin SWIG_EXECUTABLE: ~/bin/swig

Once that is done press 'c' again. You may need perform this process over several iterations. When everything is set correctly press 'g' to generate the makefiles. You may receive this warning: "Warning: Ignoring path found in link libraries for target: _Core, path is: /home/username. Expected a library name or a full path to a library name." This warning may be safely ignored.

At the shell type:

make
make install

Assuming the build completed without errors you should now be able to access TexGen functions from within Python. In order to check everything worked as planned open Python in interactive mode by typing:

Python

Then from within Python type:

from TexGen.Core import *
CTexGen.GetInstance().GetVersion()

This should display the version of TexGen installed.