Readme = FLUKA files short doc
--------------------------------------------------------
UPDATED===15.06.2008
TITLE===FLUKA files short doc
--------------------------------------------------------

	<p>This complements the Unix installation parts of the Fluka manual</p>

	<p>All Fluka releases have a numbering scheme like:</p>

	<ul class="none"><li><pre>Fluka&#060;major revision&#062;.&#060;minor revision&#062;&#060;patch level&#062;(.respin) *</pre></li></ul>

	<p>where &#060;major revision&#062; is usually the year that major revision has been developed, &#060;minor revision&#062; is a number like 1,2,..., and the patch level is a letter like b,c,... . Releases differing in patch level only are supposed to differ because of bug fixes only or small feature additions. Respin numbers simply indicate whether a given version has been redistributed with minor changes like changing a dimension para- meter, changes/fixes in some databases, curing obvious problems</p>

	<hr />
	<h2>FLUKA filesystem structure</h2>

	<p style="color: #8175ff">top directory:</p>

	<table>
	<tr><td style="width: 40%">fluka2006.manual</td><td>manual, ascii version</td></tr>
	<tr><td>FM.pdf</td><td>manual, pdf version</td></tr>
	<tr><td>CERN-2005-10.pdf</td><td>official reference</td></tr>
	<tr><td>libflukahp.a</td><td>compiled library with all Fluka routines</td></tr>
	<tr><td>example.inp</td><td>example input in various formats</td></tr>
	<tr><td>exfixed.inp</td></tr>
	<tr><td>exmixed.inp</td></tr>
	<tr><td>random.dat</td><td>random number seed</td></tr>
	<tr><td>sigmapi.bin</td><td>datafiles</td></tr>
	<tr><td>elasct.bin</td></tr>
	<tr><td>neuxsc_72.bin</td></tr>
	<tr><td>nuclear.bin</td></tr>
	<tr><td>fluodt.dat</td></tr>
	<tr><td>brems_fin.bin</td></tr>
	<tr><td>gxsect.bin</td></tr>
	<tr><td>cohff.bin</td></tr>
	<tr><td>e6r1nds3.fyi</td></tr>
	<tr><td>jef2.fyi</td></tr>
	<tr><td>jendl3.fyi</td></tr>
	<tr><td>xnloan.dat</td></tr>
	</table>

	<p style="color: #8175ff">flutil/</p>

	<table>
	<tr><td style="width: 20%">lfluka</td><td>script to link Fluka (contains help) or auxiliary programs</td></tr>
	<tr><td>ldpmqmd</td><td>script to link Fluka with RQMD-2.4 and DPMJET-2.53</td></tr>
	<tr><td>ldpm3qmd</td><td>script to link Fluka with RQMD-2.4 and DPMJET-3</td></tr>
	<tr><td>rfluka</td><td>script to run Fluka  (contains help)</td></tr>
	<tr><td>fff</td><td>script to compile single routines</td></tr>
	<tr><td>ustsuw.f</td><td>program to sum data files from USRTRACK option and compute statistics</td></tr>
	<tr><td>usxsuw.f</td><td>program to sum data files from USRBDX option and compute statistics</td></tr>
	<tr><td>usysuw.f</td><td>program to sum data files from USRYIELD option and compute statistics</td></tr>
	<tr><td>usbsuw.f</td><td>program to sum data files from USRBIN option and compute statistics</td></tr>
	<tr><td>usrsuw.f</td><td>program to sum data files from RESNUCLE option and compute statistics</td></tr>
	<tr><td>usrsuwev.f</td><td>program to sum data files from RESNUCLE option, compute statistics, and evolve for given irradiation and decay times the radioactive inventory</td></tr>
	</table>

	<p style="color: #8175ff">flukapro/</p>
             <ul class="none"><li>all Fluka include files</li></ul>
	<p style="color: #8175ff">usermvax/</p>
             <ul class="none"><li>fortran user routines</li></ul>

	<hr />
	<h2>Usage notes:</h2>

	<p>to change the user routines and link:</p>

	<ul class="list">
	<li>user routines are for source definition, biasing and scoring purposes (see the manual for details)</li>

	<li>all user routines contains some parts that cannot be changed (mainly include directives). They must be linked with flukapro/ include files and with static option. The flutil/fff  script makes this authomatically.</li>

	<li>User routines can be either inserted in the libflukahp library (strongly discouraged) or linked as standalone obj files or inserted in a user library</li>
	</ul><br />

	<table>
	<tr><td style="width: 20%">flutil/lfluka</td><td>links from libflukahp and optional obj files if no -m (main) option is given, it can be used to link different programs. To link the default run excutable issue:</td></tr>
	<tr><td></td><td align="center"><pre>flutil/lfluka -m fluka</pre></td></tr>
	<tr><td>lfluka -h</td><td>explains input parameters.</td></tr>
	</table><br />

	<table width="70%" border="1" style="margin-left: 15%;"><tr><td>
	all script files contain a top directory definition (FTOP) that must be properly set before usage. For most of them it suffices that the user defines an environmental variable FLUPRO pointing to the directory where the distribution tar file has been opened
	</td></tr></table>

	<br />

	<hr />
	<h2>To run Fluka</h2>

	<p>the flutil/rfluka script creates a work subdirectory to run Fluka, sets the appropriate logical links, and runs the program for a user-defined numbers of runs, each time writing the last random seed of the run, to be used as first seed by the next run, and copying back the output files to the parent directory. output and data files will have names of the form &#060;input&#062;&#060;run number&#062;.out and &#060;input&#062;&#060;run number&#062;_&#060;data file name&#062; where &#060;data file name&#062;  is the one specified in the OPEN card of the input file (mandatory on HPUX-9, optional on VMS, Linux, Compaq TrueUnix, IBM/AIX and HPUX-10 where a default for###, fort.### or ftn### unit is opened)</p>

	<ul class="none"><li><pre>rfluka -h     explains input parameters.</pre></li></ul>

	<p style="color: #8175ff">before running:</p>

	<p>if the electromagnetic part is swiched on, a "pemf file" is no longer required. Look at the release-notes and the manual for further details</p>

	<p style="color: #8175ff">after:</p>

	<p>auxiliary programs are needed to read, sum and analyze binary or formatted data files. An example is provided for binary USRTRACK, USRBDX, USRYIELD, USRBIN and RESNUCLE data file. I.e. program ustsuw creates a binary sum file &#060;output file&#062; an ascii summary file &#060;output file&#062;_sum.lis, and an ascii compact file suitable for further automatic processing &#060;output file&#062;_tab.lis</p><br />