Skip to content

README.md

Latest commit

 

History

History
83 lines (53 loc) · 2.77 KB

README.md

File metadata and controls

83 lines (53 loc) · 2.77 KB

Copyright (c) 2013 YR Copyright (c) 2013 by The University of Warwick

This file is part of pySNemo.

pySNemo is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

pySNemo is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with pySNemo. If not, see http://www.gnu.org/licenses/.

pySNemo: A package for reducing and analysing SuperNEMO data

Documentation is provided through the docstrings.

Contents

pySNemo provides the following subpackages:

Subpackages

  • ca_glue --- merge two cellular automaton propagation direction clusters

  • cellular_automaton --- cellular automaton clustering algorithm

  • fitter --- helix and line fitting routines, produces trajectories

  • reconstruction --- final step routines to end at Particle Track Data objects for analysis

  • control --- Control mechanisms for event processing.

  • io --- Interfaces to persistant data formats.

  • utility --- Widely useful classes and functions.

  • cluster --- clustering for reconstruction

  • graphtrack --- convert raw data rings to hit candidates and produce possible paths

  • scripts --- scripts for use of pySNemo, especially validation scripts

Requirements

  • ROOT 6 (for Minuit fitting)
  • networkx (for Graph objects)
  • NumPy/SciPy (throughout)

Init

No installation as such but informing the system of pySNemo existance is required. Setting the Python path to the package, for instance as:

setenv PYTHONPATH ${PYTHONPATH}:${HOME}/Code/pySNemo/python

On most machines, also the link path for finding ROOT is required, for instance as this on the Warwick CSC cluster:

setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:/warwick/epp/2015.1/Cellar/root6/6.08.02/lib/root

The compile instructions to create the small ROOT shared library are in-place at python/pysnemo/fitter/create_so.txt

After that, there is a final hard-wired path to adapt, telling the code where to find the little library: the third line in pyroot3dfitterV2.py is

root.gSystem.Load("/home/epp/phsdaq/Code/pySNemo/python/pysnemo/fitter/fit3dVers2_cxx.so")

which needs adapting to the local install location.

Licensing

Please study the file LICENSE.txt for the distribution terms and conditions of use of pySNemo.