Logo Tesseroids 1.0: User Manual and API Documentation

Installation

Binary distribution

Windows

Download the Windows installer from the Downloads section. To install simply run it and follow the instructions.

GNU/Linux

Pre-compiled binaries for GNU/Linux are available in both 64bit and 32bit packages. Download the one that best suites your system and unpack in the desired directory. The executables will be in the "bin" folder.

Documentation

Both Windows and GNU/Linux versions contain the HTML documentation in the "doc" folder in the installation directory. To view the docs open "user-manual-v1_0.html" in a web browser. Windows users can find a link to the online documentation in the Start menu folder of the program.

Usage examples are in the "examples" folder in the installation folder. The "run_examples.sh" shell scripts contain the commands to run each example. Included are also some Python scripts that do the plotting. These are not necessary for running the examples, so don't worry if you don't know Python or have it installed. If you want to know more about Python and scientific computing in general, I recommend the excelent Software Carpentry course.

From source

Tesseroids uses the build tool SCons. A SConstruct file (Makefile equivalent) is used to define the compilation rules. You will have to download and install SCons in order to easily compile Tesseroids. SCons is available for both GNU/Linux and Windows and building should work the same on both platforms. SCons requires that you have Python installed. Check the SCons website for more information. Python is usually installed by default on most GNU/Linux systems. Under Windows you will have to put SCons on your PATH environment variable in order to use it from the command line. It is usually located in the Scripts directory of your Python installation.

On GNU/Linux SCons will use the GCC compiler to compile sources. On Windows it will search for an existing compiler. We recomment that you install GCC on Windows using MinGW.

To compile, open a terminal (cmd.exe on Windows) and go to the directory where you unpacked the source distribution. Once there, simply type:

scons

The executables are placed on a "bin" folder.

Testing

The source code for the unit tests for Tesseroids are in the "test" folder. Tesseroids uses a modified version of the MinUnit unit testing framework. When compiling the source code with SCons, the unit tests will be automatically compiled into a test program called "tesstest", placed in the "bin" folder. To run the tests, executed "tesstest".

Compiling the documentation

Tesseroids uses Doxygen to generate the documentation. You will need Doxygen installed as well as make. If you want to compile the PDF documentation you will also need Latex installed. make comes pre-installed on most GNU/Linux systems.

The source for the documentation doesn't come with the regular source code distribution. If you want to get it, go to the Source tab in the project site and see how you can get a copy of the source code from the version control repository.

To build the docs, on GNU/Linux run the command "make" from the "doc" folder to generate the HTML and Latex code for the documentation. On Windows, run "make win". To compile the Latex code, go to "doc/build/latex" and run "make". To view the HTML documentation open "doc/build/html/index.html" in an internet browser. The Latex documentation is compiled to "doc/build/latex/refman.pdf".

Generated on Tue Apr 26 12:17:07 2011 for Tesseroids 1.0: User manual and API documentation by doxygen 1.6.3