Skip to content

Commit a72c0d5

Browse files
Merge pull request #317 from AndrewEdmonds11/tut-fixes
Update documentation for new Analysis musings
2 parents 731762b + 1646312 commit a72c0d5

4 files changed

Lines changed: 11 additions & 8 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ In case you need to create your own EventNtuple you can do the following from a
4646

4747
```
4848
mu2einit
49-
muse setup EventNtuple
49+
muse setup [AnalysisMusing]
5050
mu2e -c EventNtuple/fcl/from_mcs-mockdata.fcl -S your-art-filelist.txt
5151
```
52+
where ```[AnalysisMusing]``` is the musing relevant for your dataset. At the time of writing, this is either ```AnalysisMDC2020``` or ```AnalysisMDC2025```
5253

5354
This will create a file called ```nts.owner.description.version.sequencer.root``` that contains the EventNtuple. The EventNtuple will then be in the ROOT file as ```EventNtuple/ntuple```.
5455

@@ -84,10 +85,11 @@ git checkout --no-track -b vXX-YY-ZZ mu2e/main
8485
* create a "before" ntuple with the previous release of EventNtuple. In a fresh login:
8586
```
8687
mu2einit
87-
muse setup EventNtuple vXX_YY_ZZ
88+
muse setup [AnalysisMusing and version]
8889
mu2e -c EventNtuple/fcl/from_mcs-mockdata.fcl -S ../EventNtupleDev_NewTag/filelists/mcs.mu2e.ensembleMDS2cMix1BBTriggered.MDC2020ba_best_v1_3.art.list --TFileName nts.ntuple.before.root -n 100
8990
root -l -b ${MUSE_WORK_DIR}/EventNtuple/validation/create_val_file_rooutil.C\(\"nts.ntuple.before.root\",\"val.ntuple.before.root\"\)
9091
```
92+
* you can get the ```AnalysisMusing``` and ```version``` from the [EventNtuple page on the wiki](https://mu2ewiki.fnal.gov/wiki/EventNtuple#Version_History_%26_Musings)
9193
* create a comparison booklet following these [steps](validation/README.md#Validating-EventNtuple-Contents)
9294
* make sure any differences are understood
9395
* open PR with final changes and merge

doc/ntuplehelper.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ On this page, you will learn how to use the [```ntuplehelper```](../../utils/hel
66

77
You will need to be in either:
88

9-
* an EventNtuple environment, or
9+
* an Analysis environment:
1010

1111
```
1212
mu2einit
13-
muse setup EventNtuple
13+
muse setup [AnalysisMusing]
1414
```
15+
where ```[AnalysisMusing]``` is the musing relevant for your dataset. At the time of writing, this is either ```AnalysisMDC2020``` or ```AnalysisMDC2025```.
1516

16-
* have the EventNtuple repository checked out
17+
* or have the EventNtuple repository checked out
1718

1819
```
1920
git clone https://github.com/Mu2e/EventNtuple.git

tutorial/eventntuple-basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you chose ROOT, do the following:
1717
```
1818
cd /to/a/new/working/area/
1919
mu2einit
20-
muse setup Analysis
20+
muse setup AnalysisMDC2020
2121
```
2222

2323
If you chose python, do the following:
@@ -96,7 +96,7 @@ ntuplehelper branch.*
9696

9797
* in python
9898
```
99-
muse setup Analysis
99+
muse setup AnalysisMDC2020
100100
python
101101
>>> import ntuplehelper
102102
>>> nthelper = ntuplehelper.nthelper()

tutorial/eventntuple-rooutil.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ In this tutorial, you should set up your working area like so:
2828
```
2929
cd /to/a/new/working/area/
3030
mu2einit
31-
muse setup Analysis
31+
muse setup AnalysisMDC2020
3232
```
3333

3434

0 commit comments

Comments
 (0)