Revision as of 11:32, 21 November 2018

The legacy version of this page is here.

General Information

A Version Management System for GlueX describes a standard directory structure for GlueX software, how to create complete or partial builds, and how to specify versions of individual packages, both for building and for use. It is also available as GlueX Note 2793.

See below for other helpful links.

Shell Environment Set-Up

• Setting Up the GlueX Environment

Building GlueX Software

• Building private versions of GlueX software
• Scripts for Installing GlueX Software: Do a complete build of all standard components of GlueX software or add new versions to an existing build tree.
• hdpm - Hall D Package Manager: A package manager for Hall-D software, which provides an alternative method for installing GlueX software.
• Legacy Build Instructions: Guides to various aspects of the build process. Up-to-date-ness may vary.
• Building private versions of GlueX software

Software Documentation

GlueX Software

Documentation for software systems closely related to GlueX.

Software Packages

• halld_recon
• halld_sim
• JANA
• HDDS: Detector geometry specification
  • HDDS Schema: Includes description of the HDDS mark-up language.
  • Geometry Specification for Hall D: General Description and Philosophy, September 2003
  • Detector Models for GlueX Monte Carlo Simulation: A Status Report, June 2006
  • Detector Models for GlueX Monte Carlo Simulation: the CD2 Baseline, January 2007
  • HDDS Tagged Releases
• HDDM: The Hall D Data Model, a compact xml-based format for event-based data.
• EVIO: The CODA event format.
• CCDB: Calibration Database
  • Policy on CCDB Variations for Reconstructing Simulated Data
• RCDB: Run Conditions Database
  • Web Interface
  • GlueX Implementation of the RCDB
• AmpTools: Amplitude analysis package (aka partial wave analysis)
• EventStore: a package for managing and deploying data files and event lists
• HDGeant4: Geant4-based simulation of the GlueX Detector and Hall D beamline
• Git: see Source Code Management below.
• Subversion: see Source Code Management below.
• sim-recon (deprecated, July 2018)
  • Doxygen Documentation: Descriptions of sim-recon C++ classes and their relationships.
  • Sim-Recon Tagged Releases
  • Analysis Software in sim-recon
  • SCons Build System (SBMS)
• MCwrapper
  • Active Sample Dashboard
  • MC Submission Form

Special Topics

• Offline HOWTO List: Guides to performing various specific tasks.
• Beam Simulations: Geant simulations of the Hall D Tagger Hall
• Sensitivity to Magnetic Field Strength
• How HDGeant defines time-zero for physics events
• Guide to Monte Carlo event timing and detached vertices in HDGeant/4
• Guide to roll-your-own python hddm transforms

Documentation for External Software Packages

Documentation on additional software packages used by GlueX. Development and maintenance of these are not directly related to GlueX.

Data Sets

• Simulations: a guide to simulated data sets.

Offline Data Monitoring

• Data_Monitoring_Procedures: Information on offline monitoring of recently-taken data

Computing Facilities

JLab

• Computer Center
• Scientific Computing
  • Farm Job Status Auger job status from SciComp
    • jproj Job Status Status of jobs using the jproj system
  • Tape Request Status
• Disk space usage
  • Group
    • /group/halld leader board
  • Cache
    • /cache/halld leader board
  • Volatile
    • /volatile/halld leader board
  • Work
    • /work/halld leader board
• GlueX-related shared accounts on the JLab CUE
• Hall D MySQL/MariaDB Servers and Replication Relationship: a list of database servers

Grid

• Open Science Grid
  • Using the Grid with Containers
  • Using the Grid
  • Gridmake

Other Computing Resources

• Computer Farms: Clusters at GlueX-collaborating institutions.

Software Management

Source Code Management

• Git
  • GlueX Git Repositories
  • Instructions for Working with GlueX Git Repositories. Workflow description.
  • Instructions for joining the GlueX team on GitHub
  • Git Help Resources, July 14
  • Guide to Using Git. General usage tips.
  • Git questions and answers in the Offline FAQ
  • Splitting sim-recon
  • Conversion from Subversion to Git (Summer 2015)
• Subversion
  • Browse the Hall D Subversion Repository
    • Legacy version

Testing and Debugging

• Automatic Builds of GlueX Software: nightly build, pull-request-initiated test build, scan-build
• Automatic Tests of GlueX Software
• Diagnosing segmentation faults in reconstruction software

Governance, Conventions, Standard Practices

• Offline Issue Tracking using GitHub Issue Tracking
• Offline Issue Tracking using the Mantis Bug Tracker
• GlueX Coding Standards
• Version Management
• GlueX Cron Jobs
• Data Challenges: Large-scale tests of computing infrastructure
• Data Management Plan for Hall D: Long-term preservation of data and data-analysis tools
• JLab Offline Computing Plan, FY2010
• Role of the Software Coordinator

Meetings and Reviews

• GlueX Offline Software Meetings: Agendas and minutes
• HDGeant4 Meetings
• GlueX Containers Meetings
• Software and Computing Reviews

Communication and Help

• Google Group for GlueX Software
  • Help on GlueX-related Google Groups
• GlueX Software Help Email List: Ask a question!
• Offline Software Email List: announcements and discussion
  • Send email to the list
  • Message archive
  • Google search of archive
  • Information page (subscribe, unsubscribe, list members, etc.)
• Simple Email Lists: get notifications from automated tests
• Communication Instructions: Guides to communication systems used by GlueX

FAQ

• The GlueX Offline Frequently Asked Questions List

Legacy Links

• Offline Computing Project Management
• Versioning of Calibration Constants
• Releases of GlueX Software
• Reconstruction Tasks and Topics for Further Development
• Running jobs on the grid
• Calibration Constants, Tagged Versions

Uncategorized Links

1. Offline Software Topics
   1. GEANT 3 manual
   2. osrelease.pl script
      • Legacy page: Action Items From Hall-D Software Meetings
   3. Software Task List
   4. JANA/DANA
   5. Simulation Software
   6. Geometry
   7. Magnetic Field Maps for Solenoid
   8. The Build Management System (BMS)
   9. Reconstruction Software
   10. Deprecated Software Links
2. Offline Projects
3. Material on Splitoffs
4. EVO
5. GlueX Communications More on ESNET,EVO ...
6. Private:Using VNC
7. 2013 Software Review
8. 2012 Software Review
9. IT in the 12-GeV Era: close-out slides
10. Geometries for 2008 DC Review
11. Tracking resolution estimator (REZEST)
12. Installing HDDS-to-GEANT4 converter
13. Duties of the GlueX Software Coordinator
14. ded
15. Action Items
16. Action Items Archive
17. Hall D and JLab Servers: Web servers, database servers, etc.