= GiBUU release notes =

== GiBUU 1.0 (04/29/2008) ==

=== Requirements ===

GiBUU is developed to work on Linux architectures. To compile the code, the following software packages must be installed on your system: 
 * a modern [wiki:tools fortran compiler] 
 * [wiki:tools makedepf90] (generates dependencies)
 * [http://www.gnu.org/software/make/ make] (steers the compiling process)

To generate the documentation one needs:
 * [wiki:tools robodoc]   


=== Using the tar-ball ===
After [http://gibuu/GiBUU/export/2167/releases/GiBUU_1_0.tgz downloading the tar-ball] please read [source:releases/release1.0/README_Quickstart.txt README_Quickstart.txt] to get started. 

=== Source code structure ===

The GiBUU repository is structured into several directories and the source code itself is sorted into different topics. The following (incomplete) list outlines the directory structure. Within the base directory, one finds the sub-directories:

==== Documentation ====

Includes the automatic documentation which is being generated by the ROBODOC documentation tool.

==== workingCode  ====
The ''workingCode'' directory includes the main source code of the GiBUU project. The file ''Makefile'' steers the compilation process and is being documented in the file ''README.Makefile.txt''. Furthermore, an example for the documentation usage is presented in ''!DemoFoRobodoc.f90''. The file ''robodoc.css'' includes the style sheets for the HTML-Documentation, and the ROBODOC configuration is included in the file ''!GenerateDoku.rc''. The file ''Makefile.SUB'' is distributed via ''make renew'' as a Makefile to all sub-directories within the ''code'' directory. 
Important sub-directories within ''workingCode'' are:

===== buuinput  =====
Includes all input files to the code. Within the directory, the file ''Makefile'' is used to unzip large files and to prepare necessary input.

===== testRun  =====
Here the executable "main.x" is found after successful compilation. The sub-directory ''jobCards'' includes sample job cards for different scenarios. To execute a job type:

{{{
./main.x < jobcardName
}}}


===== code  =====
This directory includes the full source code. The main steering program is called '''main.f90'''. See also  the [http://theorie.physik.uni-giessen.de/~gibuu/Documentation/code/robo_sourcefiles.html#top GiBUU Documentation] for information on specific source files. [[BR]]


Several sub-directories split the code into different topics:

 * '''analysis''' [[BR]]
   Includes all analysis routines.
 * '''collisions''' [[BR]]
   The collision term.
 * '''database'''[[BR]]
   Includes  particle ID's, particle properties and decay channels.
 * '''density'''[[BR]]
   Density and Pauli blocking routines.
 * '''dilepton'''[[BR]]
   Dilepton yields and analysis.
 * '''init'''[[BR]]
   Initialization routines.  
 * '''inMediumWidth''' [[BR]]
   Includes the routines which are used to calculate the in-medium-width.
 * '''inputOutput''' [[BR]]
   Includes the input module ''input.f90'' for the most important switches, such as e.g. the number of ensembles. Furthermore, this directory   provides routines to generate output.
 * '''numerics''' [[BR]]
   Includes numerical subroutines, includes also QUADPACK and CERNLIB fragments.
 * '''potential''' [[BR]]
   Potential routines and energy determination routines. 
 * '''propagation'''[[BR]]
   Routines for propagating the test-particles in time.
 * '''run'''[[BR]]
   Run-time check routines.
 * '''rmf''' [[BR]]
   Relativistic mean field potential implementation.
 * '''spectralFunctions''' [[BR]]
   Routines connected to self energies and spectral functions.
 * '''storage'''[[BR]]
   Routines to generate histograms and to store information based on pointer lists.
 * '''typeDefinitions'''[[BR]]
   Includes all underlying type definitions, e.g. the definition of the ''particle'' type.
 * '''width'''[[BR]]
   Includes all kinds of routines which are connected to the width and spectral functions of the baryons and mesons.







=== Details on the initialisation ===

GiBUU can handle the following processes:


==== elementary ====

==== Heavy Ion (low energy) ====

==== Pion induced (low energy) ====

==== Photon induced (low energy) ====

==== Electron induced (low energy) ====

==== Neutrino induced (low energy) ====
 not yet available open source

==== Heavy Ion (high energy) ====

==== Pion induced (high energy) ====

==== Photon induced (high energy) ====

==== Lepton (virtual Photon) induced (high energy) ====

==== Pions in a BOX  of nucleons (continuous boundary conditions) ====

==== Deltas in a BOX of nucleons (continuous boundary conditions) ====

==== Groundstate calculation ====

==== simple transport of a given particle ====

==== Hadron induced ====