TexGen - User contributions [en]

Compiling from Source

2007-09-28T15:01:18Z

Wr: /* Install TexGen 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:
* [http://www.cmake.org/ CMake]
* [http://www.swig.org/ SWIG]

The following libraries are needed to link to TexGen:
* [http://www.vtk.org/ VTK]
* [http://www.wxwidgets.org/ wxWidgets]
* [http://www.opencascade.org/ OpenCascade]
* [http://www.python.org/ 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 [http://texgen.sourceforge.net/api/ TexGen API].

If you want to get the source code from the Subversion repository you will need to install [http://subversion.tigris.org/ 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 [http://sourceforge.net/project/showfiles.php?group_id=181000 tarball]. Download the latest file release named ''texgen-3.x.x.tar.gz''.

== Windows compile ==
=== Microsoft Visual Studio C++ ===
Todo...

=== Cygwin and gcc ===
A limited build (without graphics) can be made under cygwin, this is a UNIX emulation environment available at [http://www.cygwin.com www.cygwin.com].
This can exist peacefully next to the native windows version.
Cygwin creates a unix-style file system within your windows installation. If you choose c:/cygwin as your install directory, your HOME will be at c:/cygwin/home/<username>/.

==== Download cygwin and install packages ====
Install gcc, g++, wget, make and cmake using the setup.exe program from the cygwin website.
For the mesh generator and python interface to work we currently need VTK and swig.

This downloads and installs swig from source (when starting the cygwin shell you can paste this into the command line, otherwise write it to a file and run it with sh).
mkdir progs
cd progs
SWIG=swig-1.3.31
wget -nc http://kent.dl.sourceforge.net/sourceforge/swig/$SWIG.tar.gz
tar xzvf $SWIG.tar.gz
cd $SWIG
./configure
make
make install

This downloads and installs VTK from source, in the ccmake stage, use the cmake graphical commands to get a working install.
VTK=vtk-5.0.3
wget -nc http://www.vtk.org/files/release/5.0/$VTK.tar.gz
tar xzvf $VTK.tar.gz
mkdir vtkbin
cd vtkbin
ccmake ../VTK
make
make install

==== Install TexGen from source ====
Now we can proceed to install texgen, as an example we'll work in ~/temp/texgen
cd ~; mkdir temp; cd temp; mkdir texgen; cd texgen
svn checkout https://texgen.svn.sourceforge.net/svnroot/texgen/TexGen/trunk/ TexGen
cd .. ; mkdir tbin; cd tbin
ccmake ../texgen
make
make install

This should result in a working texgen install in ~/temp/texgen/tbin.

== 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 ====
[http://subversion.tigris.org/servlets/ProjectDocumentList?collapseFolder=260&folderID=260 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 ====

[http://www.cmake.org/HTML/Download.html 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 ====
[http://www.python.org/download/ Download Python] and unpack.
Open a shell in the extracted folder and type:
./configure ''--prefix=$HOME''
make
make install

[http://www.swig.org/download.html 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: ~/lib/python2.5/config/libpython2.5.a
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.

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.

=== Troubleshooting ===

'''Q:''' I get the following error when linking _Core.so:
libpython2.5.a(abstract.o): relocation R_X86_64_32 against `a local symbol'
can not be used when making a shared object; recompile with -fPIC

'''A:''' Try removing libpython2.5.a from the libraries to link to by setting PYTHON_LIBRARY to a bogus path, e.g.:

PYTHON_LIBRARY: ~/

By doing so you may receive a warning similar to this:
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 ignored.

Compiling from Source

2007-09-28T14:56:02Z

Wr: /* Download cygwin and install packages */

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

