Project

General

Profile

Old LArSoftWiki » History » Version 105

Erica Snider, 01/30/2014 06:13 PM

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