Umpire is a resource management library that allows the discovery, provision, and management of memory on machines with multiple memory devices like NUMA and GPUs.
Umpire uses CMake and BLT to handle builds. Since BLT is included as a submodule, first make sure you run:
$ git submodule init && git submodule update
Then, make sure that you have a modern compiler loaded, and the configuration is as simple as:
$ mkdir build && cd build
$ cmake ..
CMake will provide output about which compiler is being used. Once CMake has completed, Umpire can be built with Make:
$ make
For more advanced configuration you can use standard CMake variables.
Both user and code documentation is available here.
The Umpire tutorial provides a step by step introduction to Umpire features.
If you have build problems, we have comprehensive build system documentation too!
Umpire is an open-source project, and we welcome contributions from the community.
You can also start an issue for a bug report or feature request.
The Umpire mailing list is hosted on Google Groups, and is a great place to ask questions: Umpire Users Google Group
You can also join our RADIUSS slack group and find the "umpire-users" channel to ask questions. To be sent an invite to the slack group, email us at umpire-dev@llnl.gov
We welcome all kinds of contributions: new features, bug fixes, documentation edits; it's all great!
To contribute, make a pull request, with develop as the destination branch.
We use Travis to run CI tests, and your branch must pass these tests before being merged.
For more information, see the contributing guide.
Thanks to all of Umpire's contributors.
Umpire was created by David Beckingsale (david@llnl.gov).
If you are referencing Umpire in a publication, please use the following citation:
- D. Beckingsale, M. Mcfadden, J. Dahm, R. Pankajakshan and R. Hornung, "Umpire: Application-Focused Management and Coordination of Complex Hierarchical Memory," in IBM Journal of Research and Development. 2019. doi: 10.1147/JRD.2019.2954403
Umpire is released under an MIT license. For more details, please see the LICENSE and RELEASE files.
LLNL-CODE-747640
OCEC-18-031