CodeEnvironment: Difference between revisions

From Mu2eWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
This page reviews the management of the Mu2e bash shell environment for building code, running executables, or submitting jobs.


==Introduction==
Creating an environment in which you can build and run Mu2e code is a three step process that stars with a clean shell:


This page explains the initial steps to preparing the linux shell environment for building code, running executables, or submitting jobs.
# Create the recommended login scripts; see[[Shells#Setup_scripts]]
# Issue the command <code> setup mu2e </code>; see[[LoginTutorial#Check_setup_mu2e]]
# One or more of:
#* muse setup
#* setup mu2egrid
#* setup sam_web_client
#* and many more


==Mu2e environment==
You will encounter several different versions of the items in 3 as you work through the tutorials.
 
Please refer to the [[Shells]] pages to setup your bash login scripts.  This page assumes you have followed the recommendations there, in particular, you have placed
source /cvmfs/fermilab.opensciencegrid.org/products/common/etc/setups.sh
in your <code>.bash_profile</code>
 
After logging in you should be able to
setup mu2e
If you see any errors, you probably do not have the above condition met.
 
The <code>setup mu2e</code> command executes a [[UPS]] procedure to alter your environment.  In particular this command:
<ol>
<li>sets variable environmental variables such as</li>
MU2E_DATA_PATH
<li>sets your product path (where UPS can find more UPS products) to</li>
/cvmfs/mu2e.opensciencegrid.org/artexternals
/cvmfs/fermilab.opensciencegrid.org/products/common/db
<li>does a UPS setups of a version of [[GitIntro|git]]</li>
<li>does a UPS setup of a version of [[Muse]]</li>
</ol>
 
At this point, you are ready start selecting which Mu2e code to build or run. Please continue with the [[ComputingTutorials]] or jump into the [[Code]] references.
 
==Another way==
From time to time, you might see the instruction
source /cvmfs/mu2e.opensciencegrid.org/setupmu2e-art
this a equivalent to
setup mu2e
but we recommend the latter.


If you are an expert who has chosen to not setup UPS in their login scripts, steps 1 and two are merged together as described in [[Shells#Expert_Only]].


[[Category:Computing]]
[[Category:Computing]]
[[Category:Code]]
[[Category:Code]]
[[Category:Tutorial]]
[[Category:Tutorial]]

Revision as of 04:07, 4 October 2023

This page reviews the management of the Mu2e bash shell environment for building code, running executables, or submitting jobs.

Creating an environment in which you can build and run Mu2e code is a three step process that stars with a clean shell:

  1. Create the recommended login scripts; seeShells#Setup_scripts
  2. Issue the command setup mu2e ; seeLoginTutorial#Check_setup_mu2e
  3. One or more of:
    • muse setup
    • setup mu2egrid
    • setup sam_web_client
    • and many more

You will encounter several different versions of the items in 3 as you work through the tutorials.

If you are an expert who has chosen to not setup UPS in their login scripts, steps 1 and two are merged together as described in Shells#Expert_Only.