Project

General

Profile

Old LArSoftWiki » History » Version 106

Erica Snider, 02/04/2014 03:29 PM

1 87 Lynn Garren
{{>toc}}
2 87 Lynn Garren
3 106 Erica Snider
[[larsoft-cvs:| LArSoft-cvs wiki for the legacy cvs-based LArSoft project]]
4 1 Brian Rebel
5 106 Erica Snider
6 106 Erica Snider
[[larsoftsvn:| LArSoft-svn wiki for the legacy svn-based LArSoft project]]
7 29 Erica Snider
8 99 Erica Snider
h1. LArSoftWiki
9 93 Erica Snider
10 101 Erica Snider
As of Jan 24, 2014, LArSoft has transitioned from svn / SRT to git / mrb / ups. These pages will be in flux for the next week or so until the documentation updates are completed.
11 93 Erica Snider
12 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.
13 1 Brian Rebel
14 92 Erica Snider
15 1 Brian Rebel
16 1 Brian Rebel
h1. Preliminaries
17 54 Erica Snider
18 99 Erica Snider
19 64 Erica Snider
* Fermilab computing accounts:  see the [[larsoftsvn:Fermilab Computing Access]] page if you need an account.
20 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.).
21 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.
22 73 Erica Snider
* *[[ Supported platforms ]]*
23 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
24 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.
25 1 Brian Rebel
26 35 Erica Snider
h2. Where to find the software
27 65 Erica Snider
28 91 Erica Snider
* [[ LArSoft repositories, packages and dependencies | What are the repository names and what is in them?]]
29 102 Lynn Garren
* [[ moduleAuthors | LArSoft module authors ]]
30 97 Erica Snider
* [[ The Fermilab core LArSoft installation | The core LArSoft installation at Fermilab ]]
31 85 Erica Snider
* [[ Experiment-specific code and re-factoring ]]
32 86 Erica Snider
* [[ Sub-package locations ]] (e.g., in which repository can I find the @HitFinder@ sub-package?)
33 81 Erica Snider
* [[ Download instructions ]]
34 65 Erica Snider
35 104 Brian Rebel
h3. "LArSoft Doxygen":http://nusoft.fnal.gov/larsoft/doxsvn/html/index.html
36 50 Erica Snider
37 50 Erica Snider
38 77 Erica Snider
h1. Releases
39 1 Brian Rebel
40 94 Erica Snider
[[LArSoft release list|List of LArSoft releases.]] (Temporarily includes lbnecode and uboonecode)
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 80 Erica Snider
  * *[[ Quick-start guide to using and developing LArSoft code ]]*
55 71 Erica Snider
  * [[ LArSoft repositories, packages and dependencies ]]
56 1 Brian Rebel
57 1 Brian Rebel
  * [[larsoftsvn:Using the Framework]]
58 68 Erica Snider
  * "ART Tutorial":http://oink.fnal.gov/
59 68 Erica Snider
  * [[larsoftsvn:NuSoft and LArSoft|nutools and LArSoft]]
60 68 Erica Snider
  * [[Using LArSoft on the GPVM nodes]]
61 1 Brian Rebel
62 1 Brian Rebel
63 1 Brian Rebel
64 68 Erica Snider
65 75 Erica Snider
h2. Links to the tools used to work with the software
66 1 Brian Rebel
67 71 Erica Snider
git and git flow:
68 67 Erica Snider
* [[cet-is-public:git flow quick start]] (edited 2/4/2013).
69 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.
70 1 Brian Rebel
71 72 Erica Snider
Understanding CMakeLists.txt and product_deps files
72 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
73 71 Erica Snider
* [[cet-is-public:Art cmake modules]]: such as @art_make@ and @simple_plugin@. Used in @CMakeLists.txt@ files throughout LArSoft
74 71 Erica Snider
* [[cet-is-public:Defining products in the CET build environment]]: explains the @product_deps@ file
75 71 Erica Snider
* [[cet-is-public:AddingProductDependencies|Adding Product Dependencies]]: how to edit the @product_deps@ and @CMakeLists.txt@ files to add dependencies
76 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
77 71 Erica Snider
* [[cet-is-public:Building your own code with cmake]]:  pointer to a _really_ simple example
78 67 Erica Snider
79 71 Erica Snider
mrb and ups:
80 32 Erica Snider
*  mrb : the multi-repository build tool
81 1 Brian Rebel
*  Re-locatable ups
82 72 Erica Snider
* [[cet-is-public:AboutQualifiers|About qualifiers]]:  the things after "-q" in setup <prod> <ver> -q <qual>
83 33 Erica Snider
84 33 Erica Snider
85 45 Erica Snider
h1. How-to's
86 33 Erica Snider
87 33 Erica Snider
88 33 Erica Snider
h2. Advanced technical how-to's
89 33 Erica Snider
90 33 Erica Snider
h2. Release procedures
91 1 Brian Rebel
92 1 Brian Rebel
h1. Walk-through exercises
93 1 Brian Rebel
94 75 Erica Snider
h1. LArSoft code management and distribution
95 1 Brian Rebel
96 103 Erica Snider
* [[Adding / removing users]]
97 75 Erica Snider
* [[Admin scripts]]
98 75 Erica Snider
* [[Procedure to create a new version of larsoft_data]]
99 76 Erica Snider
* [[Installation procedures]]
100 76 Erica Snider
* [[Release notes template]]
101 33 Erica Snider
102 51 Erica Snider
h1. Working areas
103 34 Erica Snider
104 34 Erica Snider
[[Beta re-factoring]]
105 71 Erica Snider
106 1 Brian Rebel
[[ Detailed documentation on using and developing LArSoft code ]] : not a resource
107 1 Brian Rebel
108 1 Brian Rebel
[[ Production transition checklist ]]
109 1 Brian Rebel
110 1 Brian Rebel
[[ Draft quick start revisions ]]
111 88 Erica Snider
112 101 Erica Snider
Old pages:
113 101 Erica Snider
114 1 Brian Rebel
* *Beta testers:  [[ Special instructions for beta testers | read this first ]]*
115 105 Erica Snider
* *[[ Special instructions for beta testers ]]*
116 101 Erica Snider
*[[LArSoft production transition timeline|Timeline for the production migration to git / mrb / ups]]*