Project

General

Profile

Old LArSoftWiki » History » Version 73

Erica Snider, 12/12/2013 04:14 AM

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 1 Brian Rebel
26 35 Erica Snider
h2. Where to find the software
27 65 Erica Snider
28 65 Erica Snider
* [[ The Fermilab core LArSoft installation ]]
29 65 Erica Snider
* [[ Experiment-specific code and re-factoring ]]
30 65 Erica Snider
31 50 Erica Snider
32 50 Erica Snider
33 45 Erica Snider
h1. Release notes
34 1 Brian Rebel
35 1 Brian Rebel
| *Release* | *Date* | *Purpose* | *Changes / notes* | *Full release notes* |
36 42 Erica Snider
| v1.00.00| Jan 2014 | First production 
37 42 Erica Snider
                       release | Replica of final svn-based release. Future LArSoft development 
38 42 Erica Snider
                                 proceeds from this release. | xxx |
39 55 Erica Snider
| v0.0x.yy| 12/10/2013| "beta" public release | Beta suitable for general user testing | N/A |
40 52 Erica Snider
| v0.01.01| 12/02/2013| "beta" limited release | Beta suitable for expert testing | N/A |
41 35 Erica Snider
| v0.00.09| 11/25/2013| "beta" pre-release | Second full release under new system. First full re-factoring
42 35 Erica Snider
                                       of experiment-specific and core LArSoft code in the larcore,
43 35 Erica Snider
                                       lardata, larevt, and larsim products. Preparation for expert
44 35 Erica Snider
                                       user testing of beta release.| N/A|
45 42 Erica Snider
| v0.00.04| 9/15/2013| "alpha" release | First release of git/cmake/ups-based LArSoft products
46 42 Erica Snider
                                       Used for mrb, configuration and re-factoring
47 42 Erica Snider
                                       development and testing | N/A |
48 33 Erica Snider
49 1 Brian Rebel
h1. Documentation
50 32 Erica Snider
51 69 Erica Snider
h2. Overview of the user and developer environment
52 69 Erica Snider
53 69 Erica Snider
* [[ The user environment ]] 
54 70 Erica Snider
* [[ The deveoper environment ]]
55 69 Erica Snider
56 69 Erica Snider
[[Overview of the user and developer environment]]
57 69 Erica Snider
58 69 Erica Snider
59 60 Erica Snider
h2. Working with LArSoft
60 60 Erica Snider
61 1 Brian Rebel
  * [[ Quick-start guide to using and developing LArSoft code ]]
62 71 Erica Snider
  * [[ LArSoft repositories, packages and dependencies ]]
63 1 Brian Rebel
  * *[[ Special instructions for beta testers ]]*
64 1 Brian Rebel
65 1 Brian Rebel
  * [[larsoftsvn:Using the Framework]]
66 68 Erica Snider
  * "ART Tutorial":http://oink.fnal.gov/
67 68 Erica Snider
  * [[larsoftsvn:NuSoft and LArSoft|nutools and LArSoft]]
68 1 Brian Rebel
  * [[Using LArSoft on the GPVM nodes]]
69 68 Erica Snider
70 1 Brian Rebel
71 1 Brian Rebel
72 68 Erica Snider
73 1 Brian Rebel
h2. Links to the tools used in working with the software
74 1 Brian Rebel
75 71 Erica Snider
git and git flow:
76 67 Erica Snider
* [[cet-is-public:git flow quick start]] (edited 2/4/2013).
77 67 Erica Snider
* [[cet-is-public:Marc's suggested git workflow]]
78 1 Brian Rebel
* [[cet-is-public:GitTipsAndTricks|Git Tips and Tricks]]
79 1 Brian Rebel
80 72 Erica Snider
Understanding CMakeLists.txt and product_deps files
81 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
82 71 Erica Snider
* [[cet-is-public:Art cmake modules]]: such as @art_make@ and @simple_plugin@. Used in @CMakeLists.txt@ files throughout LArSoft
83 71 Erica Snider
* [[cet-is-public:Defining products in the CET build environment]]: explains the @product_deps@ file
84 71 Erica Snider
* [[cet-is-public:AddingProductDependencies|Adding Product Dependencies]]: how to edit the @product_deps@ and @CMakeLists.txt@ files to add dependencies
85 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
86 71 Erica Snider
* [[cet-is-public:Building your own code with cmake]]:  pointer to a _really_ simple example
87 67 Erica Snider
88 71 Erica Snider
mrb and ups:
89 32 Erica Snider
*  mrb : the multi-repository build tool
90 1 Brian Rebel
*  Re-locatable ups
91 72 Erica Snider
* [[cet-is-public:AboutQualifiers|About qualifiers]]:  the things after "-q" in setup <prod> <ver> -q <qual>
92 33 Erica Snider
93 33 Erica Snider
94 45 Erica Snider
h1. How-to's
95 33 Erica Snider
96 33 Erica Snider
97 33 Erica Snider
h2. Advanced technical how-to's
98 33 Erica Snider
99 33 Erica Snider
h2. Release procedures
100 33 Erica Snider
101 1 Brian Rebel
h1. Walk-through exercises
102 1 Brian Rebel
103 1 Brian Rebel
h1. LArSoft code management and distribution procedures
104 33 Erica Snider
105 51 Erica Snider
h1. Working areas
106 34 Erica Snider
107 34 Erica Snider
[[Beta re-factoring]]
108 71 Erica Snider
109 71 Erica Snider
[[ Detailed documentation on using and developing LArSoft code ]] : not a resource