| 155 | | === Requirements === |
| 156 | | |
| 157 | | GiBUU is developed primarily for Linux architectures, but works also on Windows and Mac OS X. For the specific requirements, please refer to the [wiki:tools prerequisites] page. |
| 158 | | |
| 159 | | === Source code structure === |
| 160 | | |
| 161 | | 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: |
| 162 | | |
| 163 | | ==== Documentation ==== |
| 164 | | |
| 165 | | Includes the automatic documentation which is being generated by the ROBODOC documentation tool. |
| 166 | | |
| 167 | | ==== buuinput ==== |
| 168 | | |
| 169 | | Includes all input files to the code. |
| 170 | | |
| 171 | | ==== release1.X.X ==== |
| 172 | | |
| 173 | | The ''release'' 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''. The file ''Makefile.SUB'' is distributed via ''make renew'' as a Makefile to all sub-directories within the ''code'' directory. |
| 174 | | Important sub-directories within ''workingCode'' are: |
| 175 | | |
| 176 | | ===== objects ===== |
| 177 | | |
| 178 | | This directory will contain all the object and module files which are produced during the compilation process. |
| 179 | | |
| 180 | | ===== robodoc ===== |
| 181 | | |
| 182 | | Here all the files related to the robodoc documentation system are found. 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''. |
| 183 | | |
| 184 | | ===== testRun ===== |
| 185 | | |
| 186 | | Here the executable "GiBUU.x" is found after successful compilation. The sub-directory ''jobCards'' includes sample job cards for different scenarios. To execute a job type: |
| 187 | | |
| 188 | | {{{ |
| 189 | | ./GiBUU.x < jobcardName |
| 190 | | }}} |
| 191 | | |
| 192 | | |
| 193 | | ===== code ===== |
| 194 | | |
| 195 | | This directory includes the full source code. The main steering program is called '''GiBUU.f90'''. See also the [//Documentation/code/robo_sourcefiles.html GiBUU Documentation] for information on specific source files. [[BR]] |
| 196 | | |
| 197 | | |
| 198 | | Several sub-directories split the code into different topics: |
| 199 | | |
| 200 | | * '''analysis''' [[BR]] |
| 201 | | Includes all analysis routines. |
| 202 | | * '''collisions''' [[BR]] |
| 203 | | The collision term. |
| 204 | | * '''database'''[[BR]] |
| 205 | | Includes particle ID's, particle properties and decay channels. |
| 206 | | * '''density'''[[BR]] |
| 207 | | Density and Pauli blocking routines. |
| 208 | | * '''init'''[[BR]] |
| 209 | | Initialization routines. |
| 210 | | * '''inMediumWidth''' [[BR]] |
| 211 | | Includes the routines which are used to calculate the in-medium-width. |
| 212 | | * '''inputOutput''' [[BR]] |
| 213 | | 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. |
| 214 | | * '''numerics''' [[BR]] |
| 215 | | Includes numerical subroutines, includes also QUADPACK and CERNLIB fragments. |
| 216 | | * '''potential''' [[BR]] |
| 217 | | Potential routines and energy determination routines. |
| 218 | | * '''propagation'''[[BR]] |
| 219 | | Routines for propagating the test-particles in time. |
| 220 | | * '''run'''[[BR]] |
| 221 | | Run-time check routines. |
| 222 | | * '''rmf''' [[BR]] |
| 223 | | Relativistic mean field potential implementation. |
| 224 | | * '''spectralFunctions''' [[BR]] |
| 225 | | Routines connected to self energies and spectral functions. |
| 226 | | * '''storage'''[[BR]] |
| 227 | | Routines to generate histograms and to store information based on pointer lists. |
| 228 | | * '''typeDefinitions'''[[BR]] |
| 229 | | Includes all underlying type definitions, e.g. the definition of the ''particle'' type. |
| 230 | | * '''width'''[[BR]] |
| 231 | | Includes all kinds of routines which are connected to the width and spectral functions of the baryons and mesons. |
| 232 | | |
| 233 | | |
| 234 | | |
| 235 | | === Details on the initialisation === |
| 236 | | |
| 237 | | GiBUU can handle the following processes: |
| 238 | | |
| 239 | | * elementary |
| 240 | | * Heavy Ion (low energy / high energy) |
| 241 | | * Pion induced (low energy / high energy) |
| 242 | | * Photon induced (low energy / high energy) |
| 243 | | * Electron induced (low energy) |
| 244 | | * Neutrino induced (low energy) |
| 245 | | * Lepton (virtual Photon) induced (high energy) |
| 246 | | * Hadron induced |
| 247 | | * Pions in a BOX of nucleons (continuous boundary conditions) |
| 248 | | * Deltas in a BOX of nucleons (continuous boundary conditions) |
| 249 | | * Groundstate calculation |
| 250 | | * simple transport of a given particle |
