tripoli4 – Parsing for Tripoli-4

Introduction

The goal of this sub-package is to parse Tripoli-4 results giving them an easy access and transforming them in the standard data format of valjean.

It contains various modules from scanning the Tripoli-4 output to conversion of its data in datasets, listed here starting from the most external modules to the innest ones:

• Integration of parsing in the valjean workflow is handled by use;

• Conversion of data to Dataset in data_convertor;

• Parsing module parse calling the scanning one scan;

• The parsing itself is done thanks to 3 modules:

  • grammar: the grammar of the Tripoli-4 ASCII output using pyparsing;

  • transform: methods to transform the parsing result in standard python and NumPy objects called in grammar via setParseAction applied on the pyparsing.ParseResults;

  • common: methods to transform Tripoli-4 data in NumPy objects.

  • One additional module parsing module is available for debugging and development: parse_debug

• Access to Tripoli-4 results from depletion, so reading ROOT files is handled by depletion.

Main modules

• data_convertor – Convert Tripoli-4 results to Dataset
• parse – Parse Tripoli-4 outputs
• scan – Scan Tripoli-4 outputs and select relevant results
  • Summary
  • Use of scan
  • Caveats
    • Beginning and end of results sections
  • Module API
• use – Inject parsing results into free functions
  • Injecting the raw parse results
  • Using a Browser
  • Module API
• depletion – Read Tripoli-4 depletion results

More details on parsing

Most of the Tripoli-4 functionalities are now parsed by pyparsing. If a new score or a new response is implemented in Tripoli-4, it would be easier for its output to match the existing responses, or else parsing will have to be updated.

When parsing fails it indicates the last line and column where parsing succeeded (relative to the beginning of the parsed string, not the full output) and the problematic line. This should help debugging.

Tests should be performed in the code to take the latter case into account (example: test presence of 'simulation time' keyword, see check_times).

• grammar – Pyparsing grammar
  • Generalitites
  • Organisation
    • Main parsers blocks
    • Response block, parser response
    • Other parsers
• transform – Transform pyparsing result
• common – Common methods to build numpy arrays from dictionaries and lists
  • Goal
  • Spectrum and meshes
    • Generalities
    • Initialization
    • Filling arrays and bins
    • Result and use in the framework
  • Other available arrays
    • Green bands
    • Adjoint results
    • Nu and (Z,A) spectrum
    • Scores on spherical harmonics
  • k_eff results
    • Conversion to matrices
    • Conversion to standard arrays
  • k_ij results
    • k_ij sources
    • k_ij matrix (result)
    • k_ij in k_eff block
  • Module API
• parse_debug – Debug parsing of Tripoli-4 outputs