Project

General

Profile

Old LArSoftWiki » History » Version 86

Erica Snider, 01/03/2014 05:56 PM

1 54 Erica Snider
If you are looking for the legacy cvs-based LArSoft site that was previously hosted on this site, note that *all content has been moved to "LArSoft cvs (legacy site) ":https://cdcvs.fnal.gov/redmine/projects/larsoft-cvs/wiki.*
2 54 Erica Snider
If you are looking for the legacy svn-based LArSoft site, "go here":https://cdcvs.fnal.gov/redmine/projects/larsoftsvn/wiki. 
3 1 Brian Rebel
---------------------------------------------------------------
4 1 Brian Rebel
5 54 Erica Snider
{{>toc}}
6 1 Brian Rebel
7 1 Brian Rebel
This is the beta LArSoft redmine project and the future home of the LArSoft redmine project.
8 29 Erica Snider
9 54 Erica Snider
h1. LArSoftWiki (beta)
10 1 Brian Rebel
11 54 Erica Snider
*This page is in beta and content is still under construction.*  Will go live when the migration to git/cmake is completed.
12 31 Erica Snider
13 1 Brian Rebel
14 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.
15 1 Brian Rebel
16 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.
17 1 Brian Rebel
18 1 Brian Rebel
19 54 Erica Snider
h1. Preliminaries
20 35 Erica Snider
21 64 Erica Snider
* *Beta testers:  [[ Special instructions for beta testers | read this first ]]*
22 73 Erica Snider
* Fermilab computing accounts:  see the [[larsoftsvn:Fermilab Computing Access]] page if you need an account.
23 54 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.).
24 73 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.
25 82 Erica Snider
* *[[ Supported platforms ]]*
26 1 Brian Rebel
27 35 Erica Snider
h2. Where to find the software
28 65 Erica Snider
29 65 Erica Snider
* [[ The Fermilab core LArSoft installation ]]
30 65 Erica Snider
* [[ Experiment-specific code and re-factoring ]]
31 85 Erica Snider
* [[ LArSoft repositories, packages and dependencies | What are the repository names and what is in them?]]
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 1 Brian Rebel
| *Release* | *Date* | *Purpose* | *Changes / notes* | *Full release notes* |
40 42 Erica Snider
| v1.00.00| Jan 2014 | First production 
41 42 Erica Snider
                       release | Replica of final svn-based release. Future LArSoft development 
42 42 Erica Snider
                                 proceeds from this release. | xxx |
43 79 Erica Snider
| v0.02.01| 12/17/2013| "beta" public release | Beta suitable for general user testing.
44 78 Erica Snider
                                                Based on 11/25/2013 snapshot | [[Release Notes 0.02.01]] |
45 75 Erica Snider
| v0.02.00| 12/10/2013| "beta" public release | Beta suitable for general user testing.
46 75 Erica Snider
                                                Problems found in initial testing require
47 75 Erica Snider
                                                a new release. Based on 11/25/2013 snapshot. | N/A |
48 52 Erica Snider
| v0.01.01| 12/02/2013| "beta" limited release | Beta suitable for expert testing | N/A |
49 35 Erica Snider
| v0.00.09| 11/25/2013| "beta" pre-release | Second full release under new system. First full re-factoring
50 35 Erica Snider
                                       of experiment-specific and core LArSoft code in the larcore,
51 35 Erica Snider
                                       lardata, larevt, and larsim products. Preparation for expert
52 35 Erica Snider
                                       user testing of beta release.| N/A|
53 42 Erica Snider
| v0.00.04| 9/15/2013| "alpha" release | First release of git/cmake/ups-based LArSoft products
54 42 Erica Snider
                                       Used for mrb, configuration and re-factoring
55 1 Brian Rebel
                                       development and testing | N/A |
