Table of Contents
- How do I get the code?
- Is there any kind of documentation? How do I start?
- Which Operating Systems does GiBUU support?
- Why do I get the error message "cannot find -lbz2" when compiling GiBUU ?
- My GiBUU simulation stops with some error message. What should I do?
- How can I contribute to the GiBUU project?
- I want to publish results obtained with the GiBUU code. How should I …
Frequently asked questions
How do I get the code?
Starting with the hepforge system migration in September 2018, only a download of tar balls is possible. See here for details.
GiBUU has public releases that can be downloaded via Subversion. See the release notes for details on the source code structure and how to compile the code.
If you need access to the current development version or want to contribute code to GiBUU, please create an account.
Is there any kind of documentation? How do I start?
You can have a look at our release notes or README. Additional source code documentation can be found here.
To compile the code you must have some recent Fortran compiler installed (cf. this page). Simply go to the base directory and type
make
More details on the compilation process are given here. After successful compilation, the binary can be found in the testRun directory. To run the code, you need to prepare a job card defining necessary inputs. This job card is then used in the following way:
./GiBUU.x < jobCard
Sample job cards are given in the directory testRun/jobcards and some documentation is given here.
We propose you try compiling the code and running it using a sample job card first. We are on the way to document the job cards more properly. If you need assistance to write your own, please let us now.
Which Operating Systems does GiBUU support?
GiBUU can be compiled and run on Linux, Windows or Mac OS X. The basic requirements are:
- a modern Fortran compiler
- make
- perl or makedepf90
- libbzip2
Other systems (like Solaris, BSD, etc) which fulfill these requirements may also work, but have not been tested.
While GiBUU is primarily targeted at Linux, it can also be run on Windows (via Cygwin) or Mac OS X with little additional effort. For details see:
Why do I get the error message "cannot find -lbz2" when compiling GiBUU ?
The bzip2 library is required for compiling GiBUU since release 1.3. In particular the static version of this library is needed (libbz2.a). More details can be found here.
My GiBUU simulation stops with some error message. What should I do?
Please report it to the GiBUU mailing list. Your report should include at least the following information:
- the jobcard which exhibits the error
- a log file containing the complete GiBUU output
If you can not provide a full log file, please tell us at least
- your operating system, compiler and GiBUU version (i.e. the first lines of output of ./GiBUU.x)
- the final error message (i.e. the last few lines of output)
- how long it took until the error happened (seconds, hours, days?)
How can I contribute to the GiBUU project?
We are very open to code contributions from external users. If you have made any modifications to the code, which you want to contribute to GiBUU, please send them to the GiBUU mailing list in the form of a patch, so that they can be reviewed by the GiBUU developers. After a successful review process, they will be committed to our repository (with proper recognition of the author, of course).
I want to publish results obtained with the GiBUU code. How should I proceed?
We would greatly appreciate if you could send us your results prior to publication, so that we can evaluate if you're using the GiBUU code in a reasonable way. Doing a transport simulation is a non-trivial procedure and requires good understanding of the input parameters. Although we are trying to make the usage as straightforward as possible, there are still lots of things that can go wrong. Therefore it is important to check the results prior to publication.
For the actual publication it is recommended that you cite (at least) the GiBUU review paper. Depending on the type of reaction studied, other references might be useful in addition.