The following programs are needed to build TexGen:
* [http://www.cmake.org/ CMake]
* [http://www.swig.org/ SWIG]

The following libraries are needed to link to TexGen:
* [http://www.vtk.org/ VTK]
* [http://www.wxwidgets.org/ wxWidgets]
* [http://www.opencascade.org/ OpenCascade]
* [http://www.python.org/ 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 [http://texgen.sourceforge.net/api/ TexGen API].

If you want to get the source code from the Subversion repository you will need to install [http://subversion.tigris.org/ 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 [http://sourceforge.net/project/showfiles.php?group_id=181000 tarball]. Download the latest file release named ''texgen-3.x.x.tar.gz''.

== Windows compile ==
=== Microsoft Visual Studio C++ ===
Todo...

=== Cygwin and gcc ===
A limited build (without graphics) can be made under cygwin, this is a UNIX emulation environment available at [http://www.cygwin.com www.cygwin.com].
This can exist peacefully next to the native windows version.
Cygwin creates a unix-style file system within your windows installation. If you choose c:/cygwin as your install directory, your HOME will be at c:/cygwin/home/<username>/.

==== Download cygwin and install packages ====
Install gcc, g++, wget, make and cmake using the setup.exe program from the cygwin website.
For the mesh generator and python interface to work we currently need VTK and swig.

This downloads and installs swig from source (when starting the cygwin shell you can paste this into the command line, otherwise write it to a file and run it with sh).
mkdir progs
cd progs
SWIG=swig-1.3.31
wget -nc http://kent.dl.sourceforge.net/sourceforge/swig/$SWIG.tar.gz
tar xzvf $SWIG.tar.gz
cd $SWIG
./configure
make
make install

This downloads and installs VTK from source, in the ccmake stage, use the cmake graphical commands to get a working install.
VTK=vtk-5.0.3
wget -nc http://www.vtk.org/files/release/5.0/$VTK.tar.gz
tar xzvf $VTK.tar.gz
mkdir vtkbin
cd vtkbin
ccmake ../VTK
make
make install

==== Install TexGen from source ====
Now we can proceed to install texgen, as an example we'll work in ~/temp/texgen
cd ~; mkdir temp; cd temp; mkdir texgen; cd texgen
svn checkout https://texgen.svn.sourceforge.net/svnroot/texgen/TexGen/trunk/ TexGen
mkdir tbin
cd tbin
ccmake ../texgen
make
make install

This should result in a working texgen install in ~/temp/texgen/tbin.

== 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 ====
[http://subversion.tigris.org/servlets/ProjectDocumentList?collapseFolder=260&folderID=260 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 ====

[http://www.cmake.org/HTML/Download.html 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 ====
[http://www.python.org/download/ Download Python] and unpack.
Open a shell in the extracted folder and type:
./configure ''--prefix=$HOME''
make
make install

[http://www.swig.org/download.html 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: ~/lib/python2.5/config/libpython2.5.a
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.

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.

=== Troubleshooting ===

'''Q:''' I get the following error when linking _Core.so:
libpython2.5.a(abstract.o): relocation R_X86_64_32 against `a local symbol'
can not be used when making a shared object; recompile with -fPIC

'''A:''' Try removing libpython2.5.a from the libraries to link to by setting PYTHON_LIBRARY to a bogus path, e.g.:

PYTHON_LIBRARY: ~/

By doing so you may receive a warning similar to this:
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 ignored.

Compiling from Source

2007-09-28T14:48:42Z

Wr: /* Cygwin and gcc */

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

The following programs are needed to build TexGen:
* [http://www.cmake.org/ CMake]
* [http://www.swig.org/ SWIG]

The following libraries are needed to link to TexGen:
* [http://www.vtk.org/ VTK]
* [http://www.wxwidgets.org/ wxWidgets]
* [http://www.opencascade.org/ OpenCascade]
* [http://www.python.org/ 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 [http://texgen.sourceforge.net/api/ TexGen API].

If you want to get the source code from the Subversion repository you will need to install [http://subversion.tigris.org/ 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 [http://sourceforge.net/project/showfiles.php?group_id=181000 tarball]. Download the latest file release named ''texgen-3.x.x.tar.gz''.

== Windows compile ==
=== Microsoft Visual Studio C++ ===
Todo...

=== Cygwin and gcc ===
A limited build (without graphics) can be made under cygwin, this is a UNIX emulation environment available at [http://www.cygwin.com www.cygwin.com].
This can exist peacefully next to the native windows version.
Cygwin creates a unix-style file system within your windows installation. If you choose c:/cygwin as your install directory, your HOME will be at c:/cygwin/home/<username>/.

== Download cygwin and install packages ==
Install gcc, g++, wget, make and cmake using the setup.exe program from the cygwin website.
For the mesh generator and python interface to work we currently need VTK and swig.

This downloads and installs swig from source (when starting the cygwin shell you can paste this into the command line, otherwise write it to a file and run it with sh).
mkdir progs
cd progs
SWIG=swig-1.3.31
wget -nc http://kent.dl.sourceforge.net/sourceforge/swig/$SWIG.tar.gz
tar xzvf $SWIG.tar.gz
cd $SWIG
./configure
make
make install

This downloads and installs VTK from source, in the ccmake stage, use the cmake graphical commands to get a working install.
VTK=vtk-5.0.3
wget -nc http://www.vtk.org/files/release/5.0/$VTK.tar.gz
tar xzvf $VTK.tar.gz
mkdir vtkbin
cd vtkbin
ccmake ../VTK
make
make install

Now we can proceed to install texgen, as an example we'll work in ~/temp/texgen
cd ~; mkdir temp; cd temp; mkdir texgen; cd texgen
svn checkout https://texgen.svn.sourceforge.net/svnroot/texgen/TexGen/trunk/ TexGen
mkdir tbin
cd tbin
ccmake ../texgen
make
make install

This should result in a working texgen install in ~/temp/texgen/tbin.

== 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 ====
[http://subversion.tigris.org/servlets/ProjectDocumentList?collapseFolder=260&folderID=260 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 ====

[http://www.cmake.org/HTML/Download.html 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 ====
[http://www.python.org/download/ Download Python] and unpack.
Open a shell in the extracted folder and type:
./configure ''--prefix=$HOME''
make
make install

[http://www.swig.org/download.html 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: ~/lib/python2.5/config/libpython2.5.a
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.

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.

=== Troubleshooting ===

'''Q:''' I get the following error when linking _Core.so:
libpython2.5.a(abstract.o): relocation R_X86_64_32 against `a local symbol'
can not be used when making a shared object; recompile with -fPIC

'''A:''' Try removing libpython2.5.a from the libraries to link to by setting PYTHON_LIBRARY to a bogus path, e.g.:

PYTHON_LIBRARY: ~/

By doing so you may receive a warning similar to this:
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 ignored.

Compiling from Source

2007-09-28T13:53:31Z

Wr: /* Microsoft Visual Studio C++ */

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

The following programs are needed to build TexGen:
* [http://www.cmake.org/ CMake]
* [http://www.swig.org/ SWIG]

The following libraries are needed to link to TexGen:
* [http://www.vtk.org/ VTK]
* [http://www.wxwidgets.org/ wxWidgets]
* [http://www.opencascade.org/ OpenCascade]
* [http://www.python.org/ 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 [http://texgen.sourceforge.net/api/ TexGen API].

If you want to get the source code from the Subversion repository you will need to install [http://subversion.tigris.org/ 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 [http://sourceforge.net/project/showfiles.php?group_id=181000 tarball]. Download the latest file release named ''texgen-3.x.x.tar.gz''.

== Windows compile ==
=== Microsoft Visual Studio C++ ===
Todo...

=== Cygwin and gcc ===
A limited build (without graphics) can be made under cygwin, this is a UNIX emulation environment available at [http://www.cygwin.com www.cygwin.com].
This can exist peacefully next to the native windows version.
Cygwin creates a unix-style file system within your windows installation. If you choose c:/cygwin as your install directory, your HOME will be at c:/cygwin/home/<username>/.

Further instructions presume you operate from the cygwin shell.

Use svn as described on [http://sourceforge.net/svn/?group_id=181000 texgen svn instructions].
Checkout the full source in a directory within

== 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 ====
[http://subversion.tigris.org/servlets/ProjectDocumentList?collapseFolder=260&folderID=260 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 ====

[http://www.cmake.org/HTML/Download.html 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 ====
[http://www.python.org/download/ Download Python] and unpack.
Open a shell in the extracted folder and type:
./configure ''--prefix=$HOME''
make
make install

[http://www.swig.org/download.html 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: ~/lib/python2.5/config/libpython2.5.a
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.

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.

=== Troubleshooting ===

'''Q:''' I get the following error when linking _Core.so:
libpython2.5.a(abstract.o): relocation R_X86_64_32 against `a local symbol'
can not be used when making a shared object; recompile with -fPIC

'''A:''' Try removing libpython2.5.a from the libraries to link to by setting PYTHON_LIBRARY to a bogus path, e.g.:

PYTHON_LIBRARY: ~/

By doing so you may receive a warning similar to this:
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 ignored.

Talk:Compiling from Source

2007-01-04T10:02:13Z

Wr:

Just a quick note on the installation of OpenCASCADE on debian linux amd64, I
didn't find it entirely trivial, so here it goes:

Apt install the following packages, more may be needed, but this was what
I needed on top of what I had:

apt-get install sun-java5-jdk
apt-get install g++-3.4
apt-get install libstlport5-dev

install in whatever directory you find suitable, I install things in
$HOME/progs.

get OpenCASCADE_Linux.tgz from the download section.

in $HOME/progs
mkdir OpenCASCADE
mv OpenCASCADE_Linux.tgz OpenCASCADE
cd OpenCASCADE
tar xzvf OpenCASCADE_Linux.tgz
cd Linux
java -cp setup.jar run

in $HOME/progs/OpenCASCADE/Linux/ros/run_all.sh (if that is where you
installshielded the thing to) write the following (adjust options to what you
need/want/have, but make sure that you don't use gcc-4x):
csh env.csh
export CC=gcc-3.4
export CXX=g++-3.4
export JAVAHOME=/usr/lib/jvm/java-1.5.0-sun-1.5.0.10
export CASROOT=$HOME/progs/OpenCASCADE/Linux/ros
./configure --with-java-include=$JAVAHOME/include \
--with-gl-include=/usr/include/ --with-gl-library=/usr/lib/ --with-x \
--with-pic --with-xmu-include=/usr/include/X11/ \
--with-xmu-library=/usr/lib/ \
--with-stlport-include=/usr/include/c++/3.4/ \
--with-stlport-libname=stlport \
--with-stlport-library=/usr/lib/ \
--enable-debug
make

open "configure" and edit from line 14772 so that the following lines read:
if test "X$enable_debug" = "Xyes"; then
CFLAGS="$CFLAGS -g -DDEB -D_DEBUG -DCSFDB"
CXXFLAGS="$CXXFLAGS -g -DDEB -D_DEBUG -DCSFDB"
else
CFLAGS="$CFLAGS -DNDEBUG -DNo_Exception -DCSFDB "
CXXFLAGS="$CXXFLAGS -DNDEBUG -DNo_Exception -DCSFDB "
fi

and change the lines in "configure" to set the following entries
TCL_INCLUDE_FLAG="-I/usr/include/tcl8.4/"
TK_INCLUDE_FLAG="-I/usr/include/tcl8.4/"

then, on the command line:
chmod +x configure
chmod +x run_all.sh
./run_all.sh

And then wait and wait and wait and wait....

I don't know how (sub)optimal such an install is, I'll try to provide updates as
I get them.

Cheers
W

Talk:Compiling from Source

2007-01-03T17:11:38Z

Wr:

Just a quick note on the installation of OpenCASCADE on debian linux amd64, I
didn't find it entirely trivial, so here it goes:

Apt install the following packages, more may be needed, but this was what
I needed on top of what I had:

apt-get install sun-java5-jdk
apt-get install g++-3.4
apt-get install libstlport5-dev

install in whatever directory you find suitable, I install things in
$HOME/progs.

get OpenCASCADE_Linux.tgz from the download section.

in $HOME/progs
mkdir OpenCASCADE
mv OpenCASCADE_Linux.tgz OpenCASCADE
cd OpenCASCADE
tar xzvf OpenCASCADE_Linux.tgz
cd Linux
java -cp setup.jar run

in $HOME/progs/OpenCASCADE/Linux/ros/run_all.sh (if that is where you
installshielded the thing to) write the following (adjust options to what you
need/want/have, but make sure that you don't use gcc-4x):
csh env.csh
export CC=gcc-3.4
export CXX=g++-3.4
export JAVAHOME=/usr/lib/jvm/java-1.5.0-sun-1.5.0.10
export CASROOT=$HOME/progs/OpenCASCADE/Linux/ros
./configure --with-java-include=$JAVAHOME/include \
--with-gl-include=/usr/include/ --with-gl-library=/usr/lib/ --with-x \
--with-pic --with-xmu-include=/usr/include/X11/ \
--with-xmu-library=/usr/lib/ \
--with-stlport-include=/usr/include/c++/3.4/ \
--with-stlport-libname=stlport \
--with-stlport-library=/usr/lib/ \
--enable-debug
make

open "configure" and edit from line 14772 so that the following lines read:
if test "X$enable_debug" = "Xyes"; then
CFLAGS="$CFLAGS -g -DDEB -D_DEBUG -DCSFDB"
CXXFLAGS="$CXXFLAGS -g -DDEB -D_DEBUG -DCSFDB"
else
CFLAGS="$CFLAGS -DNDEBUG -DNo_Exception -DCSFDB "
CXXFLAGS="$CXXFLAGS -DNDEBUG -DNo_Exception -DCSFDB "
fi

then, on the command line:
chmod +x configure
chmod +x run_all.sh
./run_all.sh

And then wait and wait and wait and wait....

I don't know how (sub)optimal such an install is, I'll try to provide updates as
I get them.

Cheers
W

Talk:Compiling from Source

2007-01-03T17:04:00Z

Wr:

Just a quick note on the installation of OpenCASCADE on debian linux amd64, I
didn't find it entirely trivial, so here it goes:

Apt install the following packages, more may be needed, but this was what
I needed on top of what I had:

apt-get install sun-java5-jdk
apt-get install g++-3.4
apt-get install libstlport5-dev

install in whatever directory you find suitable, I install things in
$HOME/progs.

get OpenCASCADE_Linux.tgz from the download section.

in $HOME/progs
mkdir OpenCASCADE
mv OpenCASCADE_Linux.tgz OpenCASCADE
cd OpenCASCADE
tar xzvf OpenCASCADE_Linux.tgz
cd Linux
java -cp setup.jar run

in $HOME/progs/OpenCASCADE/Linux/ros/run_all.sh (if that is where you
installshielded the thing to) write the following (adjust options to what you
need/want/have, but make sure that you don't use gcc-4x):
csh env.csh
export CC=gcc-3.4
export CXX=g++-3.4
export JAVAHOME=/usr/lib/jvm/java-1.5.0-sun-1.5.0.10
export CASROOT=/home/wout/progs/OpenCASCADE/Linux/ros
./configure --with-java-include=$JAVAHOME/include \
--with-gl-include=/usr/include/ --with-gl-library=/usr/lib/ --with-x \
--with-pic --with-xmu-include=/usr/include/X11/ \
--with-xmu-library=/usr/lib/ \
--with-stlport-include=/usr/include/c++/3.4/ \
--with-stlport-libname=stlport \
--with-stlport-library=/usr/lib/ \
--enable-debug
make

open "configure" and edit from line 14772 so that the following lines read:
if test "X$enable_debug" = "Xyes"; then
CFLAGS="$CFLAGS -g -DDEB -D_DEBUG -DCSFDB"
CXXFLAGS="$CXXFLAGS -g -DDEB -D_DEBUG -DCSFDB"
else
CFLAGS="$CFLAGS -DNDEBUG -DNo_Exception -DCSFDB "
CXXFLAGS="$CXXFLAGS -DNDEBUG -DNo_Exception -DCSFDB "
fi

then, on the command line:
chmod +x configure
chmod +x run_all.sh
./run_all.sh

And then wait and wait and wait and wait....

I don't know how (sub)optimal such an install is, I'll try to provide updates as
I get them.

Cheers
W

Talk:Compiling from Source

2006-12-29T16:53:56Z

Wr:

Talk:Compiling from Source

2006-12-29T16:06:09Z

Wr:

Just a quick note on the installation of OpenCASCADE on debian linux amd64, I
didn't find it entirely trivial, so here it goes:

Apt install the following packages, more may be needed, but this was what
I needed on top of what I had:

apt-get install sun-java5-jdk
apt-get install g++-3.4
apt-get install libstlport5-dev

install in whatever directory you find suitable, I install things in
$HOME/progs.

get OpenCASCADE_Linux.tgz from the download section.

in $HOME/progs
mkdir OpenCASCADE
mv OpenCASCADE_Linux.tgz OpenCASCADE
cd OpenCASCADE
tar xzvf OpenCASCADE_Linux.tgz
cd Linux
java -cp setup.jar run

in $HOME/progs/OpenCASCADE/Linux/ros/run_all.sh (if that is where you
installshielded the thing to) write the following (adjust options to what you
need/want/have, but make sure that you don't use gcc-4x):
csh env.csh
export CC=gcc-3.4
export CXX=g++-3.4
export JAVAHOME=/usr/lib/jvm/java-1.5.0-sun-1.5.0.10
export CASROOT=$HOME/progs/OpenCASCADE/Linux/ros
./configure --with-java-include=$JAVAHOME/include \
--with-gl-include=/usr/include/ --with-gl-library=/usr/lib/ --with-x \
--with-pic --with-xmu-include=/usr/include/X11/ \
--with-xmu-library=/usr/lib/ \
--with-stlport-include=/usr/include/c++/3.4/ \
--with-stlport-libname=libstlport.so \
--with-stlport-library=/usr/lib/ \
--enable-debug
make

then, on the command line:
chmod +x configure
chmod +x run_all.sh
./run_all.sh

And then wait and wait and wait and wait....

I don't know how (sub)optimal such an install is, I'll try to provide updates as
I get them.

Cheers
W

Talk:Compiling from Source

2006-12-29T16:04:09Z

Wr:

Just a quick note on the installation of OpenCASCADE on debian linux amd64, I
didn't find it entirely trivial, so here it goes:

Apt install the following packages, more may be needed, but this was what
I needed on top of what I had:

apt-get install sun-java5-jdk
apt-get install g++-3.4
apt-get install libstlport5-dev

install in whatever directory you find suitable, I install things in
$HOME/progs.

get OpenCASCADE_Linux.tgz from the download section.

in $HOME/progs
mkdir OpenCASCADE
mv OpenCASCADE_Linux.tgz OpenCASCADE
cd OpenCASCADE
tar xzvf OpenCASCADE_Linux.tgz
cd Linux
java -cp setup.jar run

in $HOME/progs/OpenCASCADE/Linux/ros/run_all.sh (if that is where you
installshielded the thing to) write the following (adjust options to what you
need/want/have, but make sure that you don't use gcc-4x):
csh env.csh
export CC=gcc-3.4
export CXX=g++-3.4
export JAVAHOME=/usr/lib/jvm/java-1.5.0-sun-1.5.0.10
export CASROOT=/home/wout/progs/OpenCASCADE/Linux/ros
./configure --with-java-include=$JAVAHOME/include \
--with-gl-include=/usr/include/ --with-gl-library=/usr/lib/ --with-x \
--with-pic --with-xmu-include=/usr/include/X11/ \
--with-xmu-library=/usr/lib/ \
--with-stlport-include=/usr/include/c++/3.4/ \
--with-stlport-libname=libstlport.so \
--with-stlport-library=/usr/lib/ \
--enable-debug
make

then, on the command line:
chmod +x configure
chmod +x run_all.sh
./run_all.sh

And then wait and wait and wait and wait....

I don't know how (sub)optimal such an install is, I'll try to provide updates as
I get them.

Cheers
W

User Guide

2006-12-19T13:39:23Z

Wr: /* Example 1 */

There are several ways to interface with TexGen. A little bit of technical information is necessary to understand how this all fits together. The core TexGen functionality has been written in C++, on top of this a Python interface exists that has access to all the C++ functions of TexGen. There are many advantages of a Python interface that may not be immediatly obvious to the end user.

A user friendly Graphical User Interface has been built on top of the Python interface to provide a quick and easy method to interface with TexGen. But the real power comes with writing small Python scripts which will be discussed later.

==Graphical User Interface==

The GUI is the easiest way to use TexGen, although a lot of TexGen features are not accessible via the graphical user interface. It is a good starting point to explore the capabilites of TexGen, but for the serious user the Python interface is recommended.

===Layout===

The GUI layout is similar to that of ABAQUS CAE for those familiar with it.

The left side of the screen contains the controls to interact with TexGen. These controls are identical to the ones shown in the drop down menu at the top. Use which ever is most convenient.

The right of the screen contains the 3d rendering of the model(s). Several models can be opened at once, all operations apply to the current model in view.

Finally, the bottom of the screen contains an interactive ''Python Console'' along with two log windows. The interactive console allows the user to input Python commands directly. This can be useful for small operations and learning how to use the python scripting interface. For inputting a large number of Python commands it is more convenient to save it in a Python script and execute it all at once.

The ''Python Output'' log window displays all the Python code executed by the GUI. Essentially every button pressed in the user interface will create a Python command. This is done by design, making it possible to record Python scripts while interacting with the GUI. If you know how to do something with the GUI, you then automatically know how to do it with a Python script because the code is displayed.

The ''TexGen Output'' log window displays log and error messages from TexGen. These generally include information on what TexGen is doing, if something goes wrong it is useful to read the log to find out what happened. Error messages will be displayed in red so that they can be easily located.

If new messages are posted one of the log windows while it is inactive, the icon above the window will change. In the case of receiving an error message the icon will change to an error icon.

==Python Interface==
[http://www.python.org/ Python] is a high level interpreted programming language. In this case it is used as a scripting language to allow easy access to TexGen functionality. Python has been embedded in the TexGen GUI which allows the GUI to run python scripts. The goal of this tutorial is not to teach Python programming, there are plenty of resources online for that. A few of them are listed below:

* [http://www.poromenos.org/tutorials/python Learn Python in 10 minutes] - Quick introduction to Python for competent programmers.
* [http://docs.python.org/tut/tut.html Python Tutorial] - Official Python tutorial (requires some programming knowledge).
* [http://www.greenteapress.com/thinkpython/ How to Think Like a Computer Scientist: Learning with Python] - Book on Python programming for beginners. [http://www.greenteapress.com/thinkpython/html/ HTML Version]
* [http://diveintopython.org/ Dive Into Python] - In depth book covering advanced subjects in a comprehensive manner. [http://diveintopython.org/toc/index.html HTML Version]

An advanced knowledge of Python is not needed in order to write simple TexGen scripts. However, bear in mind that Python is a very powerful language with many libraries included for performing common tasks. I suggest you try to follow through the examples below and if you get stuck refer to one of the documents above.

===Example 1===
First of all, a Python script is just a plain ASCII text file with a .py extension. To create one simply open up your favorite text editor. Notepad will do if you have nothing else but I suggest a more powerful freeware text editor like [http://www.pspad.com/ PSPad]. Code that goes into the python script will be displayed like so:

# All Python code will be shown in a box like this one.
# Lines begining with a '#' character are comments

In this example, we will create a simple 2x2 plain weave model with a Python script. Its time to dive in and see some actual Python code. At this point if you are completely lost please refer back to the resources on Python programming. The first step is to create an instance of the <code>CTextileWeave2D</code> class and give it a name, <code>weave</code>:

# Create a 2D weave textile
weave = CTextileWeave2D(2, 2, 1, 0.2, True)

The <code>CTextileWeave2D</code> class takes 5 parameters in the order shown below:
* Number of weft yarns in the unit cell
* Number of warp yarns in the unit cell
* Spacing between the yarns
* Thickness of the fabrics
* Refine model (True/False)

The only parameter that really needs an explanation here is the Refine model option, this controls whether or not the interference correction algorithm will be applied to keep the yarn volumes from intersecting which is a common problem. The interference correction algorithm generally does a good job but is not instantaneous so sometimes it can be beneficial to switch it off.

This is the bare minimum information necessary to create a 2D woven fabric. In the following steps we will add more information to create the model the way we want it.

Let's set the weave pattern, this determines whether a warp or weft yarn will appear on top at a particular cross over. Cross overs are arranged in 2d grid where the size of the grid depends on the number of warp and weft yarns created. To swap the positions of the weft and warp yarns, we call the function <code>SwapPosition</code> with the grid coordinates of the cross over. In order to create a plain weave we need to do this on two diagonally opposite cross overs like so:

# Set the weave pattern
weave.SwapPosition(0, 0)
weave.SwapPosition(1, 1)

Now let's add our <code>weave</code> model to the database of models so that TexGen can render it:

# Add the textile
AddTextile(weave)

Thats it! This is a very simple script but it will generate a plain weave model. To recap your Python script should look like this:

# Create a 2D weave textile
weave = CTextileWeave2D(2, 2, 1, 0.2, True)

# Set the weave pattern
weave.SwapPosition(0, 0)
weave.SwapPosition(1, 1)

# Add the textile
AddTextile(weave)

Save it to disk as ''PlainWeave.py'' or give it whatever name you want as long as it has a ''.py'' extension.

In order to test the Script we need to load it into TexGen. So start up the TexGen GUI and from the ''Python menu'' select ''Run Script''. Select the file you have just saved and click ok. With a bit of luck you should see a 2d plain weave on screen.

Congratulations you have created your first TexGen Python script!

===Example 2===
In the first example we made use of the <code>CTextileWeave2D</code> which is the reason the script is so compact. This was great for creating a 2D Weave, but what if we want to create something other than a 2D Weave? In this example we will create yarns directly rather than through one of the textile sub-classes.

First we will define a general textile and call it <code>Textile</code>:

# Create a textile
Textile = CTextile()

The <code>CTextile</code> class doesn't take any parameters, instead yarns will be created and added to it. Next we will create 4 yarns to go inside our textile, it is convenient to make use of the Python lists to do this. Create a list called <code>Yarns</code> with 4 elements, each one an instance of the class <code>CYarn</code>:

# Create a python list containing 4 yarns
Yarns = [CYarn(), CYarn(), CYarn(), CYarn()]

<code>Yarns</code> now contains 4 empty yarns. Note that the yarns are not currently associated with the Textile, first we must fill in the details then make them a part of the textile. The first thing to do is define their paths with nodes. This is done like so:

# Add nodes to the yarns to describe their paths
Yarns[0].AddNode(CNode(XYZ(0, 0, 0)))
Yarns[0].AddNode(CNode(XYZ(0.22, 0, 0.05)))
Yarns[0].AddNode(CNode(XYZ(0.44, 0, 0)))

Yarns[1].AddNode(CNode(XYZ(0, 0.22, 0.05)))
Yarns[1].AddNode(CNode(XYZ(0.22, 0.22, 0)))
Yarns[1].AddNode(CNode(XYZ(0.44, 0.22, 0.05)))

Yarns[2].AddNode(CNode(XYZ(0, 0, 0.05)))
Yarns[2].AddNode(CNode(XYZ(0, 0.22, 0)))
Yarns[2].AddNode(CNode(XYZ(0, 0.44, 0.05)))

Yarns[3].AddNode(CNode(XYZ(0.22, 0, 0)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0.22, 0.05)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0.44, 0)))

We have added 3 nodes to each yarn creating a woven pattern. The number in the square brackets after <code>Yarns</code> refers to a particular yarn in the list. The function <code>AddNode</code> is then called for the yarn. The function takes an instance of the class <code>CNode</code> which in turn is constructed with an instance of the class <code>XYZ</code> representing the position of the node. The class <code>XYZ</code> is constructed with 3 numbers representing the X, Y and Z coordinates of the point.

We still need to define a few more things to obtain a model. For the sake of simplicity, we will give all the yarns the same cross sectional shape, width, height, etc... The easiest way to do this is to loop over the yarns and assign the same properties to each yarn one by one. The syntax for looping over <code>Yarns</code> is shown here:

# Loop over all the yarns in the list
for Yarn in Yarns:

Inside the loop, the variable <code>Yarn</code> refers to the current yarn in the list. So within the loop we just assign properties to <code>Yarn</code> and they will be applied to all the yarns in the list. In python the begining and end of a loop are defined by indentation, hence the following lines are indented to represent the contents of the loop.

Let us define periodic cubic spline interpolation between the nodes:

# Set the interpolation function
Yarn.AssignInterpolation(CInterpolationCubic())

This is done with the function <code>AssignInterpolation</code> which takes an instance of a class derived from <code>CInterpolation</code>. In this case we used <code>CInterpolationCubic</code> to specify periodic cubic spline interpolation.

Next we need to define a cross section for the yarn, to keep things simple a constant cross section all along the length of the yarn will be defined:

# Assign a constant cross-section all along the yarn of elliptical shape
Yarn.AssignSection(CYarnSectionConstant(CSectionEllipse(0.18, 0.04)))

The function <code>AssignSection</code> takes an instance of a class derived from <code>CYarnSection</code>. In this case we used <code>CYarnSectionConstant</code> which in turns take an instance of a class derived from <code>CSection</code> as a constructor. <code>CSectionEllipse</code> defines an elliptical cross section with given width and height defined by the first and second parameters respectively.

# Set the resolution of the surface mesh created
Yarn.SetResolution(20)

This line sets the resolution of the surface mesh created. The first parameter to the function <code>SetResolution</code> represents the number of points around a cross section. The number of points along the length of the yarns is automatically calculated such that the distance between points is similar to around the cross section.

Next we must add repeat vectors to define how the yarns are repeated.

# Add repeat vectors to the yarn
Yarn.AddRepeat(XYZ(0.44, 0, 0))
Yarn.AddRepeat(XYZ(0, 0.44, 0))

The function <code>AddRepeat</code> takes an instance of the class <code>XYZ</code>. As we saw earlier the class <code>XYZ</code> is constructed with 3 numbers defining the X, Y and Z components.

Finally the yarn is fully defined, it can now be added to <code>Textile</code>:

# Add the yarn to our textile
Textile.AddYarn(Yarn)

This is the end of the loop, hence the following lines return to the original indentation. Now let's define a Domain within which the textile will be placed:

Textile.AssignDomain(CDomainPlanes(XYZ(0, 0, -0.02), XYZ(0.44, 0.44, 0.07)))

The function <code>AssignDomain</code> takes an instance of a class derived from <code>CDomain</code>. In this case we will create a box shaped domain, this can be accomplished by using the class <code>CDomainPlanes</code>. A box can be created by passing in opposite corners of the box (the minimum and maximum coordinates). This is done again with the class <code>XYZ</code>.

And finally <code>Textile</code> must be added to so that it can be rendered. Each Textile added must be assigned a name to identify it, this is the name that will appear at the top in the TexGen GUI. This name can either be generated automatically or we can specify it explicitly like so:

# Add the textile with the name "polyester"
AddTextile("polyester", Textile)

That's it! You now have the knowledge to create any type of fabric imaginable. Well, almost. The model created here is pretty simple, there is plenty of oppertunity to create more complex shapes. For example non-constant cross sections can be defined, complex domain shapes defined by arbritrary planes, different interpolation functions.

Here is the completed script:

# Create a textile
Textile = CTextile()

# Create a python list containing 4 yarns
Yarns = [CYarn(), CYarn(), CYarn(), CYarn()]

# Add nodes to the yarns to describe their paths
Yarns[0].AddNode(CNode(XYZ(0, 0, 0)))
Yarns[0].AddNode(CNode(XYZ(0.22, 0, 0.05)))
Yarns[0].AddNode(CNode(XYZ(0.44, 0, 0)))

Yarns[1].AddNode(CNode(XYZ(0, 0.22, 0.05)))
Yarns[1].AddNode(CNode(XYZ(0.22, 0.22, 0)))
Yarns[1].AddNode(CNode(XYZ(0.44, 0.22, 0.05)))

Yarns[2].AddNode(CNode(XYZ(0, 0, 0.05)))
Yarns[2].AddNode(CNode(XYZ(0, 0.22, 0)))
Yarns[2].AddNode(CNode(XYZ(0, 0.44, 0.05)))

Yarns[3].AddNode(CNode(XYZ(0.22, 0, 0)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0.22, 0.05)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0.44, 0)))

# Loop over all the yarns in the list
for Yarn in Yarns:

# Set the interpolation function
Yarn.AssignInterpolation(CInterpolationCubic())

# Assign a constant cross-section all along the yarn of elliptical shape
Yarn.AssignSection(CYarnSectionConstant(CSectionEllipse(0.18, 0.04)))

# Set the resolution of the surface mesh created
Yarn.SetResolution(20)

# Add repeat vectors to the yarn
Yarn.AddRepeat(XYZ(0.44, 0, 0))
Yarn.AddRepeat(XYZ(0, 0.44, 0))

# Add the yarn to our textile
Textile.AddYarn(Yarn)

# Create a domain and assign it to the textile
Textile.AssignDomain(CDomainPlanes(XYZ(0, 0, -0.02), XYZ(0.44, 0.44, 0.07)))

# Add the textile with the name "polyester"
AddTextile("polyester", Textile)

User Guide

2006-12-19T13:30:20Z

Wr: /* Layout */

There are several ways to interface with TexGen. A little bit of technical information is necessary to understand how this all fits together. The core TexGen functionality has been written in C++, on top of this a Python interface exists that has access to all the C++ functions of TexGen. There are many advantages of a Python interface that may not be immediatly obvious to the end user.

A user friendly Graphical User Interface has been built on top of the Python interface to provide a quick and easy method to interface with TexGen. But the real power comes with writing small Python scripts which will be discussed later.

==Graphical User Interface==

The GUI is the easiest way to use TexGen, although a lot of TexGen features are not accessible via the graphical user interface. It is a good starting point to explore the capabilites of TexGen, but for the serious user the Python interface is recommended.

===Layout===

The GUI layout is similar to that of ABAQUS CAE for those familiar with it.

The left side of the screen contains the controls to interact with TexGen. These controls are identical to the ones shown in the drop down menu at the top. Use which ever is most convenient.

The right of the screen contains the 3d rendering of the model(s). Several models can be opened at once, all operations apply to the current model in view.

Finally, the bottom of the screen contains an interactive ''Python Console'' along with two log windows. The interactive console allows the user to input Python commands directly. This can be useful for small operations and learning how to use the python scripting interface. For inputting a large number of Python commands it is more convenient to save it in a Python script and execute it all at once.

The ''Python Output'' log window displays all the Python code executed by the GUI. Essentially every button pressed in the user interface will create a Python command. This is done by design, making it possible to record Python scripts while interacting with the GUI. If you know how to do something with the GUI, you then automatically know how to do it with a Python script because the code is displayed.

The ''TexGen Output'' log window displays log and error messages from TexGen. These generally include information on what TexGen is doing, if something goes wrong it is useful to read the log to find out what happened. Error messages will be displayed in red so that they can be easily located.

If new messages are posted one of the log windows while it is inactive, the icon above the window will change. In the case of receiving an error message the icon will change to an error icon.

==Python Interface==
[http://www.python.org/ Python] is a high level interpreted programming language. In this case it is used as a scripting language to allow easy access to TexGen functionality. Python has been embedded in the TexGen GUI which allows the GUI to run python scripts. The goal of this tutorial is not to teach Python programming, there are plenty of resources online for that. A few of them are listed below:

* [http://www.poromenos.org/tutorials/python Learn Python in 10 minutes] - Quick introduction to Python for competent programmers.
* [http://docs.python.org/tut/tut.html Python Tutorial] - Official Python tutorial (requires some programming knowledge).
* [http://www.greenteapress.com/thinkpython/ How to Think Like a Computer Scientist: Learning with Python] - Book on Python programming for beginners. [http://www.greenteapress.com/thinkpython/html/ HTML Version]
* [http://diveintopython.org/ Dive Into Python] - In depth book covering advanced subjects in a comprehensive manner. [http://diveintopython.org/toc/index.html HTML Version]

An advanced knowledge of Python is not needed in order to write simple TexGen scripts. However, bear in mind that Python is a very powerful language with many libraries included for performing common tasks. I suggest you try to follow through the examples below and if you get stuck refer to one of the documents above.

===Example 1===
First of all, a Python script is just a plain ASCII text file with a .py extension. To create one simply open up your favorite text editor. Notepad will do if you have nothing else but I suggest a more powerfull freeware text editor like [http://www.pspad.com/ PSPad]. Code that goes into the python script will be displayed like so:

# All Python code will be shown in a box like this one.
# Lines begining with a '#' character are comments

In this example, we will create a simple 2x2 plain weave model with a Python script. Its time to dive in and see some actual Python code. At this point if you are completely lost please refer back to the resources on Python programming. The first step is to create an instance of the <code>CTextileWeave2D</code> class and give it a name, <code>weave</code>:

# Create a 2D weave textile
weave = CTextileWeave2D(2, 2, 1, 0.2, True)

The <code>CTextileWeave2D</code> class takes 5 parameters in the order shown below:
* Number of weft yarns in the unit cell
* Number of warp yarns in the unit cell
* Spacing between the yarns
* Thickness of the fabrics
* Refine model (True/False)

The only parameter that really needs an explanation here is the Refine model option, this controls whether or not the interference correction algorithm will be applied to keep the yarn volumes from intersecting which is a common problem. The interference correction algorithm generally does a good job but is not instantaneous so sometimes it can be beneficial to switch it off.

This is the bare minimum information necessary to create a 2D woven fabric. In the following steps we will add more information to create the model the way we want it.

Let's set the weave pattern, this determines whether a warp or weft yarn will appear on top at a particular cross over. Cross overs are arranged in 2d grid where the size of the grid depends on the number of warp and weft yarns created. To swap the positions of the weft and warp yarns, we call the function <code>SwapPosition</code> with the grid coordinates of the cross over. In order to create a plain weave we need to do this on two diagonally opposite cross overs like so:

# Set the weave pattern
weave.SwapPosition(0, 0)
weave.SwapPosition(1, 1)

Now let's add our <code>weave</code> model to the database of models so that TexGen can render it:

# Add the textile
AddTextile(weave)

Thats it! This is a very simple script but it will generate a plain weave model. To recap your Python script should look like this:

# Create a 2D weave textile
weave = CTextileWeave2D(2, 2, 1, 0.2, True)

# Set the weave pattern
weave.SwapPosition(0, 0)
weave.SwapPosition(1, 1)

# Add the textile
AddTextile(weave)

Save it to disk as ''PlainWeave.py'' or give it whatever name you want as long as it has a ''.py'' extension.

In order to test the Script we need to load it into TexGen. So start up the TexGen GUI and from the ''Python menu'' select ''Run Script''. Select the file you have just saved and click ok. With a bit of luck you should see a 2d plain weave on screen.

Congratulations you have created your first TexGen Python script!

===Example 2===
In the first example we made use of the <code>CTextileWeave2D</code> which is the reason the script is so compact. This was great for creating a 2D Weave, but what if we want to create something other than a 2D Weave? In this example we will create yarns directly rather than through one of the textile sub-classes.

First we will define a general textile and call it <code>Textile</code>:

# Create a textile
Textile = CTextile()

The <code>CTextile</code> class doesn't take any parameters, instead yarns will be created and added to it. Next we will create 4 yarns to go inside our textile, it is convenient to make use of the Python lists to do this. Create a list called <code>Yarns</code> with 4 elements, each one an instance of the class <code>CYarn</code>:

# Create a python list containing 4 yarns
Yarns = [CYarn(), CYarn(), CYarn(), CYarn()]

<code>Yarns</code> now contains 4 empty yarns. Note that the yarns are not currently associated with the Textile, first we must fill in the details then make them a part of the textile. The first thing to do is define their paths with nodes. This is done like so:

# Add nodes to the yarns to describe their paths
Yarns[0].AddNode(CNode(XYZ(0, 0, 0)))
Yarns[0].AddNode(CNode(XYZ(0.22, 0, 0.05)))
Yarns[0].AddNode(CNode(XYZ(0.44, 0, 0)))

Yarns[1].AddNode(CNode(XYZ(0, 0.22, 0.05)))
Yarns[1].AddNode(CNode(XYZ(0.22, 0.22, 0)))
Yarns[1].AddNode(CNode(XYZ(0.44, 0.22, 0.05)))

Yarns[2].AddNode(CNode(XYZ(0, 0, 0.05)))
Yarns[2].AddNode(CNode(XYZ(0, 0.22, 0)))
Yarns[2].AddNode(CNode(XYZ(0, 0.44, 0.05)))

Yarns[3].AddNode(CNode(XYZ(0.22, 0, 0)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0.22, 0.05)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0.44, 0)))

We have added 3 nodes to each yarn creating a woven pattern. The number in the square brackets after <code>Yarns</code> refers to a particular yarn in the list. The function <code>AddNode</code> is then called for the yarn. The function takes an instance of the class <code>CNode</code> which in turn is constructed with an instance of the class <code>XYZ</code> representing the position of the node. The class <code>XYZ</code> is constructed with 3 numbers representing the X, Y and Z coordinates of the point.

We still need to define a few more things to obtain a model. For the sake of simplicity, we will give all the yarns the same cross sectional shape, width, height, etc... The easiest way to do this is to loop over the yarns and assign the same properties to each yarn one by one. The syntax for looping over <code>Yarns</code> is shown here:

# Loop over all the yarns in the list
for Yarn in Yarns:

Inside the loop, the variable <code>Yarn</code> refers to the current yarn in the list. So within the loop we just assign properties to <code>Yarn</code> and they will be applied to all the yarns in the list. In python the begining and end of a loop are defined by indentation, hence the following lines are indented to represent the contents of the loop.

Let us define periodic cubic spline interpolation between the nodes:

# Set the interpolation function
Yarn.AssignInterpolation(CInterpolationCubic())

This is done with the function <code>AssignInterpolation</code> which takes an instance of a class derived from <code>CInterpolation</code>. In this case we used <code>CInterpolationCubic</code> to specify periodic cubic spline interpolation.

Next we need to define a cross section for the yarn, to keep things simple a constant cross section all along the length of the yarn will be defined:

# Assign a constant cross-section all along the yarn of elliptical shape
Yarn.AssignSection(CYarnSectionConstant(CSectionEllipse(0.18, 0.04)))

The function <code>AssignSection</code> takes an instance of a class derived from <code>CYarnSection</code>. In this case we used <code>CYarnSectionConstant</code> which in turns take an instance of a class derived from <code>CSection</code> as a constructor. <code>CSectionEllipse</code> defines an elliptical cross section with given width and height defined by the first and second parameters respectively.

# Set the resolution of the surface mesh created
Yarn.SetResolution(20)

This line sets the resolution of the surface mesh created. The first parameter to the function <code>SetResolution</code> represents the number of points around a cross section. The number of points along the length of the yarns is automatically calculated such that the distance between points is similar to around the cross section.

Next we must add repeat vectors to define how the yarns are repeated.

# Add repeat vectors to the yarn
Yarn.AddRepeat(XYZ(0.44, 0, 0))
Yarn.AddRepeat(XYZ(0, 0.44, 0))

The function <code>AddRepeat</code> takes an instance of the class <code>XYZ</code>. As we saw earlier the class <code>XYZ</code> is constructed with 3 numbers defining the X, Y and Z components.

Finally the yarn is fully defined, it can now be added to <code>Textile</code>:

# Add the yarn to our textile
Textile.AddYarn(Yarn)

This is the end of the loop, hence the following lines return to the original indentation. Now let's define a Domain within which the textile will be placed:

Textile.AssignDomain(CDomainPlanes(XYZ(0, 0, -0.02), XYZ(0.44, 0.44, 0.07)))

The function <code>AssignDomain</code> takes an instance of a class derived from <code>CDomain</code>. In this case we will create a box shaped domain, this can be accomplished by using the class <code>CDomainPlanes</code>. A box can be created by passing in opposite corners of the box (the minimum and maximum coordinates). This is done again with the class <code>XYZ</code>.

And finally <code>Textile</code> must be added to so that it can be rendered. Each Textile added must be assigned a name to identify it, this is the name that will appear at the top in the TexGen GUI. This name can either be generated automatically or we can specify it explicitly like so:

# Add the textile with the name "polyester"
AddTextile("polyester", Textile)

That's it! You now have the knowledge to create any type of fabric imaginable. Well, almost. The model created here is pretty simple, there is plenty of oppertunity to create more complex shapes. For example non-constant cross sections can be defined, complex domain shapes defined by arbritrary planes, different interpolation functions.

Here is the completed script:

# Create a textile
Textile = CTextile()

# Create a python list containing 4 yarns
Yarns = [CYarn(), CYarn(), CYarn(), CYarn()]

# Add nodes to the yarns to describe their paths
Yarns[0].AddNode(CNode(XYZ(0, 0, 0)))
Yarns[0].AddNode(CNode(XYZ(0.22, 0, 0.05)))
Yarns[0].AddNode(CNode(XYZ(0.44, 0, 0)))

Yarns[1].AddNode(CNode(XYZ(0, 0.22, 0.05)))
Yarns[1].AddNode(CNode(XYZ(0.22, 0.22, 0)))
Yarns[1].AddNode(CNode(XYZ(0.44, 0.22, 0.05)))

Yarns[2].AddNode(CNode(XYZ(0, 0, 0.05)))
Yarns[2].AddNode(CNode(XYZ(0, 0.22, 0)))
Yarns[2].AddNode(CNode(XYZ(0, 0.44, 0.05)))

Yarns[3].AddNode(CNode(XYZ(0.22, 0, 0)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0.22, 0.05)))
Yarns[3].AddNode(CNode(XYZ(0.22, 0.44, 0)))

# Loop over all the yarns in the list
for Yarn in Yarns:

# Set the interpolation function
Yarn.AssignInterpolation(CInterpolationCubic())

# Assign a constant cross-section all along the yarn of elliptical shape
Yarn.AssignSection(CYarnSectionConstant(CSectionEllipse(0.18, 0.04)))

# Set the resolution of the surface mesh created
Yarn.SetResolution(20)

# Add repeat vectors to the yarn
Yarn.AddRepeat(XYZ(0.44, 0, 0))
Yarn.AddRepeat(XYZ(0, 0.44, 0))

# Add the yarn to our textile
Textile.AddYarn(Yarn)

# Create a domain and assign it to the textile
Textile.AssignDomain(CDomainPlanes(XYZ(0, 0, -0.02), XYZ(0.44, 0.44, 0.07)))

# Add the textile with the name "polyester"
AddTextile("polyester", Textile)

Compiling from Source

2006-12-08T14:12:37Z

Wr: /* Introduction */

==Introduction==
More to come on compiling from source...

The following programs are needed to build TexGen:
* [http://www.cmake.org/ CMake]
* [http://www.swig.org/ SWIG]

The following libraries are needed to link to TexGen:
* [http://www.vtk.org/ VTK]
* [http://www.wxwidgets.org/ wxWidgets]
* [http://www.opencascade.org/ OpenCascade]
* [http://www.python.org/ Python]

However it is possible to build modules individually without compiling modules you do not need. Refer to the [http://texgen.sourceforge.net/api/ TexGen API] for a list of modules and their dependencies.

The latest source release can be [http://sourceforge.net/project/showfiles.php?group_id=181000 downloaded here]. Download the latest file release named ''texgen-3.x.x.tar.gz''.

Alternatively the very latest development source can be downloaded using the [http://subversion.tigris.org/ Subversion] version control system. This code may be unstable, it is not recommended unless there is a good reason to have the very latest version. The Subversion server is hosted on SourceForge, instructions on downloading from it are available [http://sourceforge.net/svn/?group_id=181000 here].