Versions Compared

Key

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

Include Page
PSDM:Related_Topics_Div_Open
PSDM:Related_Topics_Div_Open

Recommended Next Topics

...

  • Account Setup
    Include Page
    PSDM:Related_Topics_Div_Close
    PSDM:Related_Topics_Div_Close

Include Page
PSDM:PageMenuBegin
PSDM:PageMenuBegin
Table of Contents
Include Page
PSDM:PageMenuEnd
PSDM:PageMenuEnd

About

This document explains which steps need to be done to begin using psana modules.  Once you have completed the following you can view a list of more advanced command in the section Common development tasks.

1. Create a test release

...

The newrel command requires two positional parameters: the name of a base release (in this example: ana-current) and the name of a directory which will be created for your test release (in this example: analisysanalysis-rel):

Code Block
newrel ana-current analisysanalysis-rel

This operation will create the directory and populate it with two files:

Code Block
% ls  analisysanalysis-rel/
SConstruct
.sit_release

...

These two command should be done just once when you're about to work with that test release.

Code Block
cd analisysanalysis-rel
sit_setup

3. Create new analysis package (Freq: once)

...

This will create directory my_ana_pkg and populate it with few files and sub-directories:

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

...

Code Block
mkdir my_ana_pkg/src my_ana_pkg/include   # only if src and include directories do not exist yet
codegen -l psana-module my_ana_pkg my_ana_mod

...

For a python module:

Code Block
mkdir my_ana_pkg/

...

src  # only if src directory does not exist yet
codegen -l python my_ana_

...

pkg my_ana_mod

The above will create "skeleton" files for an .cpp which contain skeleton code for analysis module.

Note

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

...