Versions Compared

Key

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

...

Include Page
PSDMInternal:PageMenuEnd
PSDMInternal:PageMenuEnd

1. Create a test release (Freq: once)

Releases are explained in Packages and Releases section. Create new test release with the command like this:

...

Below we refer to this directory as a "test release". Usually separate analyses use separate test releases, and each test release should bear unique name if they are located in the same directory.

2. Change to the test release (Freq: every logon or whenever needed)

Code Block
cd analisys-rel
sit_setup

The last sit_setup command is very important and must be executed from the release directory every time you change the directory.

3. Create new analysis package (Freq: once)

Choose sufficiently unique name for your analysis package and create the package.

...

Code Block
       .../analisys-rel/
                      ./my_ana_pkg/
                                   SConscript
                                   doc/
                                       README
                                       ChangeLog

4. Add analysis module (Freq: once)

Execute following commands:

...

Note

Like with the package name it's better to use names containing letters, digits, and underscores only.

5. Modify analysis code (Freq: as much as you need)

Use your favorite editor to add or modify code the analysis module. For C++ modules see Psana User Manual for examples.

6. Build (Freq: after every edit)

Run the command which builds all necessary software in your test release:

Code Block
scons

7. Create configuration file (Freq: once)

In addition to analysis module the job usually needs a separate configuration file. The name and location of the file could be arbitrary. C++-based analysis uses file named psana.cfg in current directory by default, create it with your favorite editor:

...

The file will contain both the names of the modules you want to load and parameters you want to pass to those modules, exact content of the configuration file is explained in Pyana User Manual.

8. Run the analysis (Freq: as much as you need)

Chose the data you want to process and start analysis job. Assuming properly prepared psana.cfg in current directory, execute:

...