Project

General

Profile

Old LArSoftWiki » History » Version 101

Erica Snider, 01/24/2014 02:53 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 92 Erica Snider
[[larsoftsvn:| Wiki for the legacy svn-based LArSoft project]]
5 29 Erica Snider
6 99 Erica Snider
h1. LArSoftWiki
7 93 Erica Snider
8 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.
9 93 Erica Snider
10 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.
11 92 Erica Snider
12 1 Brian Rebel
To join the LArSoft mailing list, please follow these "instructions":http://listserv.fnal.gov/users.asp#subscribe%20to%20list using the list name LARSOFT.
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 92 Erica Snider
* 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 1 Brian Rebel
24 35 Erica Snider
h2. Where to find the software
25 65 Erica Snider
26 91 Erica Snider
* [[ LArSoft repositories, packages and dependencies | What are the repository names and what is in them?]]
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 65 Erica Snider
32 50 Erica Snider
33 50 Erica Snider
34 77 Erica Snider
h1. Releases
35 1 Brian Rebel
36 94 Erica Snider
[[LArSoft release list|List of LArSoft releases.]] (Temporarily includes lbnecode and uboonecode)
37 94 Erica Snider
38 94 Erica Snider
39 1 Brian Rebel
h1. Documentation
40 32 Erica Snider
41 69 Erica Snider
h2. Overview of the user and developer environment
42 69 Erica Snider
43 69 Erica Snider
* [[ The user environment ]] 
44 83 Erica Snider
* [[ The developer environment ]]
45 69 Erica Snider
46 69 Erica Snider
47 69 Erica Snider
48 60 Erica Snider
h2. Working with LArSoft
49 60 Erica Snider
50 80 Erica Snider
  * *[[ Quick-start guide to using and developing LArSoft code ]]*
51 71 Erica Snider
  * [[ LArSoft repositories, packages and dependencies ]]
52 1 Brian Rebel
  * *[[ Special instructions for beta testers ]]*
53 1 Brian Rebel
54 1 Brian Rebel
  * [[larsoftsvn:Using the Framework]]
55 68 Erica Snider
  * "ART Tutorial":http://oink.fnal.gov/
56 68 Erica Snider
  * [[larsoftsvn:NuSoft and LArSoft|nutools and LArSoft]]
57 68 Erica Snider
  * [[Using LArSoft on the GPVM nodes]]
58 1 Brian Rebel
59 1 Brian Rebel
60 1 Brian Rebel
61 68 Erica Snider
62 75 Erica Snider
h2. Links to the tools used to work with the software
63 1 Brian Rebel
64 71 Erica Snider
git and git flow:
65 67 Erica Snider
* [[cet-is-public:git flow quick start]] (edited 2/4/2013).
66 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.
67 1 Brian Rebel
68 72 Erica Snider
Understanding CMakeLists.txt and product_deps files
69 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
70 71 Erica Snider
* [[cet-is-public:Art cmake modules]]: such as @art_make@ and @simple_plugin@. Used in @CMakeLists.txt@ files throughout LArSoft
71 71 Erica Snider
* [[cet-is-public:Defining products in the CET build environment]]: explains the @product_deps@ file
72 71 Erica Snider
* [[cet-is-public:AddingProductDependencies|Adding Product Dependencies]]: how to edit the @product_deps@ and @CMakeLists.txt@ files to add dependencies
73 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
74 71 Erica Snider
* [[cet-is-public:Building your own code with cmake]]:  pointer to a _really_ simple example
75 67 Erica Snider
76 71 Erica Snider
mrb and ups:
77 32 Erica Snider
*  mrb : the multi-repository build tool
78 1 Brian Rebel
*  Re-locatable ups
79 72 Erica Snider
* [[cet-is-public:AboutQualifiers|About qualifiers]]:  the things after "-q" in setup <prod> <ver> -q <qual>
80 33 Erica Snider
81 33 Erica Snider
82 45 Erica Snider
h1. How-to's
83 33 Erica Snider
84 33 Erica Snider
85 33 Erica Snider
h2. Advanced technical how-to's
86 33 Erica Snider
87 33 Erica Snider
h2. Release procedures
88 1 Brian Rebel
89 1 Brian Rebel
h1. Walk-through exercises
90 1 Brian Rebel
91 75 Erica Snider
h1. LArSoft code management and distribution
92 75 Erica Snider
93 75 Erica Snider
* [[Admin scripts]]
94 75 Erica Snider
* [[Procedure to create a new version of larsoft_data]]
95 76 Erica Snider
* [[Installation procedures]]
96 76 Erica Snider
* [[Release notes template]]
97 33 Erica Snider
98 51 Erica Snider
h1. Working areas
99 34 Erica Snider
100 34 Erica Snider
[[Beta re-factoring]]
101 71 Erica Snider
102 1 Brian Rebel
[[ Detailed documentation on using and developing LArSoft code ]] : not a resource
103 1 Brian Rebel
104 1 Brian Rebel
[[ Production transition checklist ]]
105 1 Brian Rebel
106 1 Brian Rebel
[[ Draft quick start revisions ]]
107 88 Erica Snider
108 101 Erica Snider
Old pages:
109 101 Erica Snider
110 99 Erica Snider
* *Beta testers:  [[ Special instructions for beta testers | read this first ]]*
111 101 Erica Snider
*[[LArSoft production transition timeline|Timeline for the production migration to git / mrb / ups]]*