Difference between revisions of "Documentation"

From victor
Jump to: navigation, search
(Unit test)
(Unit test)
Line 10: Line 10:
 
= Unit test =
 
= Unit test =
  
Victor come along with a '''Unit Test''' suite providing an effective tool for testing core classes and the most important functions. The implemented tests have been organized by package (Align2, Biopool, Energy and Lobo). Each test has its own executable that will became available in bin/ after compiling (TestAlign2, TestBiopool, TestEnergy and TestLobo).
+
Victor come along with a '''Unit Test''' suite providing an effective tool for testing core classes and the most important functions. The implemented tests have been organized by package (Align2, Biopool, Energy and Lobo). Each test has its own executable that will became available in '''bin/''' after compiling:
 +
 
 +
* TestAlign2
 +
* TestBiopool
 +
* TestEnergy
 +
* TestLobo
  
 
To obtain the test executable files you need the third party '''Cpp Unit''' library and to compile Victor with a special flag.  
 
To obtain the test executable files you need the third party '''Cpp Unit''' library and to compile Victor with a special flag.  

Revision as of 15:22, 10 October 2014

This page is dedicated to developers of new tools and people involved in the Victor maintenance.

Doxygen

The Doxygen documentation provides a comprehensive view of the Victor package. Is possible to navigate the class hierarchy, search for specific functions and their detailed description. For an overview of the implemented algorithms and methods visit the Introduction, Features and Reference pages. The current Doxygen documentation is available at:

Victor Doxygen Documentation


Unit test

Victor come along with a Unit Test suite providing an effective tool for testing core classes and the most important functions. The implemented tests have been organized by package (Align2, Biopool, Energy and Lobo). Each test has its own executable that will became available in bin/ after compiling:

  • TestAlign2
  • TestBiopool
  • TestEnergy
  • TestLobo

To obtain the test executable files you need the third party Cpp Unit library and to compile Victor with a special flag. In Ubuntu this library (Cpp Unit) is available in the libcppunit-dev package. To install the library do:

sudo apt-get install libcppunit-dev

After that, to compile Victor tests:

make test=1