Difference between revisions of "Mu2e Offline Tutorial"
| (23 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 | + | Look through the [[ComputingTutorials | Getting Started]] wiki page. Not |
| − | + | all of those links are live. | |
| − | + | *[[LoginTutorial]] | |
| − | + | 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: | |
| + | <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 == | ||
| − | + | 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: | |
| − | + | * [[CheckoutAndBuildCodeTutorial]]: an introduction to offline code checkout and build. | |
| − | + | * [[GeometryBrowserTutorial2019]]: learn to browse the Mu2e Geometry | |
| − | |||
| − | |||
| − | * | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | * | ||
| − | |||
| − | |||
| − | |||
== Reference Materials == | == 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:
- Have you installed the latest docker image? To do this give the command:
docker images
which will show all available docker images.
- 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?
- Can you display windows launched from within the docker container on your laptop screen?
- 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:
- CheckoutAndBuildCodeTutorial: an introduction to offline code checkout and build.
- GeometryBrowserTutorial2019: learn to browse the Mu2e Geometry