This page gives a short overview for developers that want to alter the source
code of MetriVis. MetriVis source code can be browsed online by following this
url.
It is structured in trunk and branches, where the trunk contains the most stable
source code version. Branches are used to create a work-copy of the trunk. If a specific
branche finished work it will be merged back to the trunk.
This page is separated into a frontend and a backend part.
The backend is written in OO C++, compiles and runs on Linux distributions. To
see a list with dependency libraries, see the
installation page.
The source code can be browsed following this
url.
You can build MetriVis by following the guide on the
installation page.
C++ source files have a .cc suffix, header files share the .h suffix. The src folder
contains following sub-folders:
- container: contains classes used to store data in containers.
- lib: contains external libraries that are used by MetriVis. Each package in lib/ will
have a README.ETHZ file, which describes the purpose of the package, its version and source,
licence information.
- pattern: pattern classes.
- pipeline: base classes used for the processing pipelines.
- utils: utility functions and classes.
If you want to add new source files to the build process you will want to add
them to the build file located in src/SConscript.
If you want to add a new library to MetriVis, you will want to either add the
source of the library directly to MetriVis in src/lib/ or you want to add it
to the Linux system only. In the latter case you will want to change the
scons base config file located in src/SConstruct.
The frontend is written in Java that will be compiled via
GWT to Java Script.
To compile the source code you will need to download the GWT from
this website and uncompress
the tarball to the frontend/gwt-linux-1.4.60 directory. Additionally you will need
to download the GWT Widget Library
and Sasha's Maps Libraries
to the frontend/gwt-linux-1.4.60 directory.
The source code of the frontend can be found in the directory
frontend/src/ch/ethz/ee/tik/client/.
Java source files can just be added to the directory and used in the other files
as it is usual in Java. The compiler will recognize the dependencies.