Skip to content

Latest commit

 

History

History
120 lines (93 loc) · 4.2 KB

Selection.md

File metadata and controls

120 lines (93 loc) · 4.2 KB
Raw

Project selection and environment activation

Each MPD project (see Creating a project) has an associated Spack environment with the same name as the project name. Depending on which spack mpd command is invoked, there are varying requirements on whether an MPD project must be selected and a Spack environment activated. The following chart summarizes these requirements:

  • The white check mark ✅ indicates what is required to invoke the command (i.e. spack mpd build requires MPD to be initialized, a selected project, and an active environment).
  • The ❌ symbol indicates what is forbidden in order to invoke the command (i.e. spack mpd rm-project requires MPD to be initialized, forbids that a project is selected, and forbids that an environment is active).
  • Table cells with no symbol indicate that the command can be invoked irrespective of whether the requirement is satisfied or not.
Command MPD initialized Selected project Active environment
spack mpd init
spack mpd list ✅
spack mpd new-project ✅ ❌
spack mpd select ✅ ❌
spack mpd clear ✅ ❌
spack mpd git-clone ✅ ✅
spack mpd refresh ✅ ✅ ❌
spack mpd zap ✅ ✅
spack mpd build ✅ ✅
spack mpd install ✅ ✅
spack mpd test ✅ ✅
spack mpd rm-project ✅ ❌ ❌

Selecting a project

The following actions will select a project

  1. Creating a new project via spack mpd new-project ... will automatically select the project after it has been created.
  2. Activating a Spack environment with a given name will automatically select the corresponding project.
  3. Explicitly invoking spack mpd select <project> will select the specified project, assuming it is exists.

You can tell which project is selected by invoking spack mpd list---the selected project is indicated with a right-pointing triangle ▶.

$ spack mpd list

==> Existing MPD projects:

   Project name    Environment status
   ------------    ------------------------------
   nu-devel        (none)
 ▶ art-devel       installed

Clearing (deselecting) a project

To deselect a project, the user invokes spack mpd clear. You can verify the project has been cleared by invoking spack mpd list---you should no longer see any right arrow ▶ indicator.

$ spack mpd list

==> Existing MPD projects:

   Project name    Environment status
   ------------    ------------------------------
   nu-devel        (none)
   art-devel       installed

Warning

Deactivating a Spack environment does not clear the project. This makes it possible to continue to interacting with the project (e.g. invoking spack mpd git-clone) when an active environment is no longer needed or desired.

Selecting a project in use by another shell

It is possible for more than one shell to select the same project. However, a warning will be printed to the screen whenever this happens:

$ spack mpd select art-devel
==> Warning: Project art-devel selected in another shell.  Use with caution.

The project list will also reflect if more than one shell have selected the same project:

$ spack mpd list

==> Existing MPD projects:

   Project name    Environment status
   ------------    ------------------
   nu-devel        (none)
 ▶ art-devel       installed           Warning: used by more than one shell

Activating a Spack environment

To build, install, or test any of the packages under development, the Spack environment corresponding to the project must be active. This is achieved by invoking spack env activate <project>.

Tip

Activating a Spack environment automatically selects the corresponding MPD project. Users therefore do not need to invoke spack mpd select <project> before invoking spack env activate <project>.