56 79 Erica Snider
57 79 Erica Snider
Beta version of lbnecode (not installed -- version number is the value in product_deps)
58 79 Erica Snider
| *Version* | *Date* | *Purpose* |
59 79 Erica Snider
| v0.01.00  | 12/17/2013 | Beta for larsoft v0.02.01 |
60 79 Erica Snider
| v0.00.02  | 12/10/2013 | Beta for larsoft v0.02.00 |
61 79 Erica Snider
62 79 Erica Snider
Beta version of uboonecode (not installed -- version number is the value in product_deps)
63 79 Erica Snider
| *Version* | *Date* | *Purpose* |
64 79 Erica Snider
| v0.01.00  | 12/17/2013 | Beta for larsoft v0.02.01 |
65 79 Erica Snider
| v0.00.02  | 12/10/2013 | Beta for larsoft v0.02.00 |
66 33 Erica Snider
67 1 Brian Rebel
h1. Documentation
68 32 Erica Snider
69 69 Erica Snider
h2. Overview of the user and developer environment
70 69 Erica Snider
71 69 Erica Snider
* [[ The user environment ]] 
72 83 Erica Snider
* [[ The developer environment ]]
73 69 Erica Snider
74 69 Erica Snider
75 69 Erica Snider
76 60 Erica Snider
h2. Working with LArSoft
77 60 Erica Snider
78 80 Erica Snider
  * *[[ Quick-start guide to using and developing LArSoft code ]]*
79 71 Erica Snider
  * [[ LArSoft repositories, packages and dependencies ]]
80 1 Brian Rebel
  * *[[ Special instructions for beta testers ]]*
81 1 Brian Rebel
82 1 Brian Rebel
  * [[larsoftsvn:Using the Framework]]
83 68 Erica Snider
  * "ART Tutorial":http://oink.fnal.gov/
84 68 Erica Snider
  * [[larsoftsvn:NuSoft and LArSoft|nutools and LArSoft]]
85 68 Erica Snider
  * [[Using LArSoft on the GPVM nodes]]
86 1 Brian Rebel
87 1 Brian Rebel
88 1 Brian Rebel
89 68 Erica Snider
90 75 Erica Snider
h2. Links to the tools used to work with the software
91 1 Brian Rebel
92 71 Erica Snider
git and git flow:
93 67 Erica Snider
* [[cet-is-public:git flow quick start]] (edited 2/4/2013).
94 67 Erica Snider
* [[cet-is-public:Marc's suggested git workflow]]
95 1 Brian Rebel
* [[cet-is-public:GitTipsAndTricks|Git Tips and Tricks]]
96 1 Brian Rebel
97 72 Erica Snider
Understanding CMakeLists.txt and product_deps files
98 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
99 71 Erica Snider
* [[cet-is-public:Art cmake modules]]: such as @art_make@ and @simple_plugin@. Used in @CMakeLists.txt@ files throughout LArSoft
100 71 Erica Snider
* [[cet-is-public:Defining products in the CET build environment]]: explains the @product_deps@ file
101 71 Erica Snider
* [[cet-is-public:AddingProductDependencies|Adding Product Dependencies]]: how to edit the @product_deps@ and @CMakeLists.txt@ files to add dependencies
102 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
103 71 Erica Snider
* [[cet-is-public:Building your own code with cmake]]:  pointer to a _really_ simple example
104 67 Erica Snider
105 71 Erica Snider
mrb and ups:
106 32 Erica Snider
*  mrb : the multi-repository build tool
107 1 Brian Rebel
*  Re-locatable ups
108 72 Erica Snider
* [[cet-is-public:AboutQualifiers|About qualifiers]]:  the things after "-q" in setup <prod> <ver> -q <qual>
109 33 Erica Snider
110 33 Erica Snider
111 45 Erica Snider
h1. How-to's
112 33 Erica Snider
113 33 Erica Snider
114 33 Erica Snider
h2. Advanced technical how-to's
115 33 Erica Snider
116 33 Erica Snider
h2. Release procedures
117 1 Brian Rebel
118 1 Brian Rebel
h1. Walk-through exercises
119 1 Brian Rebel
120 75 Erica Snider
h1. LArSoft code management and distribution
121 75 Erica Snider
122 75 Erica Snider
* [[Admin scripts]]
123 75 Erica Snider
* [[Procedure to create a new version of larsoft_data]]
124 76 Erica Snider
* [[Installation procedures]]
125 76 Erica Snider
* [[Release notes template]]
126 33 Erica Snider
127 51 Erica Snider
h1. Working areas
128 34 Erica Snider
129 34 Erica Snider
[[Beta re-factoring]]
130 71 Erica Snider
131 71 Erica Snider
[[ Detailed documentation on using and developing LArSoft code ]] : not a resource