WimpSim Code

Welcome to the WimpSim WIMP monte carlo page for neutrino telescopes.

This code is released as is, and the installation is not super-polished. It is not difficult to install it though, and I will try to guide you through the necessary steps here.

As of 2018-06-19 (WimpSim 4.1 and nusigma-1.19), the installation is simpler as both codes now use a configure system (autoconf). Both codes now also work with DarkSUSY 6 instead of DarkSUSY 5. Update 2018-12-20: wimpsim-4.1.2 fixes a build issue (two makefiles needed modification on linux systems).

Needed software

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 of DarkSUSY (at least 6, version 5 or earlier will not work). Download it from here.
  

  Note. Currenty, there is an issue with a change in common blocks in DarkSUSY 6.2, we are working on fixing this, meanwhile, please use DarkSUSY 6.1.1 together with WimpSim instead.

  
  
• 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.19-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-5.0.tar.gz. This is the latest version of WimpAnn, solar_crnu, med_dec and WimpEvent. Version histories for these are found here, here, 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 1: The units of the solar_crnu fluxes (and wimpevent fluxes when run on solar_crnu files) have changed from 1/m² to 1/cm² from version 4.0 to 4.01. This change is to make the units more consitent between wimpann and solar_crnu.
  Note 2: As of nusigma-1.19 and WimpSim-4.1, the codes have been updated to work with DarkSUSY 6 (instead of 5). Both codes now also has a configure system (autoconf) to make it simpler to compile the code.

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.

Installation instructions

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 gfortran or ifort as my compiler, I will below outline what you need to do if you want to specify a given compiler or specific options. It is advisable to use the same compiler for all programs.

• Put Pythia whereever you want it and compile with something like
  gfortran -O -c pythia6.4.26.f
  or
  ifort -O -c pythia6.4.26.f
  
  
• Put DarkSUSY whereever you like and do
  ./conf.gfortran (or conf.ifort for ifort)
  make
  The script conf.gfortran just calls the configure script specifying compiler and compiler options. If you want to use some other compiler or compiler options, please change the call to configure accordingly (by e.g. using conf.gfortran as a starting point).
  
  
• Put nusigma wherever you want. Configure and make with
  conf.gfortran
  make libnusigma
  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 specify the paths to DarkSUSY and Pythia when calling configure. See the conf.gfortran script and change accordingly. This is not needed for WimpSim though.
  
  
• Put WimpSim wherever you want and configure it. As for the other programs, this is done with the configure script. Note that WimpSim needs to find DarkSUSY, nusigma and Pythia, hence you need to tell configure where you have installed them. Change conf.gfortran accordingly to reflect your install paths and then configure and make with
  conf.gfortran
  make all
  
  
• 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
  make sladate
  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 4.01 or earlier, please not that WimpSim now uses a configure system to make compilation easier. WimpSim now also requires DarkSUSY 6 (it will not work with DarkSUSY 5 and earlier).

If you are upgrading from wimpsim 4.0 to 4.01 please be aware that the units of the fluxes from solar_crnu (and wimpevent when run on solar_crnu files) have changed from 1/m² to 1/cm². 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.

Frequent problems/questions

• 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.

Documentation

• Please check out the WimpSim documentation for more technical information about the simulations.
• For nusigma, there is also a nusigma documentation (old, but more or less up-to-date).

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: edsjo@fysik.su.se
Go back to WimpSim home page.