Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

XTC Explorer is a GUI-based tool to explore interactively the XTC data files.
Data is extracted using the LCLS framework pyana or psana.;

This application is implemented as opens a Python GUI which generates helps to prepare configuration file for pyana or psana and then allows to launch itlaunch it. The pyana or psana framework modules access, accumulate, and plot data from XTC file.

  • Data is extracted using the LCLS framework pyana or psana.
  • GUI is implemented on PyQt,
  • visualization of data uses matplotlib,
  • data processing algorithms are accelerated by NumPy and SciPy libraries.

Based on selections made in the GUI, xtcexplorer writes out pyana configuration files with names xb_pyana_XXXX.cfg, where XXXX is a random four-digit number. You can use them to run pyana directly from the command line. But they accumulate, so you might want to remove these regularly...

...

  • project name: XTC Explorer
  • package name: XtcExplorer
  • executable name: xtcexplorer

...

Authors:

  • Ingrid Ofter - implemented everything for pyana
  • Joseph Barrera - begin began to add option to run python modules on psana
  • Andy Salnikov - latest maintenance, fixing bugs, complete transition to integration with psana.

Latest tags:
2012-Aug-20 ofte V00-01-37
...
2013-Mar-14 salnikov V00-03-00

This tutorial follows to the Manual XTC Explorer, shows how to set up environment, start xtcexplorer, explore content of the xtc file,
interactively create/edit configuration file for pyana/psana, run it interactively and in the command line, etc.

...

  • See for details Analysis Workbook. Account Setup
  • Log onto any machine of the interactive pools psananeh (for AMO, XPP, SXR data) or psanafeh (for XCS, CXI, MEC data):
    Code Block
    ssh -Y pslogin
    ssh psananeh
    or
    ssh psanafeh
    
  • Once per session execute one of the following scripts
    • for bash shell:
      Code Block
      . /reg/g/psdm/etc/sit_env.sh
      
    • or for csh shell:
      Code Block
      source /reg/g/psdm/etc/sit_env.csh
      
  • You should always run this application from your own release working directory:
    Code Block
        newrel ana-current my_tutorial_release;
        cd my_tutorial_release;
        sit_setup; 
    
    At this point you are ready to go.

...

Exercise 2: Explore XTC file content and make configuration file

In the Psana Control Center window

  • set desired parameters in section General Settings
  • in the left panel check detectors which you want to monitor, for example
    (tick) EBeam
    (tick) FEEGasDetEnergy
    (tick) XppGon-0|Cspad2x2-1
    Note

    In case of selection
    (tick) Epics Process Variables
    separate window Available Epics PVs will pop show up. Desired PVs need to be checked.

...

Currently implemented pyana/psana modules

Framework module name

...

Functionality

...

XtcExplorer/src/pyana_bld.py

...

display of Beam-line

...

data

...

XtcExplorer/src/pyana_epics.py

...

display of Epics PV data

XtcExplorer/src/pyana_scan.py

...

display of motor scan data

XtcExplorer/src/pyana_encoder.py

...

display of encoder data

XtcExplorer/src/pyana_ipimb.py

...

display of diode data from IPIMB and PIM

XtcExplorer/src/pyana_waveform.py

...

display of waveform data

XtcExplorer/src/pyana_image.py

...

display of camera image data

XtcExplorer/src/pyana_plotter.py

...

plotter module to control the event display

These modules can be included used in the configuration file using editor with parameters explained described in XTC Explorer.

What to use pyana or psana?

Now you are familiar with general concept of how to launch pyana or psana in the xtcexplorer or command line for existing modules. But you need in more data processing and would like to get data in your code in the framework module. What framework should you prefer pyana or psana?

  • We strongly encourage people to use psana, which covers everything what is available in pyana and has more features, which are not available in pyana.
  • Pyana still works in ana-0.9.15 release. Upcoming modifications in pdsdata may force to drop further maintenance of pyana.
  • psana is going to be supported in future for both C++ and Python modules for batch and interactive mode.

Framework interfaces in pyana and psana modules are slightly different, that is explained in
Migration from pyana to psana

Note

psana should be your preferable choise!

References

XTC Explorer
HDF5 Explorer
Pyana User Manual
Migration from pyana to psana

...