Recommended Next Topics

...

• Account Setup

  Include Page
  PSDM:Related_Topics_Div_Close PSDM:Related_Topics_Div_Close

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

At this step you will be using the release creation tool to create and properly initialize your test release directory. The directory should be created at a file system to which you have the write access. Releases are explained in Packages and Releases section.

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):

newrel ana-current analisysanalysis-rel

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

% ls  analisysanalysis-rel/
SConstruct
.sit_release

...

Now you need to change your working directory to the newly created one where your test release is located. Then you will run sit_setup to  to make proper adjustments to your environment variables so that will recognize teh the fact that you'll be working with the test release. Note that some of those variables will be relative to the test release directory, so that you may be required to execute certain operations while being within that directory. If you choose to leave the directory then you may want to run sit_setup again to set up a different execution environment.

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

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:

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

...

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:

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.

...