Project

General

Profile

Planning for the split » History » Version 1

Lynn Garren, 01/09/2020 11:47 AM

1 1 Lynn Garren
h1. Planning for the split
2 1 Lynn Garren
3 1 Lynn Garren
NuTools is shared by both LArSoft and NOvA. It contains a number of utilities and interfaces to event generators. Since NOvA and LArSoft often use different releases of the event generators, and also different releases of art, it becomes complicated to keep everything up to date.  We think the time has come to revisit NuTools and provide the fuctionality in separately maintained packages.   A committe of interested parties from NOvA and LArSoft met May 23 to discuss options.
4 1 Lynn Garren
5 1 Lynn Garren
h2. The current compontents of nutools are:
6 1 Lynn Garren
7 1 Lynn Garren
* EventDisplayBase
8 1 Lynn Garren
* EventGeneratorBase
9 1 Lynn Garren
** CRY
10 1 Lynn Garren
** GENIE
11 1 Lynn Garren
** GiBUU
12 1 Lynn Garren
** GeneratedEventTimestamp_plugin
13 1 Lynn Garren
* G4Base
14 1 Lynn Garren
* G4NuPhysicsLists
15 1 Lynn Garren
* IFDatabase
16 1 Lynn Garren
* MagneticField
17 1 Lynn Garren
* NuBeamWeights
18 1 Lynn Garren
* NuReweight
19 1 Lynn Garren
* ParticleNavigation
20 1 Lynn Garren
* RandomUtils
21 1 Lynn Garren
22 1 Lynn Garren
h2. Plans
23 1 Lynn Garren
24 1 Lynn Garren
h3.  To be dropped
25 1 Lynn Garren
26 1 Lynn Garren
The funtionality of G4NuPhysicsLists is now in geant4.  We believe that G4NuPhysicsLists can be dropped.
27 1 Lynn Garren
28 1 Lynn Garren
NuBeamWeights contains NuMI SKZP flux weighting and is considered obsolete.  It will be dropped.
29 1 Lynn Garren
30 1 Lynn Garren
h3. CRY
31 1 Lynn Garren
32 1 Lynn Garren
Both LArSoft and NOvA use CRY.  The CRY interface remains as the sole component of nutools.
33 1 Lynn Garren
34 1 Lynn Garren
h3. nurandom
35 1 Lynn Garren
36 1 Lynn Garren
RandomUtils is unused by NOvA.  It will be split out into nurandom and distributed with larsoft.
37 1 Lynn Garren
38 1 Lynn Garren
h3. nug4
39 1 Lynn Garren
40 1 Lynn Garren
G4Base, MagneticField, and ParticleNavigation will move into nug4.
41 1 Lynn Garren
42 1 Lynn Garren
h3. nuevdb
43 1 Lynn Garren
44 1 Lynn Garren
EventDisplayBase will be split out into nuevdb.  It will continue to be owned by NOvA.  LArSoft also uses EventDisplayBase, but hopes to move to another event display at some point.  There is speculation that NOvA and LArSoft might prefer to maintain separate copies in their own code base.
45 1 Lynn Garren
46 1 Lynn Garren
We believe that IFDatabase can be deprecated.  However, there is some entanglement with EventDisplayBase to be sorted out.
47 1 Lynn Garren
48 1 Lynn Garren
h3. nugen
49 1 Lynn Garren
50 1 Lynn Garren
EventGeneratorBase and NuReweight will be split out into nugen.  The CRY interface will not be part of nugen.
51 1 Lynn Garren
52 1 Lynn Garren
This will also be the home for the larsim and NOvA genieGen_modules.  The modules are nearly the same but have two different pot datastructures.  The new genieGen module will support both datastructures.  Details TBD.
53 1 Lynn Garren
54 1 Lynn Garren
h2. Impact
55 1 Lynn Garren
56 1 Lynn Garren
* The first component of library names will change
57 1 Lynn Garren
* Header paths will change
58 1 Lynn Garren
* Migration scripts will be maintained in nutools.  
59 1 Lynn Garren
* At the point where nutools ceases to exist, the migration scripts will also be available in larsoft.
60 1 Lynn Garren
61 1 Lynn Garren
62 1 Lynn Garren
h2. Timeline
63 1 Lynn Garren
64 1 Lynn Garren
* Work will begin immediately.
65 1 Lynn Garren
* This will be an iterative process.
66 1 Lynn Garren
* We will start with one or two easy steps in the first release.
67 1 Lynn Garren
* With the release of nutools v3_03_00, only EventGeneratorBase/CRY remains in nutools.