Project

General

Profile

Old LArSoftWiki » History » Version 97

Erica Snider, 01/16/2014 11:22 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 54 Erica Snider
h1. LArSoftWiki (beta)
7 1 Brian Rebel
8 93 Erica Snider
*This page is in beta and content is still under construction.*  
9 93 Erica Snider
Will go live on Jan 21, 2014 at the start of the production migration to git / mrb / ups.
10 1 Brian Rebel
11 93 Erica Snider
*[[LArSoft production transition timeline|Timeline for the production migration to git / mrb / ups]]*
12 93 Erica Snider
13 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.
14 92 Erica Snider
15 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.
16 92 Erica Snider
17 92 Erica Snider
18 1 Brian Rebel
h1. Preliminaries
19 54 Erica Snider
20 35 Erica Snider
* *Beta testers:  [[ Special instructions for beta testers | read this first ]]*
21 64 Erica Snider
* Fermilab computing accounts:  see the [[larsoftsvn:Fermilab Computing Access]] page if you need an account.
22 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.).
23 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.
24 73 Erica Snider
* *[[ Supported platforms ]]*
25 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
26 1 Brian Rebel
27 35 Erica Snider
h2. Where to find the software
28 65 Erica Snider
29 91 Erica Snider
* [[ LArSoft repositories, packages and dependencies | What are the repository names and what is in them?]]
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 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
  * *[[ Special instructions for beta testers ]]*
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 67 Erica Snider
* [[cet-is-public:Marc's suggested git workflow]]
70 1 Brian Rebel
* [[cet-is-public:GitTipsAndTricks|Git Tips and Tricks]]
71 1 Brian Rebel
72 72 Erica Snider
Understanding CMakeLists.txt and product_deps files
73 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
74 71 Erica Snider
* [[cet-is-public:Art cmake modules]]: such as @art_make@ and @simple_plugin@. Used in @CMakeLists.txt@ files throughout LArSoft
75 71 Erica Snider
* [[cet-is-public:Defining products in the CET build environment]]: explains the @product_deps@ file
76 71 Erica Snider
* [[cet-is-public:AddingProductDependencies|Adding Product Dependencies]]: how to edit the @product_deps@ and @CMakeLists.txt@ files to add dependencies
77 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
78 71 Erica Snider
* [[cet-is-public:Building your own code with cmake]]:  pointer to a _really_ simple example
79 67 Erica Snider
80 71 Erica Snider
mrb and ups:
81 32 Erica Snider
*  mrb : the multi-repository build tool
82 1 Brian Rebel
*  Re-locatable ups
83 72 Erica Snider
* [[cet-is-public:AboutQualifiers|About qualifiers]]:  the things after "-q" in setup <prod> <ver> -q <qual>
84 33 Erica Snider
85 33 Erica Snider
86 45 Erica Snider
h1. How-to's
87 33 Erica Snider
88 33 Erica Snider
89 33 Erica Snider
h2. Advanced technical how-to's
90 33 Erica Snider
91 33 Erica Snider
h2. Release procedures
92 1 Brian Rebel
93 1 Brian Rebel
h1. Walk-through exercises
94 1 Brian Rebel
95 75 Erica Snider
h1. LArSoft code management and distribution
96 75 Erica Snider
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 88 Erica Snider
108 88 Erica Snider
[[ Production transition checklist ]]
109 96 Erica Snider
110 96 Erica Snider
[[ Draft quick start revisions ]]