Project

General

Profile

Old LArSoftWiki » History » Version 131

Katherine Lato, 07/14/2014 02:01 PM

1 87 Lynn Garren
{{>toc}}
2 87 Lynn Garren
3 29 Erica Snider
h1. LArSoftWiki
4 99 Erica Snider
5 124 Erica Snider
6 125 Erica Snider
7 54 Erica Snider
The LArSoft software is designed to work for all planned and running liquid argon experiments at Fermilab. It is written in C++ and built on the "ROOT":http://root.cern.ch data analysis software, and the "art":https://cdcvs.fnal.gov/projects/art/wiki analysis framework supported by the Fermilab Scientific Computing Division for intensity frontier experiments.
8 1 Brian Rebel
9 126 Erica Snider
  * *[[ Quick-start guide to using and developing LArSoft code ]]*
10 92 Erica Snider
11 131 Katherine Lato
[[Scratch area -- not for use]]
12 1 Brian Rebel
13 1 Brian Rebel
h1. Preliminaries
14 54 Erica Snider
15 99 Erica Snider
16 64 Erica Snider
* Fermilab computing accounts:  see the [[larsoftsvn:Fermilab Computing Access]] page if you need an account.
17 73 Erica Snider
* See [[larsoftsvn:Load Balanced Access to General Purpose VMs]] for information on accessing experiment VMs at Fermilab (e.g., lbnegpvm0X, uboonegpvm0X, etc., collectively known as GPCF.).
18 54 Erica Snider
* See the [[LArSoftWiki#documentation|documentation section below]] for information on working with LArSoft, and using git, git flow, mrb and other tools you will need.
19 73 Erica Snider
* *[[ Supported platforms ]]*
20 1 Brian Rebel
* To join the LArSoft mailing list, please follow "these instructions":http://listserv.fnal.go/users/asp#subscribe%20to%20list using the list name LARSOFT
21 103 Erica Snider
* To get write access to the repositories, send email to rs@fnal.gov, echurch@fnal.gov, greenlee@fnal.gov, trj@fnal.gov.
22 1 Brian Rebel
23 35 Erica Snider
h2. Where to find the software
24 65 Erica Snider
25 91 Erica Snider
* [[ LArSoft repositories, packages and dependencies | What are the repository names and what is in them?]]
26 128 Gianluca Petrillo
* LArSoft module [[ moduleAuthors | authors ]] and [[Librarians|librarians]]
27 97 Erica Snider
* [[ The Fermilab core LArSoft installation | The core LArSoft installation at Fermilab ]]
28 85 Erica Snider
* [[ Experiment-specific code and re-factoring ]]
29 86 Erica Snider
* [[ Sub-package locations ]] (e.g., in which repository can I find the @HitFinder@ sub-package?)
30 81 Erica Snider
* [[ Download instructions ]]
31 110 Lynn Garren
* [[ LArSoft cvmfs ]]
32 65 Erica Snider
33 104 Brian Rebel
h3. "LArSoft Doxygen":http://nusoft.fnal.gov/larsoft/doxsvn/html/index.html
34 50 Erica Snider
35 50 Erica Snider
36 77 Erica Snider
h1. Releases
37 1 Brian Rebel
38 94 Erica Snider
[[LArSoft release list|List of LArSoft releases.]] (Temporarily includes lbnecode and uboonecode)
39 117 Lynn Garren
[[LArSoft release management]] (instructions for the release manager)
40 119 Gianluca Petrillo
[[Breaking Changes]] (or "after the update my code shows 179 compiling errors! HEEELP!!")
41 94 Erica Snider
42 94 Erica Snider
43 1 Brian Rebel
h1. Documentation
44 32 Erica Snider
45 69 Erica Snider
h2. Overview of the user and developer environment
46 69 Erica Snider
47 69 Erica Snider
* [[ The user environment ]] 
48 83 Erica Snider
* [[ The developer environment ]]
49 69 Erica Snider
50 69 Erica Snider
51 69 Erica Snider
52 60 Erica Snider
h2. Working with LArSoft
53 60 Erica Snider
54 107 Erica Snider
h3. How to use the repositories and the build system
55 107 Erica Snider
56 80 Erica Snider
  * *[[ Quick-start guide to using and developing LArSoft code ]]*
57 71 Erica Snider
  * [[ LArSoft repositories, packages and dependencies ]]
58 118 Erica Snider
  * [[The rules and guidelines|Coding guidelines]] 
59 1 Brian Rebel
60 107 Erica Snider
h3. The framework and the LArSoft suite
61 107 Erica Snider
62 1 Brian Rebel
  * [[larsoftsvn:Using the Framework]]
63 68 Erica Snider
  * "ART Tutorial":http://oink.fnal.gov/
64 68 Erica Snider
  * [[larsoftsvn:NuSoft and LArSoft|nutools and LArSoft]]
65 68 Erica Snider
  * [[Using LArSoft on the GPVM nodes]]
66 120 Erica Snider
  * [[larsoftsvn:Package Documentation]]
67 107 Erica Snider
  * [[larsoftsvn:Geometry]]
68 107 Erica Snider
  * [[larsoftsvn:Reconstruction]]
69 107 Erica Snider
  * [[larsoftsvn:Simulation]]
70 107 Erica Snider
  * [[larsoftsvn:Space Points]]
71 107 Erica Snider
  * [[larsoftsvn:Seed Finding and Bezier Tracking]]
72 107 Erica Snider
  * [[larsoftsvn:Optical Simulations]]
73 107 Erica Snider
74 108 Erica Snider
  * "Past LArSoft meeting presentations -- A wealth of physics/technical information (some of which may be out of date since the transition to git / mrb / ups).":https://cdcvs.fnal.gov/redmine/projects/larsoftsvn/documents
75 1 Brian Rebel
76 1 Brian Rebel
77 1 Brian Rebel
78 68 Erica Snider
79 75 Erica Snider
h2. Links to the tools used to work with the software
80 1 Brian Rebel
81 71 Erica Snider
git and git flow:
82 67 Erica Snider
* [[cet-is-public:git flow quick start]] (edited 2/4/2013).
83 98 Erica Snider
* [[cet-is-public:GitTipsAndTricks|Git Tips and Tricks]] (Note that "git help" works, but "man git" and "git help <command>" does not on any of the gpvm machines. Nor do any of the "git <command> -h" commands.) For the purposes of LArSoft development, please please ignore the workflow advice as anything other than an example of how to use various git commands to do specific tasks.
84 1 Brian Rebel
85 72 Erica Snider
Understanding CMakeLists.txt and product_deps files
86 71 Erica Snider
* [[cet-is-public:Cetbuildtools cmake modules]]:  such as @cet_make@ and @cet_add_compiler_flags@. Used in @CMakeLists.txt@ files throughout LArSoft
87 71 Erica Snider
* [[cet-is-public:Art cmake modules]]: such as @art_make@ and @simple_plugin@. Used in @CMakeLists.txt@ files throughout LArSoft
88 71 Erica Snider
* [[cet-is-public:Defining products in the CET build environment]]: explains the @product_deps@ file
89 71 Erica Snider
* [[cet-is-public:AddingProductDependencies|Adding Product Dependencies]]: how to edit the @product_deps@ and @CMakeLists.txt@ files to add dependencies
90 71 Erica Snider
* [[cet-is-public:CodeTips|Various helpful tips for coding in the CET C++ environment]]: things you hope you never need to know
91 71 Erica Snider
* [[cet-is-public:Building your own code with cmake]]:  pointer to a _really_ simple example
92 67 Erica Snider
93 71 Erica Snider
mrb and ups:
94 32 Erica Snider
*  mrb : the multi-repository build tool
95 129 Erica Snider
** "mrb reference guide":https://cdcvs.fnal.gov/redmine/projects/mrb/wiki/MrbRefereceGuide
96 129 Erica Snider
** mrb calls @buildtool@ (from the @cetbuildtools@ product) to perform the build. "Documentation for buildtool":https://cdcvs.fnal.gov/redmine/projects/cet-is-public/wiki/Buildtool_script
97 129 Erica Snider
*  "Re-locatable" ups. (Documentation in preparation)
98 72 Erica Snider
* [[cet-is-public:AboutQualifiers|About qualifiers]]:  the things after "-q" in setup <prod> <ver> -q <qual>
99 33 Erica Snider
100 33 Erica Snider
101 112 William Seligman
h1. How-to
102 112 William Seligman
103 112 William Seligman
* [[ AnalysisExample | Getting started with an analysis task ]]
104 121 Erica Snider
* [[ Running Jobs ]]
105 33 Erica Snider
106 33 Erica Snider
107 33 Erica Snider
h2. Advanced technical how-to's
108 33 Erica Snider
109 33 Erica Snider
h2. Release procedures
110 110 Lynn Garren
111 110 Lynn Garren
h2. [[ LArSoft cvmfs ]]
112 110 Lynn Garren
113 1 Brian Rebel
114 1 Brian Rebel
h1. Walk-through exercises
115 1 Brian Rebel
116 75 Erica Snider
h1. LArSoft code management and distribution
117 1 Brian Rebel
118 103 Erica Snider
* [[Adding / removing users]]
119 75 Erica Snider
* [[Admin scripts]]
120 1 Brian Rebel
* [[LArSoft release management]] 
121 1 Brian Rebel
* [[Procedure to create a new version of larsoft_data]]
122 1 Brian Rebel
* [[Installation procedures]]
123 1 Brian Rebel
* [[Nightly builds]]
124 1 Brian Rebel
* [[Integration build and test system]]
125 1 Brian Rebel
* [[Release notes template]]
126 125 Erica Snider
127 130 Erica Snider
h1. [[LArSoft continuous integration system]]
128 130 Erica Snider
129 125 Erica Snider
h1. Legacy Redmine project sites
130 125 Erica Snider
131 125 Erica Snider
These were the sites used when LArSoft was developed under cvs and svn + SoftRelTools, respectively:
132 125 Erica Snider
133 125 Erica Snider
[[larsoft-cvs:| LArSoft-cvs wiki for the legacy cvs-based LArSoft project]]
134 125 Erica Snider
[[larsoftsvn:| LArSoft-svn wiki for the legacy svn-based LArSoft project]]
135 125 Erica Snider
136 125 Erica Snider
As of Jan 24, 2014, LArSoft transitioned from svn / SRT to git / mrb / ups, but we retain the legacy projects for historical reasons.
137 33 Erica Snider
138 51 Erica Snider
h1. Working areas
139 34 Erica Snider
140 1 Brian Rebel
141 115 Erica Snider
[[ Detailed documentation on using and developing LArSoft code ]] : under development -- not a resource
142 1 Brian Rebel
143 1 Brian Rebel
[[ Draft quick start revisions ]]
144 1 Brian Rebel
145 116 Gianluca Petrillo
[[ Profiling LArSoft ]]
146 116 Gianluca Petrillo
147 123 Gianluca Petrillo
[[Random number generators in art]]
148 123 Gianluca Petrillo
149 127 Gianluca Petrillo
[[Debugging LArSoft]]
150 127 Gianluca Petrillo
151 115 Erica Snider
Old pages that are no longer relevant or maintainted:
152 1 Brian Rebel
153 115 Erica Snider
* [[Beta re-factoring]]
154 101 Erica Snider
* *Beta testers:  [[ Special instructions for beta testers | read this first ]]*
155 1 Brian Rebel
* *[[ Special instructions for beta testers ]]*
156 115 Erica Snider
* [[LArSoft production transition timeline|Timeline for the production migration to git / mrb / ups]]
157 115 Erica Snider
* [[ Production transition checklist ]]