User-Managed Software

Introduction

The User-Managed Software (UMS) program defines a set of polices by which users of OLCF systems are granted the ability and responsibility to install, maintain, document, and support software packages intended for use by other general users on OLCF resources.

Note

The UMS program is not currently available on all OLCF systems.

Depending on the system, the directories used by UMS projects may differ, but the workflow remains the same.

To apply to the UMS program, fill out the application at: https://my.olcf.ornl.gov/project-application-new. Select “User Managed Software Program” from the drop down menu to begin.

Currently Available User-Managed Software

Project	Packages	Point of Contact	Information
gen007flux	Flux	Stephen Herbein (herbein1@llnl.gov)	https://github.com/flux-framework
stf010	flang	Fady Ghanim (ghanimfa@ornl.gov)
aph114	openPMD-api WarpX libEnsemble Ascent/Conduit Adios2 dev	Axel Huebl (axelhuebl@lbl.gov)	https://github.com/openPMD/openPMD-api; Complex compiled python extension. Might be best to treat as a discrete python environment similar to IBM-WML-CE.
gen119	NVIDIA RAPIDS BlazingSQL	Benjamin Hernandez (hernandezarb@ornl.gov)	https://developer.nvidia.com/rapids https://blazingsql.com/
ums012	SOLLVE LLVM	Felipe Jaramillo (cabarcas@udel.edu) Sunita Chandrasekaran (schandra@udel.edu)
ums013	Julia	Valentin Churavy (vchuravy@mit.edu)	https://julialang.org
ums015	DPC++ for HIP	Gordon Brown (gordon@codeplay.com)

Usage

To access and use the UMS available on a system, you must first load the base ums module to add the individual projects to the module list. Once this is loaded, then each project has a module to gain access to that project’s provided software. For example:

## Find the base UMS module:
> module avail ums
----------------- /sw/{{HOST}}/modulefiles ------------------
  ums/default

## Load the UMS project access modules:
> module load ums

## See the newly available UMS projects:
> module avail ums
--------------- /sw/{{HOST}}/ums/modulefiles/ ---------------
  ums-abc123/default
  ums001/default

----------------- /sw/{{HOST}}/modulefiles ------------------
  ums/default (L)

## Gain access to a UMS project's provided modules:
> module load ums-abc123

## See the provided UMS project's modules (truncated output):
> module avail
...
------------ /sw/{{HOST}}/ums/ums-abc123/modules ------------
  abc123/1.0
  abc123/1.1

--------------- /sw/{{HOST}}/ums/modulefiles/ ---------------
  ums-abc123/default (L)
  ums001/default

----------------- /sw/{{HOST}}/modulefiles ------------------
  ums/default (L)
...

If there are issues with a UMS provided product, you can find information in the module via:

> module show ums-abc123
-----------------------------------------------------------
  /sw/{{HOST}}/ums/modules/ums-abc123/default.lua:
-----------------------------------------------------------

help([[ABC software description (User Managed Software)

  The ABC123 UMS project provides this feature.

  THIS SOFTWARE IS NOT SUPPORTED BY THE OLCF.

  Please direct all support questions and concerns regarding this software
  installation to one of the following:

     - Point of Contact: <UMS Project PI>
       - Email:  <UMS POC email>
       - GitHub: <if applicable>

  Documentation:
    <URL to the project's documentation>
  ]])
  whatis("UMS - ABC Software")
  prepend_path("MODULEPATH","/sw/{{HOST}}/ums/modules/abc123/Core")

Policies

The OLCF UMS Policy is located in the “Accounts and Projects” section of this documentation here.

Writing UMS Modulefiles

A project directory and modulefile will be created and made available. The project directory will be the workspace for your team to build and install the software you wish to provide to the other OLCF users. The created modulefile will add your project’s provided modules to the modulepath. Note that by default, the project modulefile will add a default path, /sw/{{HOST}}/ums/{{PROJECT}}/modules, to the MODULEPATH. If you wish to locate your project’s modules in another directory, you will need to modify the provided modulefile.

The following will be created and put under the ownership of your UMS project and your project’s PI:

/sw/{{HOST}}/ums/modules/{{PROJECT}}/default.lua    ## default project gateway module
/sw/{{HOST}}/ums/{{PROJECT}}                        ## root prefix for installing builds
/sw/{{HOST}}/ums/{{PROJECT}}/modules                ## root prefix for installing modulefiles

The builds in /sw/{{HOST}}/ums/{{PROJECT}} can be organized as you see fit, but we ask that you try to document the layout and build procedures. For example, under the prefix directory, use one or more of the following to improve transparency of the build process:

keep an up-to-date README or changelog
keep configure and build logs in your project’s area
use spack or non-interactive build scripts kept in the prefix to deploy all packages
track changes to configurations or build-scripts in git

so that other people such as new developers and maintainers on your project as well as OLCF staff will have a clear understanding of how the builds have been configured and what their dependencies are should they need to take over maintaining the builds.

The structure of the modulefile tree is somewhat flexible. These directories will not be in the default $MODULEPATH. For general users to access them, they will first need to opt-in to using UMS software by loading the ums/default module, then the module for your UMS software project ums-{{PROJECT}} and finally one or more modulefiles that you have written for your software:

module load ums
module load ums-{{PROJECT}}
module avail

# To see modules your project provides:
ls $(module --redirect show ums-{{PROJECT}} | egrep "MODULEPATH.*$" | grep -o "/sw/[^\'\"]*")

The project gateway module ums-{{PROJECT}} will add /sw/{{HOST}}/ums/{{PROJECT}}/modules to the $MODULEPATH. Any modulefiles you install under this directory will be available to users when they have loaded the gateway module. Modulefiles should be organized according to the following structure:

/sw/{{HOST}}/ums/{{PROJECT}}/modules/<package1_name>/<package1_version1>.lua
/sw/{{HOST}}/ums/{{PROJECT}}/modules/<package1_name>/<package1_version2>.lua
/sw/{{HOST}}/ums/{{PROJECT}}/modules/<package2_name>/<package2_version1>.lua

You may have as many modulefiles as you see fit, both in terms of <package_name> and <package_version>.

Warning

It is imperative that /sw/{{HOST}}/ums/{{PROJECT}}/modules only have one level of subdirectories (<packageN_name>). Having further subdirectories will alter the way LMOD searches for modulefiles globally and generally make LMOD’s behavior indeterminate. It is also recommended that you be careful with symlinks in the modulefile prefix.

In particular, symlinks under /sw/{{HOST}}/ums/{{PROJECT}}/modules that refer back to /sw/{{HOST}}/ums/{{PROJECT}}/modules will cause LMOD to enter a recursive loop and be unable to display or load your modules correctly.

For further assistance please contact the OLCF at help@olcf.ornl.gov.