/** \file 
 * This file is used for the doxygen documentation. 
 */

/**
\dir neuronviz

NeuronViz is a simple graphical neural network viewer for artificial ratebased neural networks.

\par Installation
The installation is very easy. 
The following commands copy <tt>neuronviz.jar</tt> and some imaged to 
 directory <tt>~/lib/neuronviz</tt> and <tt>neuronviz</tt> to directory <tt>~/bin</tt>. 
\code
user@host:~/path/to/neuronviz$ cd src
user@host:~/path/to/neuronviz/src$ make
user@host:~/path/to/neuronviz/src$ make install
\endcode
That's all. 

\par Usage
\code
neuronviz < testdescription2.txt
\endcode
or
\code
cat testdescription2.txt | neuronviz
\endcode

\par Format

\verbatim
#N neural_net NETWORKNAME
#N layer LAYERNAME1 RANK?
#N neuron N0 BIASN0?
#N neuron N1 BIASN1?
#N layer LAYERNAME2 RANK?
#N neuron K0 BIASK0?
#N neuron K1 BIASK1?
...
#N connection C00 N0 K0
#N connection C10 N0 K1
#N connection C01 N1 K0
#N connection C11 N1 K1
...
#N nn_end
\endverbatim

Example:
\verbatim
#N neural_net test
#N layer INPUT 0
#N neuron x[0]
#N neuron x[1]
#N layer C 1
#N neuron y[0] b[0]
#N neuron y[1] b[1]
#N layer A 2
#N neuron xP[0]
#N neuron xP[1]
#N connection C[0][0] x[0] y[0]
#N connection C[0][1] x[0] y[1]
#N connection C[1][0] x[1] y[0]
#N connection C[1][1] x[1] y[1]
#N nn_end
\endverbatim

*/