Difference between revisions of "GettingStarted Software"

From Xem2
Jump to navigationJump to search
(Created page with "==Hall C Software for XEM2== We are using all standard equipment and thus the standard hall C analyzer (hcana). ==Coding Paradigm== ===Resposibility=== Prior to 2021, Abish...")
 
 
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Hall C Software for XEM2==
 
==Hall C Software for XEM2==
We are using all standard equipment and thus the standard hall C analyzer (hcana).
+
We are using all standard equipment and thus the standard hall C analyzer (hcana).
  
==Coding Paradigm==
 
===Resposibility===
 
Prior to 2021, Abishek Karki replayed all the data for the XEM and F2 analyses. 
 
For all future passes of 2022 data, Casey Morean is in charge of maintaining the codebase.
 
===Hierarchy===
 
* Git is used as version control for all shared code
 
* Casey (https://github.com/mrcmor100) has forked from all relevant JeffersonLab (https://github.com/JeffersonLab) repositories
 
** All XEM group members other than Casey only need to worry about changes to Casey's repositories.
 
** Casey is in charge of pulling changes from the JeffersonLab repositories.
 
*All XEM group members will 'Fork' Casey's repository, which will appear on their GitHub account, that is your 'origin'.
 
**Changes can be made on a 'local' branch and then pushed to your 'origin'.
 
**Once you have pushed your changes to your 'origin', you can make a pull request to Casey add your changes into 'upstream'.
 
*Communications about new features / calibrations / etc will be sent via the Software Slack channel.  Feel free to also watch Casey's repositories for email notifications.
 
  
'''Remember:''' The point of all this is for us to '''collaborate'''
+
==Hall C Commands for XEM2==
 +
 
 +
===Accessing RAW data files and PASS# data files===
 +
This section lists some commands that interface with the mass storage system.  Refer to the file system layout for a better idea of where large data files are stored.  Jasmine is the system that interfaces with the MSS. 
 +
;[https://scicomp.jlab.org/docs/storage, Jasmine] MSS utility information page
 +
:Save local copy of MSS file to /cache/ [https://scicomp.jlab.org/docs/node/586, jcache]
 +
:Put a file into MSS with our group permissions [https://scicomp.jlab.org/docs/node/522, jput]
 +
:Get a file in MSS and put the local copy at a specified location (not cache) [https://scicomp.jlab.org/docs/node/522, jget]
 +
These commands can be issued on any farm node.  They cannot be ran from most computers like chislobog, jlabl* or vmware.  jcache is the most commonly used command used.
 +
 
 +
==Sourcing our Software==
 +
===Versioning===
 +
Analysis relies on CERN ROOT and HCANA as well as the mc-single-arm and other repositories.  In order to maintain the newest version and work using the same software, a software directory has been made on our group disk:
 +
* /group/c-xem2/software/
 +
* We are currently operating with Version 1.0.0 of the XEM software package:
 +
** HCANA v0.90.00 (Develop 9d6b290)
 +
** CERN ROOT v6.22.06
 +
** Python v3.4.6
 +
 
 +
===Sourcing Instructions===
 +
 
 +
Users have access to the common users environment, and our /group/ location.
 +
* For join the xem2 group on JLab computers talk to Dave.
 +
 
 +
In order to source the files, simply type source /group/c-xem2/software/setup.sh or source /group/c-xem2/software/setup.csh (depending on your shell).
 +
 
 +
You should add the sourcing of the setup script to your .cshrc or .bashrc file (depending on your shell).
 +
 
 +
===Check Everything is Working===
 +
* Type python --version, and it should return the correct version
 +
** Make sure you can load ROOT in python (import ROOT as R)
 +
* Open root-config --version and check the version number
 +
* Make sure the hadd utility works
 +
* Make sure hcana can be run from any directory.  For more information on the replay and hcana, go to the REPLAY page.
 +
** Don't run source script in a directory that has a setup.csh script (home should be ok)

Latest revision as of 19:35, 14 March 2023

Hall C Software for XEM2

We are using all standard equipment and thus the standard hall C analyzer (hcana).


Hall C Commands for XEM2

Accessing RAW data files and PASS# data files

This section lists some commands that interface with the mass storage system. Refer to the file system layout for a better idea of where large data files are stored. Jasmine is the system that interfaces with the MSS.

Jasmine MSS utility information page
Save local copy of MSS file to /cache/ jcache
Put a file into MSS with our group permissions jput
Get a file in MSS and put the local copy at a specified location (not cache) jget

These commands can be issued on any farm node. They cannot be ran from most computers like chislobog, jlabl* or vmware. jcache is the most commonly used command used.

Sourcing our Software

Versioning

Analysis relies on CERN ROOT and HCANA as well as the mc-single-arm and other repositories. In order to maintain the newest version and work using the same software, a software directory has been made on our group disk:

  • /group/c-xem2/software/
  • We are currently operating with Version 1.0.0 of the XEM software package:
    • HCANA v0.90.00 (Develop 9d6b290)
    • CERN ROOT v6.22.06
    • Python v3.4.6

Sourcing Instructions

Users have access to the common users environment, and our /group/ location.

  • For join the xem2 group on JLab computers talk to Dave.

In order to source the files, simply type source /group/c-xem2/software/setup.sh or source /group/c-xem2/software/setup.csh (depending on your shell).

You should add the sourcing of the setup script to your .cshrc or .bashrc file (depending on your shell).

Check Everything is Working

  • Type python --version, and it should return the correct version
    • Make sure you can load ROOT in python (import ROOT as R)
  • Open root-config --version and check the version number
  • Make sure the hadd utility works
  • Make sure hcana can be run from any directory. For more information on the replay and hcana, go to the REPLAY page.
    • Don't run source script in a directory that has a setup.csh script (home should be ok)