From 5ea2ca320fd252b20817b876d8bce54f8365e18b Mon Sep 17 00:00:00 2001 From: Vasileios Karakasis Date: Sat, 30 Oct 2021 01:13:06 +0200 Subject: [PATCH 1/2] Update README --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 600bd5cb04..1d6dcf5493 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,15 @@ # ReFrame in a Nutshell -ReFrame is a framework for writing regression tests for HPC systems. -The goal of this framework is to abstract away the complexity of the interactions with the system, separating the logic of a regression test from the low-level details, which pertain to the system configuration and setup. -This allows users to write easily portable regression tests, focusing only on the functionality. +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. -Regression tests in ReFrame are simple Python classes that specify the basic parameters of the test. -The framework will load the test and will send it down a well-defined pipeline that will take care of its execution. +Tests in ReFrame are simple Python classes that specify the basic 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. -Writing system regression tests in a high-level modern programming language, like Python, poses a great advantage in organizing and maintaining the tests. -Users can create their own test hierarchies, create test factories for generating multiple tests at the same time and also customize them in a simple and expressive way. - Please visit the project's documentation [page](https://reframe-hpc.readthedocs.io/) for all the details! From 5641595675cbf884153378ad7fdf3e78e6720954 Mon Sep 17 00:00:00 2001 From: Vasileios Karakasis Date: Thu, 4 Nov 2021 22:13:59 +0100 Subject: [PATCH 2/2] Update also intro page in docs + setup.cfg --- README.md | 2 +- docs/index.rst | 15 ++++++--------- setup.cfg | 2 +- 3 files changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1d6dcf5493..110035ebf8 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ ReFrame is a powerful framework for writing system regression tests and benchmar 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 parameters of the test. +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. diff --git a/docs/index.rst b/docs/index.rst index 1b1a449de1..ad58b05ecc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,22 +2,19 @@ Welcome to ReFrame ================== -ReFrame is a high-level framework for writing regression tests for HPC systems. -The goal of the framework is to abstract away the complexity of the interactions with the system, separating the logic of a regression test from the low-level details, which pertain to the system configuration and setup. -This allows users to write easily portable regression tests, focusing only on the functionality. +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. -Regression tests in ReFrame are simple Python classes that specify the basic parameters of the test. -The framework will load the test and will send it down a well-defined pipeline that will take care of its execution. +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. -Writing system regression tests in a high-level modern programming language, like Python, poses a great advantage in organizing and maintaining the tests. -Users can create their own test hierarchies or test factories for generating multiple tests at the same time and they can also customize them in a simple and expressive way. - 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. - Use Cases ========= diff --git a/setup.cfg b/setup.cfg index 2025f96c4b..46088269bd 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,7 +2,7 @@ name = ReFrame-HPC version = attr: reframe.VERSION author = CSCS Swiss National Supercomputing Center -description = ReFrame is a framework for writing regression tests for HPC systems +description = ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems url = https://github.com/eth-cscs/reframe license = BSD 3-Clause long_description = file: README.md