Welcome to the WimpSim WIMP monte carlo page for neutrino telescopes.
This code is released as is, and the installation is not polished to be streamlined. It is not difficult to install it though, and I will try to guide you through the necessary steps here.
WimpSim needs a set of companion software to work:
- Pythia. It is tested with Pythia 6.4.26 but probably works with other 6.4 versions as well. Download it from
hepforge, or get it directly here: pythia6.4.26.f.
- DarkSUSY. It needs the latest version (at least 5.0.5) of DarkSUSY. Download it from here.
- Nusigma. This is a neutrino-nucleon Monte Carlo written by J. Edsjö and is used by WimpSim to get both the neutrino-nucleon cross sections, but also used for simulation of neutrino-nucelon events (i.e. it is also a neutrino-nucleon scattering Monte Carlo).
Get the latest version here: nusigma-1.18-pyr.tar.gz. The version history for nusigma is given here.
- WimpSim. Then, of course, you need WimpSim itself. You can get it here: wimpsim-4.01.tar.gz. This is the latest version of WimpAnn, solar_crnu and WimpEvent. Version histories for these are found here and here. As of version 4.0, WimpAnn and solar_crnu now adds weight to events. Hence the event file structure has been changed. None of the programs wimpann, wimpevent and solar_crnu in version 4 is compatible with earlier versions of event files. Hence, you need to run all your simulations with the same version of the code. Note: The units of the solar_crnu fluxes (and wimpevent fluxes when run on solar_crnu files) have changed from 1/m2 to 1/cm2 from version 4.0 to 4.01. This change is to make the units more consitent between wimpann and solar_crnu.
If you need older versions than the current ones, they can be found here. Be aware though, that you should have no reason to run older versions, except if you want to confirm/check work done with earlier versions.
OK, so now you have got what you need. How do you get it working then? The rough installation instructions
are as follows. Personally I use ifort as my compiler, I will below outline what you need to do if you use another compiler like gfortran.
- Put Pythia whereever you want it and compile with something like
ifort -O -c pythia6.4.26.f
Of course, replace ifort with your compiler of choice above.
- Put DarkSUSY whereever you like and do
in the DarkSUSY directory if you use ifort. For you default compiler instead write
If you have another compiler of your choice, tell configure which fortran compiler you want if you have special requests.
- Put nusigma wherever you want. Modify the src/makefile to reflect your choice of fortran compiler and options. Then compile with
in the nusigma directory. This will create the needed libnusigma library. If you want to run nusigma tools standalone (not needed for WimpSim), you should modify mains/makefile so that DarkSUSY, Pythia and possibly FeynHiggs (compiled by DarkSUSY) is linked to proplery and set your compiler and options and then type make. This is not needed for WimpSim though.
- Put WimpSim wherever you want and modify the makefile in the WimpSim directory
to tell it where you have installed Pythia, DarkSUSY and nusigma. You should also modify the following makefiles to make sure your fortran compiler and options are specified: wimpann/src/makefile, wimpann/mains/makefile, contrib/sla-2.5.5/makefile, wimpevent/src/makefile, wimpevent/mains/makefile. Then compile
- Included with WimpSim is also a simple tool to calculate the Sun's position and convert between various date formats. If you want to compile it (it is not needed for anyting else by WimpSim), type
in the WimpSim directory.
That's essentially it. You then have wimpann and wimpevent in the bin directory
in WimpSim. Just run it and start playing with it.
Upgrading from 4.0
If you are upgrading from wimpsim 4.0 to 4.01 or later, please be aware that the units of the fluxes from solar_crnu (and wimpevent when run on solar_crnu files) have changed from 1/m2 to 1/cm2. This change has been made to make the units from solar_crnu match those from wimpann and also to match the publication (v2 of the arXiv version and the JCAP published version).
Upgrading from 3.05
If you are upgrading from wimpsim 3.05 you only need to get the new wimpsim. If you want to run solar_crnu you should also get the new nusigma. You do not need to upgrade DarkSUSY or Pythia.
Upgrading from 3.03
If you are upgrading from wimpsim 3.03 you only need to get the new wimpsim. You do not need to upgrade DarkSUSY, Pythia or nusigma.
Upgrading from 3.01
If you are upgrading from wimpsim 3.01 you need to get the new nusigma (which fixes a bug that in a few cases gave unphysical events) and the new wimpsim. You do not need to upgrade DarkSUSY nor Pythia.
- A common problem when compiling is that the installation directory data statements are too long (in e.g. inc/nuroot.f in nusigma). If this happens, just comment out the call to config.pl in the makefile and update the nuroot.f file manually and recompile. Sorry that this is a bit rough.
- Depending on which version of DarkSUSY you have (and how you link to it) you might get warnings that symbols like fhhiggscorr_, fhsetpara_, fhsetflags_, ssmssm and sugra are multiply defined. If this happens, comment out these dummy routines in Pythia and recompile Pythia. Then it should work.
A comment about batch runs
If you need to make lots of long wimpann and wimpevent runs for many different masses and annihilation
channels, there are a set of scripts in the scr directory that help you set
up run jobs. The most interesting scripts are wasetup.pl and wesetup.pl.
These take an input text file with your oscillation parameters (formatted as you would enter these interactively) and as the other arguments you give the entries you would otherwise have entered interactively when running wimpann and wimpevent. Run them without any options to get information on what you need to supply. The basic idea with these is that they creates a result directory that you name and in this directory lots of run scripts are automatically created from your arguments. You then run these to get the results for all the masses and channels given in wasetup.pl and wesetup.pl. In scr/ in the result directory you created, there are scripts run-wa.one and run-we.one that help you run all the run scripts in an efficient fashion. If you don't understand how to get these working though, you are probably better off
writing your own run scripts. This kind of batch setup is what I have used myself to produce the figures and tables given in the result section.
Similarly, there is a script run_solar_crnu_all.sh that can be used to run solar_crnu for different cosmic ray, density profile and oscillation parameter options. If you want to use it, please check the script and the script setup_run_solar_crnu.sh before running. These are the kind of scripts that were used for our publication on solar atmospheric neutrinos.
In case you have problems, send me an e-mail:
Go back to WimpSim home page.