pyslha.py

changeset 208
67e368e5f414
parent 207
2990422f1738
child 210
0f4f5472b7d8
     1.1 --- a/pyslha.py	Sun Apr 28 22:24:20 2013 +0200
     1.2 +++ b/pyslha.py	Sun Apr 28 22:32:50 2013 +0200
     1.3 @@ -1,7 +1,7 @@
     1.4  #! /usr/bin/env python
     1.5  
     1.6  """\
     1.7 -A simple but flexible parser of SUSY Les Houches Accord (SLHA) model and decay files.
     1.8 +A simple but flexible handler of the SUSY Les Houches Accord (SLHA) data format.
     1.9  
    1.10  pyslha is a parser/writer module for particle physics SUSY Les Houches Accord
    1.11  (SLHA) supersymmetric spectrum/decay files, and a collection of scripts which
    1.12 @@ -11,26 +11,41 @@
    1.13  The current release supports SLHA version 1, and as far as I'm aware is also
    1.14  fully compatible with SLHA2: the block structures are read and accessed
    1.15  generically. If you have any problems, please provide an example input file and
    1.16 -I'll investigate.
    1.17 +I'll happily investigate.
    1.18  
    1.19  The plotting script provides output in PDF, EPS and PNG via LaTeX and the TikZ
    1.20  graphics package, and as LaTeX/TikZ source for direct embedding into documents or
    1.21  user-tweaking of the generated output.
    1.22  
    1.23 +Users of version 1.x should note that the interface has changed a little in
    1.24 +version 2.0.0 and onward, in particular in the interface of the Block objects,
    1.25 +which are now more dict-like: entries can be added and accessed via the usual
    1.26 +square-brackets indexing operators, including for multiple indices as is common
    1.27 +for mixing matrices e.g. NMIX[1,2] as opposed to the old NMIX.entries[1][2]
    1.28 +way. This does break backward compatibility but is a big improvement both for
    1.29 +internal code sanity and usability. The Block interface also now supplies
    1.30 +dict-like has_key(), keys(), and items() methods, as well as more specialist
    1.31 +value(), set_value() and is_single_valued() methods for improved access to ALPHA
    1.32 +and any other unindexed blocks.
    1.33 +
    1.34 +Please cite PySLHA via the URL http://insectnation.org/projects/pyslha if it is
    1.35 +useful to you in the production of an academic paper. A PySLHA publication will
    1.36 +be provided at some point... watch this space!
    1.37 +
    1.38 +
    1.39  TODOs:
    1.40  
    1.41 -For 2.0.0:
    1.42 - * Output column alignment cosmetics
    1.43 - * Precision setting obedience in SLHA output of values
    1.44 +  For 2.0.0:
    1.45 +   * Output column alignment cosmetics
    1.46 +   * Precision setting obedience in SLHA output of values
    1.47  
    1.48 -For 2.1.0:
    1.49 - * Preserve comments from read -> write (needs full-line/inline comment separation?)
    1.50 - * Consider whether Block should inherit direct from dict
    1.51 - * Split writeSLHA into writeSLHA{Blocks,Decays}
    1.52 +  For 2.1.0:
    1.53 +   * Preserve comments from read -> write (needs full-line/inline comment separation?)
    1.54 +   * Split writeSLHA into writeSLHA{Blocks,Decays}
    1.55  
    1.56 -Later/maybe:
    1.57 - * Identify HERWIG decay matrix element to use in ISAWIG
    1.58 - * Handle RPV SUSY in ISAWIG
    1.59 +  Later/maybe:
    1.60 +   * Identify HERWIG decay matrix element to use in ISAWIG
    1.61 +   * Handle RPV SUSY in ISAWIG
    1.62  """
    1.63  
    1.64  __author__ = "Andy Buckley <andy.buckley@cern.ch"

mercurial