Difference between revisions of "GlueX Offline Software"

From GlueXWiki
Jump to: navigation, search
(Software Packages)
(GlueX and Containers)
 
(10 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
|
 
|
 
'''News:'''
 
'''News:'''
* April 14, 2022: [[GlueX_Software_Meeting,_April_13,_2022#Minutes|Minutes of the April 13th Software Meeting]] are available
+
* July 19, 2022: [[GlueX_Software_Meeting,_July_18,_2022#Minutes|Minutes of the July 18th Software Meeting]] are available
* April 7, 2022: [https://mailman.jlab.org/pipermail/halld-offline/2022-April/008799.html New version set: 5.6.0].
+
* July 12, 2022: [https://halldweb.jlab.org/halld_versions/version_5.8.0.xml New version set: 5.8.0].
* March 31, 2022: [[GlueX_Software_Meeting,_March_30,_2022#Minutes|Minutes of the March 30th Software Meeting]] are available.
+
* June 7, 2022: [[GlueX_Software_Meeting,_June_6,_2022#Minutes|Minutes of the June 6th Software Meeting]] are available
* March 16, 2022: [[GlueX_Software_Meeting,_March_16,_2022#Minutes|Minutes of the March 16th Software Meeting]] are available.
+
* May 23, 2022" [https://halldweb.jlab.org/wiki/index.php/GlueX_Tutorial_2022 GlueX Software and Analysis Tutorial 2022]
* March 11, 2022: [https://mailman.jlab.org/pipermail/halld-offline/2022-March/008786.html New version of Build Scripts: version 2.33]. This version allows set-up of a subset of packages. Packages omitted from the XML file will not have their set-up steps performed.
+
* May 19, 2022: [https://mailman.jlab.org/pipermail/halld-offline/2022-May/008816.html New version set: 5.7.1].
 
* [[Offline Software News Archive|Previous news items...]]
 
* [[Offline Software News Archive|Previous news items...]]
 
|
 
|
Line 29: Line 29:
 
===Shell Environment Set-Up===
 
===Shell Environment Set-Up===
  
* [[Setting Up the GlueX Environment]]
+
* [https://halldweb.jlab.org/docs/build_scripts_web/node6.html#SECTION00062400000000000000 Simple Environment Set Up]
  
 
===Building GlueX Software===
 
===Building GlueX Software===
Line 44: Line 44:
 
* [https://github.com/JeffersonLab/hd_singularity Package for Building Singularity Containers]
 
* [https://github.com/JeffersonLab/hd_singularity Package for Building Singularity Containers]
 
* [[GlueX Containers Meetings]]
 
* [[GlueX Containers Meetings]]
 +
* [[HOWTO use the GlueX Singularity Container]]
  
 
==Software Documentation==
 
==Software Documentation==
Line 52: Line 53:
  
 
Documentation for software packages specific to GlueX or to JLab.
 
Documentation for software packages specific to GlueX or to JLab.
 +
* A brief overview of the GlueX-specific software can be found [[ Software | here ]]
 
* Best practices in writing code for the HallD/GlueX software environment check out this link of [[Coding Conventions| '''''HallD/GlueX Coding Conventions''''']]
 
* Best practices in writing code for the HallD/GlueX software environment check out this link of [[Coding Conventions| '''''HallD/GlueX Coding Conventions''''']]
 
* A convenient way to enhance the impact of comments inside the code is to use [https://halldweb.jlab.org/talks/2021/usedoxy.pdf '''''Doxygen''''']. The hooks and infrastructures are already implemented for the packages ''halld_recon'' and ''halld_sim''.
 
* A convenient way to enhance the impact of comments inside the code is to use [https://halldweb.jlab.org/talks/2021/usedoxy.pdf '''''Doxygen''''']. The hooks and infrastructures are already implemented for the packages ''halld_recon'' and ''halld_sim''.
*[[Documentation Initiative]]
+
* [[Documentation Initiative]]
  
 
====Software Packages====
 
====Software Packages====

Latest revision as of 18:52, 31 January 2024

News:

Quick Links:

The legacy version of this page is here.

General Information

Build Scripts: 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

Building GlueX Software

GlueX and Containers

Software Documentation

Packages used in the GlueX software stack with links to package-specific documentation.

GlueX Software

Documentation for software packages specific to GlueX or to JLab.

  • A brief overview of the GlueX-specific software can be found here
  • Best practices in writing code for the HallD/GlueX software environment check out this link of HallD/GlueX Coding Conventions
  • A convenient way to enhance the impact of comments inside the code is to use Doxygen. The hooks and infrastructures are already implemented for the packages halld_recon and halld_sim.
  • Documentation Initiative

Software Packages

Special Topics

  1. Material on Splitoffs

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

Offline Data Monitoring

Computing Facilities

JLab

Grid

Off-Site Computing Resources

Software Management

Source Code Management

Testing and Debugging

Governance, Conventions, Standard Practices

Containers

Meetings and Reviews

Communication and Help

FAQ

Legacy Links