Welcome to ReFrame¶
ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems. The goal of the framework is to abstract away the complexity of the interactions with the system, separating the logic of a test from the low-level details, which pertain to the system configuration and setup. This allows users to write portable tests in a declarative way that describes only the test’s functionality.
Tests in ReFrame are simple Python classes that specify the basic variables and parameters of the test. ReFrame offers an intuitive and very powerful syntax that allows users to create test libraries, test factories, as well as complete test workflows using other tests as fixtures. ReFrame will load the tests and send them down a well-defined pipeline that will execute them in parallel. The stages of this pipeline take care of all the system interaction details, such as programming environment switching, compilation, job submission, job status query, sanity checking and performance assessment.
ReFrame also offers a high-level and flexible abstraction for writing sanity and performance checks for your regression tests, without having to care about the details of parsing output files, searching for patterns and testing against reference values for different systems.
Finally, ReFrame offers a powerful and efficient runtime for running and managing the execution of tests, as well as integration with common logging facilities, where ReFrame can send live data from currently running performance tests.
Slides [part 1][part 2][talk] @ 8th EasyBuild User Meeting 2023.
Slides [pdf] @ 7th EasyBuild User Meeting 2022.
Slides [pdf] @ 6th EasyBuild User Meeting 2021.
Slides [pdf] @ 5th EasyBuild User Meeting 2020.
Slides [pdf] @ HPC System Testing BoF, SC’19.
Slides [pdf] @ HPC Knowledge Meeting ‘19.
Slides [pdf] @ 4th EasyBuild User Meeting.
Slides [pdf] @ CSCS User Lab Day 2018.
Slides [pdf] @ HPC Advisory Council 2018.
“ReFrame – Efficient System and Application Performance Testing,” CSCS Webinar, Aug. 29, 2022 [slides] [recording] [demo run].
- Getting Started
- What’s New in ReFrame 4.0
- ReFrame Tutorials
- Tutorial 1: Getting Started with ReFrame
- Tutorial 2: Customizing Further a Regression Test
- Tutorial 3: Using Dependencies in ReFrame Tests
- Tutorial 4: Using Test Fixtures
- Tutorial 5: Using Build Automation Tools As a Build System
- Tutorial 6: Tips and Tricks
- Tutorial 7: The Flux Framework Scheduler
- Tutorial 8: Generating tests programmatically
- Online Tutorials
- Configuring ReFrame for Your Site
- Advanced Topics
- ReFrame Manuals
- ReFrame Test Library (experimental)