Difference between revisions of "Mu2e Offline Tutorial"

From Mu2eWiki
Jump to navigation Jump to search
 
(26 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
This tutorial will show you how to work within the Mu2e Offline computing
 
This tutorial will show you how to work within the Mu2e Offline computing
 
environment.
 
environment.
 +
 +
== Docker vs the Mu2e Interactive Machines==
 +
 +
During the tutorial day in Minneapolis, most of you will do the tutorial exercises from within a Docker container on your own laptop.  Much of the documentation linked below was written for people doing essentially the same activities when logged into the Mu2e interactive machines.  The following link describes the correspondence between the Docker environment and the environment found on the Mu2e interactive machines.
 +
 +
*[[Docker_vs_mu2egpvm]]
  
 
== Session Prerequisites and  Advance Preparation ==
 
== Session Prerequisites and  Advance Preparation ==
−
This tutorial may require attendees to have already completed other tutorials, and may
+
Look through the [[ComputingTutorials | Getting Started]] wiki page.  Not
−
require special preparations on their laptop. Prerequisites and advanced preparations should be listed at the top of the session,
+
all of those links are live.
−
together with links.  Examples might be:
+
*[[LoginTutorial]]
−
* Perform the tutorial on running Mu2e art Framework jobs [[Tutorial_2019_June:Framework_jobs]]  
+
This provides a tour the interactive machines, authentication, and disks. You do not need the docker image, but you do need to log onto the central Mu2e interactive machines.
−
* Read the [https://root.cern.ch/root/htmldoc/guides/users-guide/ROOTUsersGuide.html#fitting-histograms root documentation on histogram fitting]
+
 
−
* Download and install [https://root.cern.ch/downloading-root root] (v6.14 or later) on your machine
+
==Last Minute Check==
−
* Run the [https://root.cern.ch/doc/master/combinedFit_8C.html root combined fit tutorial]
+
 
−
* Install the following docker containers ()
+
When you are ready to get starting with the Tutorial, please check:
 +
<ol>
 +
<li> Have you installed the [[Tutorial_2019_June#LatestVersion | latest docker image]]? To do this give the command:
 +
<pre>
 +
docker images
 +
</pre>
 +
which will show all available docker images.
 +
<li> Have you configured your laptop so that there is disk space that you can see both inside the docker image and from the host OS?
 +
<li> Can you display windows launched from within the docker container on your laptop screen?
 +
<li> Have you chosen an editor and figured out how to edit files for use in the docker container?  Within the docker image, the only editors available are emacs and vi. If you have solved item 2, then you can edit files in the native OS for use inside the docker image; in this case, use your preferred editor from the host OS.
 +
</ol>
 +
 
 +
If the answer to any of the first 3 is "no", then check the [https://mu2ewiki.fnal.gov/wiki/Tutorial_2019_June#Before_your_arrive_in_Minnesota Before You Arrive in Minnesota] section of the
 +
[https://mu2ewiki.fnal.gov/wiki/Tutorial_2019_June June 2019 tutorial wiki home page]; or ask one of the tutorial helpers.
 +
 
 +
If the answer to the last questions is "no" then talk to one of the tutorial helpers.
 +
 
 
== Session Introduction ==
 
== Session Introduction ==
−
* Plan on spending 5 minutes in the beginning making sure everyone has fulfilled the prerequisites and has performed the advance preparation.
+
Mu2e Offline is a collection of code and scripts used for simulation, reconstruction and analysis of Mu2e data.
−
* If necessary, present a brief (~5 minutes) overview on goals, background information, and context. Make sure to link the slides to the session page.
+
Offline is kept in a git repository.  It depends on external software provided through cvmfs (Cern virtual machine file system).
 +
Users interact with Offline in several ways, with more or less of the code resident in your local working area.  
 +
to link the slides to the session page. This tutorial will cover the basic structure of Offline,
 +
and show you how to create the local environment to work with Offline.
 +
 
 +
This session also covers a second topic, how to browse the Mu2e Geometry.
 +
 
 +
Please work through these two sets of tutorial materials:
 +
* [[CheckoutAndBuildCodeTutorial]]:  an introduction to offline code checkout and build.
 +
* [[GeometryBrowserTutorial2019]]: learn to browse the Mu2e Geometry
  
−
== Exercises ==
 
−
The majority of the session time should be spent performing exercises, which you link or embed in the session page.
 
−
* Each exercise should have a title; ie ''Create a histogram of the reconstructed Ce momentum''
 
−
* Exercises may be chained (ie the output of the first is used as input to the next), but in that case make sure the output is also part of the downloads, so people who failed at step 1 can continue with the subsequent steps.  Design this so that a failed step 1 does not overwrite the downloaded file that is the input to step 2.
 
−
* Some steps may take considerable processing time.  In that case, have your attendees perform a short version (ie process 10 events), and provide the full output (ie histograms from 10^5 events) as part of the session download for subsequent steps.
 
−
* Each exercise should take between 5 and 15 minutes to complete.  Count on your attendees taking twice as much time as would an experienced person.
 
−
* Start each exercise by bringing the exercise up on the main screen and going through its intro.
 
−
* Perform each step of the exercise on the screen, describing any decisions or issues involved as you do it.  Check with your audience to make sure most (preferably all) have finished each step before going on to the next.  If someone seems stuck, assign a session helper to help them individually and move on.
 
−
* It's OK to provide more exercises than most people will complete during the tutorial; they can be completed as homework.
 
−
== Session Organization Guideline ==
 
−
* Encourage your attendees to ask questions if they are unsure what to do.
 
−
* You may or may not have session helpers, who have already performed the tutorial
 
−
* If someone finishes a step or exercise early, have them look around for neighbors that need help.
 
−
* If someone is stuck, have them raise their hand to get help.
 
 
== Reference Materials ==
 
== Reference Materials ==
−
* Use this place to add inks to reference materials.
+
 
 +
* [https://art.fnal.gov/art-workbook/ art workbook]
 +
 
 +
[[Category:Computing]]
 +
[[Category:Tutorial]]

Latest revision as of 14:26, 24 June 2019

Tutorial Session Goal

This tutorial will show you how to work within the Mu2e Offline computing environment.

Docker vs the Mu2e Interactive Machines

During the tutorial day in Minneapolis, most of you will do the tutorial exercises from within a Docker container on your own laptop. Much of the documentation linked below was written for people doing essentially the same activities when logged into the Mu2e interactive machines. The following link describes the correspondence between the Docker environment and the environment found on the Mu2e interactive machines.

Session Prerequisites and Advance Preparation

Look through the Getting Started wiki page. Not all of those links are live.

This provides a tour the interactive machines, authentication, and disks. You do not need the docker image, but you do need to log onto the central Mu2e interactive machines.

Last Minute Check

When you are ready to get starting with the Tutorial, please check:

  1. Have you installed the latest docker image? To do this give the command: 
    docker images

    which will show all available docker images.

  2. Have you configured your laptop so that there is disk space that you can see both inside the docker image and from the host OS?
  3. Can you display windows launched from within the docker container on your laptop screen?
  4. Have you chosen an editor and figured out how to edit files for use in the docker container? Within the docker image, the only editors available are emacs and vi. If you have solved item 2, then you can edit files in the native OS for use inside the docker image; in this case, use your preferred editor from the host OS.

If the answer to any of the first 3 is "no", then check the Before You Arrive in Minnesota section of the June 2019 tutorial wiki home page; or ask one of the tutorial helpers.

If the answer to the last questions is "no" then talk to one of the tutorial helpers.

Session Introduction

Mu2e Offline is a collection of code and scripts used for simulation, reconstruction and analysis of Mu2e data. Offline is kept in a git repository. It depends on external software provided through cvmfs (Cern virtual machine file system). Users interact with Offline in several ways, with more or less of the code resident in your local working area. to link the slides to the session page. This tutorial will cover the basic structure of Offline, and show you how to create the local environment to work with Offline.

This session also covers a second topic, how to browse the Mu2e Geometry.

Please work through these two sets of tutorial materials:

Reference Materials

Retrieved from "http://mu2ewiki.fnal.gov/w/index.php?title=Mu2e_Offline_Tutorial&oldid=13745"