Project

General

Profile

Old LArSoftWiki » History » Version 63

Erica Snider, 12/10/2013 07:33 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 54 Erica Snider
* Fermilab computing accounts:  see the instructions on the [[larsoftsvn:Fermilab Computing Access]] page if you need an account.
22 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.).
23 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.
24 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.
25 1 Brian Rebel
26 35 Erica Snider
h2. Where to find the software
27 1 Brian Rebel
28 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>):
29 35 Erica Snider
30 35 Erica Snider
|*Product 
31 35 Erica Snider
repository
32 35 Erica Snider
name* | *repository url (all in Redmine)* | lxr link 
33 35 Erica Snider
                                            (not yet avail) | Redmine browser |
34 49 Erica Snider
|larcore| ssh://p-larcore@cdcvs.fnal.gov/cvs/projects/larcore | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larcore/repository |
35 49 Erica Snider
|lardata| ssh://p-lardata@cdcvs.fnal.gov/cvs/projects/lardata | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/lardata/repository |
36 49 Erica Snider
|larevt | ssh://p-larevt@cdcvs.fnal.gov/cvs/projects/larevt  | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larevt/repository |
37 49 Erica Snider
|larsim | ssh://p-larsim@cdcvs.fnal.gov/cvs/projects/larsim  | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larsim/repository |
38 1 Brian Rebel
|larreco| ssh://p-larreco@cdcvs.fnal.gov/cvs/projects/larreco | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larreco/repository |
39 49 Erica Snider
|larana | ssh://p-larana@cdcvs.fnal.gov/cvs/projects/larana  | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larana/repository |
40 49 Erica Snider
|lareventdisplay| ssh://p-lareventdisplay@cdcvs.fnal.gov/cvs/projects/lareventdisplay | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/lareventdisplay/repository |
41 1 Brian Rebel
|larexamples|     ssh://p-larexamples@cdcvs.fnal.gov/cvs/projects/larexamples     | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/larexamples/repository |
42 49 Erica Snider
|larpandora| ssh://p-larpandora@cdcvs.fnal.gov/cvs/projects/larpandora | -- | "redmine:https://cdcvs.fnal.gov/redmine/projects/larpandora/repository |
43 49 Erica Snider
|larsoft | ssh://p-larsoft@cdcvs.fnal.gov/cvs/projects/larsoft 
44 49 Erica Snider
           (A product used to set up the others with a single command. Contains the "setup" package.) | -- | 
45 49 Erica Snider
           "redmine":https://cdcvs.fnal.gov/redmine/projects/larsoft/repository |
46 1 Brian Rebel
47 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.)
48 1 Brian Rebel
49 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. 
50 35 Erica Snider
51 50 Erica Snider
h3. Re-factoring of experiment-specific software
52 50 Erica Snider
53 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:
54 50 Erica Snider
55 50 Erica Snider
|*Product 
56 50 Erica Snider
repository
57 50 Erica Snider
name* | *repository url (all in Redmine)* | lxr link 
58 50 Erica Snider
                                            (not yet avail) | Redmine browser |
59 50 Erica Snider
|lbnecode| ssh://p-lbnecode@cdcvs.fnal.gov/cvs/projects/lbnecode | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/lbnecode/repository |
60 50 Erica Snider
|uboonecode| ssh://p-uboonecode@cdcvs.fnal.gov/cvs/projects/lardata | -- | "redmine":https://cdcvs.fnal.gov/redmine/projects/uboonecode/repository |
61 50 Erica Snider
62 50 Erica Snider
63 50 Erica Snider
64 35 Erica Snider
65 1 Brian Rebel
66 45 Erica Snider
h1. Release notes
67 1 Brian Rebel
68 1 Brian Rebel
| *Release* | *Date* | *Purpose* | *Changes / notes* | *Full release notes* |
69 42 Erica Snider
| v1.00.00| Jan 2014 | First production 
70 42 Erica Snider
                       release | Replica of final svn-based release. Future LArSoft development 
71 42 Erica Snider
                                 proceeds from this release. | xxx |
72 55 Erica Snider
| v0.0x.yy| 12/10/2013| "beta" public release | Beta suitable for general user testing | N/A |
73 52 Erica Snider
| v0.01.01| 12/02/2013| "beta" limited release | Beta suitable for expert testing | N/A |
74 35 Erica Snider
| v0.00.09| 11/25/2013| "beta" pre-release | Second full release under new system. First full re-factoring
75 35 Erica Snider
                                       of experiment-specific and core LArSoft code in the larcore,
76 35 Erica Snider
                                       lardata, larevt, and larsim products. Preparation for expert
77 35 Erica Snider
                                       user testing of beta release.| N/A|
78 42 Erica Snider
| v0.00.04| 9/15/2013| "alpha" release | First release of git/cmake/ups-based LArSoft products
79 42 Erica Snider
                                       Used for mrb, configuration and re-factoring
80 42 Erica Snider
                                       development and testing | N/A |
81 33 Erica Snider
82 1 Brian Rebel
h1. Documentation
83 32 Erica Snider
84 60 Erica Snider
h2. Working with LArSoft
85 60 Erica Snider
86 60 Erica Snider
  * [[ LArSoft repositories, packages and dependencies ]]
87 62 Erica Snider
  * [[ Quick-start guide to using and developing LArSoft code ]]
88 60 Erica Snider
  * [[ Detailed documentation on using and developing LArSoft code ]]
89 60 Erica Snider
  * *[[ Special instructions for beta testers ]]*
90 60 Erica Snider
91 60 Erica Snider
  * [[larsoftsvn:Using the Framework]]
92 60 Erica Snider
  * "ART Tutorial":http://oink.fnal.gov/
93 60 Erica Snider
  * [[larsoftsvn:NuSoft and LArSoft|nutools and LArSoft]]
94 60 Erica Snider
  * [[Using LArSoft on the GPVM nodes]]
95 60 Erica Snider
96 1 Brian Rebel
97 43 Erica Snider
98 44 Erica Snider
h2. Overview of the user and developer environment
99 43 Erica Snider
100 61 Erica Snider
* [[Overview of the user and developer environment]]
101 61 Erica Snider
102 41 Erica Snider
103 41 Erica Snider
104 45 Erica Snider
h2. Links to the tools used in working with the software
105 32 Erica Snider
106 32 Erica Snider
*  git
107 32 Erica Snider
*  git flow
108 32 Erica Snider
*  mrb : the multi-repository build tool
109 32 Erica Snider
*  Re-locatable ups
110 32 Erica Snider
*  cmake
111 33 Erica Snider
112 33 Erica Snider
113 45 Erica Snider
h1. How-to's
114 33 Erica Snider
115 33 Erica Snider
116 33 Erica Snider
h2. Advanced technical how-to's
117 33 Erica Snider
118 33 Erica Snider
h2. Release procedures
119 33 Erica Snider
120 1 Brian Rebel
h1. Walk-through exercises
121 33 Erica Snider
122 51 Erica Snider
h1. LArSoft code management and distribution procedures
123 34 Erica Snider
124 34 Erica Snider
h1. Working areas
125 34 Erica Snider
126 34 Erica Snider
[[Beta re-factoring]]