Project

General

Profile

Old LArSoftWiki » History » Version 65

Erica Snider, 12/11/2013 03:48 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 54 Erica Snider
* Fermilab computing accounts:  see the instructions on 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 54 Erica Snider
* See the [[LArSoftWiki#documentation|documentation]] section for information on working with/developing LArSoft code, and using git, git flow, mrb and other tools you will need.
25 54 Erica Snider
* The procedures and tools for building and developing software with this system are _completely different_ from those of the previous system based on svn repositories and the SoftRelTools build system. See the [[LArSoftWiki#documentation|documentation]] section for details.
26 1 Brian Rebel
27 35 Erica Snider
h2. Where to find the software
28 1 Brian Rebel
29 65 Erica Snider
* [[ The Fermilab core LArSoft installation ]]
30 65 Erica Snider
31 65 Erica Snider
* [[ Experiment-specific code and re-factoring ]]
32 65 Erica Snider
33 54 Erica Snider
In a standard LArSoft installation, the software is accessed via a set of re-locatable ups products, each of which corresponds to the code within a git repository. Each product and the associated repository contain LArSoft software components (i.e., SoftRelTool "packages") that are within the same layer of functionality. The products and repository read-write urls are the following (read-only access is available via http://cdcvs.fnal.gov/projects/<repo_name>):
34 35 Erica Snider
35 35 Erica Snider
|*Product 
36 35 Erica Snider
repository
37 35 Erica Snider
name* | *repository url (all in Redmine)* | lxr link 
38 35 Erica Snider
                                            (not yet avail) | Redmine browser |
39 49 Erica Snider
|larcore| ssh://p-larcore@cdcvs.fnal.gov/cvs/projects/larcore | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larcore/repository |
40 49 Erica Snider
|lardata| ssh://p-lardata@cdcvs.fnal.gov/cvs/projects/lardata | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/lardata/repository |
41 49 Erica Snider
|larevt | ssh://p-larevt@cdcvs.fnal.gov/cvs/projects/larevt  | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larevt/repository |
42 49 Erica Snider
|larsim | ssh://p-larsim@cdcvs.fnal.gov/cvs/projects/larsim  | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larsim/repository |
43 1 Brian Rebel
|larreco| ssh://p-larreco@cdcvs.fnal.gov/cvs/projects/larreco | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larreco/repository |
44 49 Erica Snider
|larana | ssh://p-larana@cdcvs.fnal.gov/cvs/projects/larana  | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larana/repository |
45 49 Erica Snider
|lareventdisplay| ssh://p-lareventdisplay@cdcvs.fnal.gov/cvs/projects/lareventdisplay | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/lareventdisplay/repository |
46 1 Brian Rebel
|larexamples|     ssh://p-larexamples@cdcvs.fnal.gov/cvs/projects/larexamples     | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larexamples/repository |
47 49 Erica Snider
|larpandora| ssh://p-larpandora@cdcvs.fnal.gov/cvs/projects/larpandora | -- | "redmine:https://cdcvs.fnal.gov/redmine/projects/larpandora/repository |
48 49 Erica Snider
|larsoft | ssh://p-larsoft@cdcvs.fnal.gov/cvs/projects/larsoft 
49 49 Erica Snider
           (A product used to set up the others with a single command. Contains the "setup" package.) | -- | 
50 49 Erica Snider
           "redmine":https://cdcvs.fnal.gov/redmine/projects/larsoft/repository |
51 1 Brian Rebel
52 36 Erica Snider
(The SoftRelTools-based packages in each product/repository can be found "here":https://cdcvs.fnal.gov/redmine/projects/larsoft-alpha/wiki/LarSoft_Product_List along with the approximate order of dependency.)
53 1 Brian Rebel
54 55 Erica Snider
Although you can use @git clone <repository url>@ to download a copy of each repository to your local area, additional steps are needed to use, build or develop the software. See the [[LArSoftWiki#documentation|documentation]] section below for details. 
55 35 Erica Snider
56 50 Erica Snider
h3. Re-factoring of experiment-specific software
57 50 Erica Snider
58 55 Erica Snider
Most experiment-specific code, fcl and gdml files have been removed from the @larcore@, @lardata@, @larevt@ and @larsim@ repositories and moved into beta versions of experiment-specific git repositories. (One exception to this statement is that the @DetId_t@ enum type, which effectively maps detector name strings to integers, remains in core LArSoft, pending migration to a new, string-based mechanism for storing and using this information. Other exceptions include fcl files that were not identified during the initial migration.) The beta versions of experiment-specific repositories are the following:
59 50 Erica Snider
60 50 Erica Snider
|*Product 
61 50 Erica Snider
repository
62 50 Erica Snider
name* | *repository url (all in Redmine)* | lxr link 
63 50 Erica Snider
                                            (not yet avail) | Redmine browser |
64 50 Erica Snider
|lbnecode| ssh://p-lbnecode@cdcvs.fnal.gov/cvs/projects/lbnecode | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/lbnecode/repository |
65 50 Erica Snider
|uboonecode| ssh://p-uboonecode@cdcvs.fnal.gov/cvs/projects/lardata | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/uboonecode/repository |
66 50 Erica Snider
67 50 Erica Snider
68 50 Erica Snider
69 35 Erica Snider
70 1 Brian Rebel
71 45 Erica Snider
h1. Release notes
72 1 Brian Rebel
73 1 Brian Rebel
| *Release* | *Date* | *Purpose* | *Changes / notes* | *Full release notes* |
74 42 Erica Snider
| v1.00.00| Jan 2014 | First production 
75 42 Erica Snider
                       release | Replica of final svn-based release. Future LArSoft development 
76 42 Erica Snider
                                 proceeds from this release. | xxx |
77 55 Erica Snider
| v0.0x.yy| 12/10/2013| "beta" public release | Beta suitable for general user testing | N/A |
78 52 Erica Snider
| v0.01.01| 12/02/2013| "beta" limited release | Beta suitable for expert testing | N/A |
79 35 Erica Snider
| v0.00.09| 11/25/2013| "beta" pre-release | Second full release under new system. First full re-factoring
80 35 Erica Snider
                                       of experiment-specific and core LArSoft code in the larcore,
81 35 Erica Snider
                                       lardata, larevt, and larsim products. Preparation for expert
82 35 Erica Snider
                                       user testing of beta release.| N/A|
83 42 Erica Snider
| v0.00.04| 9/15/2013| "alpha" release | First release of git/cmake/ups-based LArSoft products
84 42 Erica Snider
                                       Used for mrb, configuration and re-factoring
85 42 Erica Snider
                                       development and testing | N/A |
86 33 Erica Snider
87 1 Brian Rebel
h1. Documentation
88 32 Erica Snider
89 60 Erica Snider
h2. Working with LArSoft
90 60 Erica Snider
91 60 Erica Snider
  * [[ LArSoft repositories, packages and dependencies ]]
92 62 Erica Snider
  * [[ Quick-start guide to using and developing LArSoft code ]]
93 60 Erica Snider
  * [[ Detailed documentation on using and developing LArSoft code ]]
94 60 Erica Snider
  * *[[ Special instructions for beta testers ]]*
95 60 Erica Snider
96 60 Erica Snider
  * [[larsoftsvn:Using the Framework]]
97 60 Erica Snider
  * "ART Tutorial":http://oink.fnal.gov/
98 60 Erica Snider
  * [[larsoftsvn:NuSoft and LArSoft|nutools and LArSoft]]
99 60 Erica Snider
  * [[Using LArSoft on the GPVM nodes]]
100 60 Erica Snider
101 1 Brian Rebel
102 43 Erica Snider
103 44 Erica Snider
h2. Overview of the user and developer environment
104 43 Erica Snider
105 61 Erica Snider
* [[Overview of the user and developer environment]]
106 61 Erica Snider
107 41 Erica Snider
108 41 Erica Snider
109 45 Erica Snider
h2. Links to the tools used in working with the software
110 32 Erica Snider
111 32 Erica Snider
*  git
112 32 Erica Snider
*  git flow
113 32 Erica Snider
*  mrb : the multi-repository build tool
114 32 Erica Snider
*  Re-locatable ups
115 32 Erica Snider
*  cmake
116 33 Erica Snider
117 33 Erica Snider
118 45 Erica Snider
h1. How-to's
119 33 Erica Snider
120 33 Erica Snider
121 33 Erica Snider
h2. Advanced technical how-to's
122 33 Erica Snider
123 33 Erica Snider
h2. Release procedures
124 33 Erica Snider
125 1 Brian Rebel
h1. Walk-through exercises
126 33 Erica Snider
127 51 Erica Snider
h1. LArSoft code management and distribution procedures
128 34 Erica Snider
129 34 Erica Snider
h1. Working areas
130 34 Erica Snider
131 34 Erica Snider
[[Beta re-factoring]]