Difference between revisions of "GlueX Offline Software"

From GlueXWiki
Jump to: navigation, search
(→‎Uncategorized Links)
(→‎GlueX and Containers)
 
(96 intermediate revisions by 5 users not shown)
Line 3: Line 3:
 
|
 
|
 
'''News:'''
 
'''News:'''
−
* November 25, 2019: [[HDGeant4_Meeting,_November_19,_2019#Minutes|Minutes of the November 19 HDGeant4 Meeting are available]].
+
* July 19, 2022: [[GlueX_Software_Meeting,_July_18,_2022#Minutes|Minutes of the July 18th Software Meeting]] are available
−
* November 19, 2019: [https://mailman.jlab.org/pipermail/halld-offline/2019-November/003819.html New version set: version_4.11.0.xml]
+
* July 12, 2022: [https://halldweb.jlab.org/halld_versions/version_5.8.0.xml New version set: 5.8.0].
−
* September 4, 2019: [https://mailman.jlab.org/pipermail/halld-offline/2019-September/003751.html New release of gluex_install, version 2.10]
+
* June 7, 2022: [[GlueX_Software_Meeting,_June_6,_2022#Minutes|Minutes of the June 6th Software Meeting]] are available
−
* September 3, 2019: [[GlueX_Software_Meeting,_September_3,_2019#Minutes|Minutes of the September 3rd Software Meeting are available]]
+
* May 23, 2022" [https://halldweb.jlab.org/wiki/index.php/GlueX_Tutorial_2022 GlueX Software and Analysis Tutorial 2022]
−
* August 30, 2019: [https://mailman.jlab.org/pipermail/halld-offline/2019-August/003746.html New version set: version_4.8.0.xml]
+
* May 19, 2022: [https://mailman.jlab.org/pipermail/halld-offline/2022-May/008816.html New version set: 5.7.1].
−
* August 25, 2019: [https://mailman.jlab.org/pipermail/halld-offline/2019-August/003739.html Time-history plots of Hall D computing resources]
+
−
* August 20, 2019: [[GlueX_Software_Meeting,_August_20,_2019#Minutes|Minutes of the August 20th Software Meeting are available]]
+
 
* [[Offline Software News Archive|Previous news items...]]
 
* [[Offline Software News Archive|Previous news items...]]
 
|
 
|
 
'''Quick Links:'''
 
'''Quick Links:'''
−
* [https://github.com/orgs/JeffersonLab/teams/gluex/repositories Repositories on GitHub]
+
* [https://scicomptest.jlab.org/scicomp/tapeFile Listing of files missing from the tape library]
 
* [[GlueX Offline FAQ|Frequently Asked Questions]]
 
* [[GlueX Offline FAQ|Frequently Asked Questions]]
−
* [https://mailman.jlab.org/pipermail/halld-offline/ halld-offline@jlab.org Email List Archive]
+
* [[Offline HOWTO List|HOWTO List]]
−
* [https://groups.google.com/forum/#!forum/gluex-software GlueX Software Help Google Group]
+
* [[GlueX_Offline_FAQ#Where_do_I_find_version_set_files.3F|Version Set Files]]
 +
* [https://github.com/orgs/JeffersonLab/teams/gluex/repositories Repositories on GitHub]
 
* [[GlueX Offline Software Meetings]]
 
* [[GlueX Offline Software Meetings]]
 
|}
 
|}
Line 30: 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 38: Line 37:
 
* [[Hall D Package Manager|hdpm - Hall D Package Manager]]: A package manager for Hall-D software, which provides an alternative method for installing GlueX software.
 
* [[Hall D Package Manager|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.
 
* [[Legacy Build Instructions]]: Guides to various aspects of the build process. Up-to-date-ness may vary.
 +
* [[GlueX_Offline_FAQ#Where_do_I_find_version_set_files.3F|Version Sets Files]]
  
 
=== GlueX and Containers ===
 
=== GlueX and Containers ===
  
 
* [[GlueX Software on Oasis]]
 
* [[GlueX Software on Oasis]]
 +
* [https://github.com/JeffersonLab/hd_singularity Package for Building Singularity Containers]
 +
* [[GlueX Containers Meetings]]
 +
* [[HOWTO use the GlueX Singularity Container]]
  
 
==Software Documentation==
 
==Software Documentation==
Line 50: 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''''']]
 +
* 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]]
  
 
====Software Packages====
 
====Software Packages====
  
 +
* [https://github.com/mashephe/AmpTools AmpTools]: Amplitude analysis package (aka partial wave analysis)
 +
* [[Calibration Database|CCDB]]: Calibration Database
 +
** [[Policy on CCDB Variations for Reconstructing Simulated Data]]
 +
* [https://github.com/sdobbs/HDEventStore EventStore]: a package for managing and deploying data files and event lists
 +
* [https://coda.jlab.org/drupal/content/event-io-evio EVIO]: The [https://coda.jlab.org/drupal/ CODA] event format.
 
* [https://github.com/jeffersonlab/halld_recon halld_recon]
 
* [https://github.com/jeffersonlab/halld_recon halld_recon]
 
* [https://github.com/jeffersonlab/halld_sim halld_sim]
 
* [https://github.com/jeffersonlab/halld_sim halld_sim]
−
* [https://www.jlab.org/JANA/ JANA]
+
* [[HDDM Programmer's Interface|HDDM]]: The Hall D Data Model, a compact xml-based format for event-based data.
 
* HDDS: Detector geometry specification
 
* HDDS: Detector geometry specification
 
** [https://halldsvn.jlab.org/repos/trunk/hdds/HDDS-1_1.xsd HDDS Schema]: Includes description of the HDDS mark-up language.
 
** [https://halldsvn.jlab.org/repos/trunk/hdds/HDDS-1_1.xsd HDDS Schema]: Includes description of the HDDS mark-up language.
Line 62: Line 74:
 
** [https://halldweb.jlab.org/doc-public/DocDB/ShowDocument?docid=732 Detector Models for GlueX Monte Carlo Simulation: the CD2 Baseline], January 2007
 
** [https://halldweb.jlab.org/doc-public/DocDB/ShowDocument?docid=732 Detector Models for GlueX Monte Carlo Simulation: the CD2 Baseline], January 2007
 
** [[HDDS Tagged Releases]]
 
** [[HDDS Tagged Releases]]
−
* [[HDDM Programmer's Interface|HDDM]]: The Hall D Data Model, a compact xml-based format for event-based data.
+
* [[HOWTO install and run HDGeant4|HDGeant4]]: Geant4-based simulation of the GlueX Detector and Hall D beamline
−
* [https://coda.jlab.org/drupal/content/event-io-evio EVIO]: The [https://coda.jlab.org/drupal/ CODA] event format.
+
* [https://www.jlab.org/JANA/ JANA]
−
* [[Calibration Database|CCDB]]: Calibration Database
+
* MCwrapper
−
** [[Policy on CCDB Variations for Reconstructing Simulated Data]]
+
**[https://halldweb.jlab.org/gluex_sim/Dashboard.html '''Active Sample Dashboard''']
 +
**[https://halldweb.jlab.org/gluex_sim/SubmitSim.html '''MC Submission Form''']
 +
* [https://pypwa.jlab.org/index.html PyPWA:] [https://pypwa.readthedocs.io/ Python-based Partial Wave Analysis Toolkit]
 
* [https://github.com/JeffersonLab/rcdb/wiki RCDB]: Run Conditions Database
 
* [https://github.com/JeffersonLab/rcdb/wiki RCDB]: Run Conditions Database
 
** [https://halldweb.jlab.org/rcdb/ Web Interface]
 
** [https://halldweb.jlab.org/rcdb/ Web Interface]
 
** [[GlueX Implementation of the RCDB]]
 
** [[GlueX Implementation of the RCDB]]
−
* [http://amptools.sourceforge.net/index.php/Main_Page AmpTools]: Amplitude analysis package (aka partial wave analysis)
 
−
* [https://github.com/sdobbs/HDEventStore EventStore]: a package for managing and deploying data files and event lists
 
−
* [[HOWTO install and run HDGeant4|HDGeant4]]: Geant4-based simulation of the GlueX Detector and Hall D beamline
 
−
* Git: see [[GlueX Offline Software#Source Code Management|Source Code Management]] below.
 
−
* Subversion: see [[GlueX Offline Software#Source Code Management|Source Code Management]] below.
 
 
* sim-recon (deprecated, July 2018)
 
* sim-recon (deprecated, July 2018)
 
** [http://www.jlab.org/Hall-D/software/HDSoftware_Documentation/ Doxygen Documentation]: Descriptions of sim-recon C++ classes and their relationships.
 
** [http://www.jlab.org/Hall-D/software/HDSoftware_Documentation/ Doxygen Documentation]: Descriptions of sim-recon C++ classes and their relationships.
Line 79: Line 88:
 
** [[GlueX_Analysis_Software | Analysis Software in sim-recon]]
 
** [[GlueX_Analysis_Software | Analysis Software in sim-recon]]
 
** [[SCons Build System]] (SBMS)
 
** [[SCons Build System]] (SBMS)
−
* MCwrapper
 
−
**[https://halldweb.jlab.org/gluex_sim/Dashboard.html '''Active Sample Dashboard''']
 
−
**[https://halldweb.jlab.org/gluex_sim/SubmitSim.html '''MC Submission Form''']
 
  
 
====Special Topics====
 
====Special Topics====
Line 95: Line 101:
 
* [[Reconstruction Software]]
 
* [[Reconstruction Software]]
 
* [[Kinematic Fitting]]
 
* [[Kinematic Fitting]]
 +
# [[Splitoff_Information | Material on Splitoffs]]
  
 
===Documentation for External Software Packages===
 
===Documentation for External Software Packages===
Line 136: Line 143:
  
 
===JLab===
 
===JLab===
−
* [https://halldweb.jlab.org/disk_management/halld_status.html Hall D Offline System Status Plots]
+
* [https://halldweb.jlab.org/disk_management/halld_status.html Hall D Offline System Status Plots] [[File:User jobs 0 thumb.png|link=https://halldweb.jlab.org/disk_management/halld_status.html]]
 
* [[Computing Services and Servers|Hall D and JLab Servers]]: Web servers, database servers, etc.
 
* [[Computing Services and Servers|Hall D and JLab Servers]]: Web servers, database servers, etc.
 
* [https://cc.jlab.org/ Computer Center]
 
* [https://cc.jlab.org/ Computer Center]
−
* [https://scicomp.jlab.org/scicomp/ Scientific Computing]
+
* [https://scicomptest.jlab.org/scicomp/ Scientific Computing]
 
** [https://scicomp.jlab.org/scicomp/#/auger/jobs Farm Job Status] Auger job status from SciComp
 
** [https://scicomp.jlab.org/scicomp/#/auger/jobs Farm Job Status] Auger job status from SciComp
 
*** [https://halldweb.jlab.org/cgi-bin/jproj_status.pl jproj Job Status] Status of jobs using the jproj system
 
*** [https://halldweb.jlab.org/cgi-bin/jproj_status.pl jproj Job Status] Status of jobs using the jproj system
Line 160: Line 167:
 
** [https://mailman.jlab.org/pipermail/halld-offline/2017-June/002827.html Using the Grid with Containers]
 
** [https://mailman.jlab.org/pipermail/halld-offline/2017-June/002827.html Using the Grid with Containers]
 
** [[Using the Grid]]
 
** [[Using the Grid]]
 +
** [[Updating Oasis for the GlueX VO]]
 
** [https://halldweb.jlab.org/talks/2011-2Q/gridmake-6-2011.ppt Gridmake]
 
** [https://halldweb.jlab.org/talks/2011-2Q/gridmake-6-2011.ppt Gridmake]
  
−
===Other Computing Resources===
+
===Off-Site Computing Resources===
  
−
* [[Computer Farms]]: Clusters at GlueX-collaborating institutions.
+
* [[Off-site Computing Resources]]: Status of applications, current and past allocations
  
 
==Software Management==
 
==Software Management==
Line 200: Line 208:
 
* [https://data.jlab.org/drupal/?q=system/files/Offline%20Plan%20FY10.pdf JLab Offline Computing Plan, FY2010]
 
* [https://data.jlab.org/drupal/?q=system/files/Offline%20Plan%20FY10.pdf JLab Offline Computing Plan, FY2010]
 
* [[Role of the Software Coordinator]]
 
* [[Role of the Software Coordinator]]
 +
 +
=== Containers ===
 +
 +
* [[GlueX and Containers]]: an overview of the use of containers in GlueX
  
 
==Meetings and Reviews==
 
==Meetings and Reviews==
Line 207: Line 219:
 
* [[GlueX Containers Meetings]]
 
* [[GlueX Containers Meetings]]
 
* [[Software and Computing Reviews]]
 
* [[Software and Computing Reviews]]
 +
* [[Geometries for 2008 DC Review]]
  
 
==Communication and Help==
 
==Communication and Help==
  
−
* [https://groups.google.com/forum/#!forum/gluex-software Google Group for GlueX Software]
 
−
**[[GlueX-Related Google Groups|Help on GlueX-related Google Groups]]
 
−
* [https://mailman.jlab.org/pipermail/halld-offline/2016-April/002297.html GlueX Software Help Email List]: Ask a question!
 
 
* Offline Software Email List: announcements and discussion
 
* Offline Software Email List: announcements and discussion
 
** [mailto:halld-offline@jlab.org Send email to the list]
 
** [mailto:halld-offline@jlab.org Send email to the list]
Line 218: Line 228:
 
** [https://www.google.com/cse/publicurl?cx=001547825138043056762:dydinmymrvu Google search of archive]
 
** [https://www.google.com/cse/publicurl?cx=001547825138043056762:dydinmymrvu Google search of archive]
 
** [https://mailman.jlab.org/mailman/listinfo/halld-offline Information page] (subscribe, unsubscribe, list members, etc.)
 
** [https://mailman.jlab.org/mailman/listinfo/halld-offline Information page] (subscribe, unsubscribe, list members, etc.)
 +
* [https://groups.google.com/forum/#!forum/gluex-software Google Group for GlueX Software]
 +
**[[GlueX-Related Google Groups|Help on GlueX-related Google Groups]]
 +
** [https://mailman.jlab.org/pipermail/halld-offline/2016-April/002297.html Original announcement]
 +
* [https://slack.com/ Slack]
 +
** Chat application using the workspace '''jlab12gev'''
 +
** Click [https://jlab12gev.slack.com/signup here] to join. You must use your JLab email address.
 
* [[Email Lists#Simple Email Lists|Simple Email Lists]]: get notifications from automated tests
 
* [[Email Lists#Simple Email Lists|Simple Email Lists]]: get notifications from automated tests
 
* [[GlueX_Communications|Communication Instructions]]: Guides to communication systems used by GlueX
 
* [[GlueX_Communications|Communication Instructions]]: Guides to communication systems used by GlueX
Line 235: Line 251:
 
* [[Action Items Archive (May 4, 2010 and before)]]
 
* [[Action Items Archive (May 4, 2010 and before)]]
 
* [http://www.jlab.org/Hall-D/offline/Software_tasks.php Software Task List]
 
* [http://www.jlab.org/Hall-D/offline/Software_tasks.php Software Task List]
−
 
+
* [[Tracking resolution estimator (REZEST)]]
−
=Uncategorized Links=
+
* [[ded]]
−
 
+
−
# [[Offline Software Topics]]
+
−
# [[Offline Projects]]
+
−
# [[Splitoff_Information | Material on Splitoffs]]
+
−
# [[EVO]]
+
−
# [[GlueX Communications]] More on ESNET,EVO ...
+
−
# [[Private:Using VNC]]
+
−
# [[2013 Software Review]]
+
−
# [[2012 Software Review]]
+
−
# [https://halldweb.jlab.org/doc-private/DocDB/ShowDocument?docid=1782 IT in the 12-GeV Era: close-out slides]
+
−
# [[Geometries for 2008 DC Review]]
+
−
# [[Tracking resolution estimator (REZEST)]]
+
−
# [http://clasweb.jlab.org/wiki/index.php/HDDS2GEANT4_Installation_Notes Installing HDDS-to-GEANT4 converter]
+
−
# [http://dustbunny.physics.indiana.edu/mailman/private/gluex/2009-April/002627.html Duties of the GlueX Software Coordinator]
+
−
# [[ded]]
+
−
# [[Action Items From Hall-D Software Meetings|Action Items]]
+

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

Retrieved from "https://halldweb1.jlab.org/wiki/index.php?title=GlueX_Offline_Software&oldid=124508"