Skip to content

Commit 6a082ec

Browse files
author
Vasileios Karakasis
authored
Merge pull request #2256 from vkarak/doc/update-readme
[doc] Update README
2 parents b33ba87 + 095dd68 commit 6a082ec

File tree

3 files changed

+13
-18
lines changed

3 files changed

+13
-18
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,15 @@
1414

1515
# ReFrame in a Nutshell
1616

17-
ReFrame is a framework for writing regression tests for HPC systems.
18-
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.
19-
This allows users to write easily portable regression tests, focusing only on the functionality.
17+
ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems.
18+
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.
19+
This allows users to write portable tests in a declarative way that describes only the test's functionality.
2020

21-
Regression tests in ReFrame are simple Python classes that specify the basic parameters of the test.
22-
The framework will load the test and will send it down a well-defined pipeline that will take care of its execution.
21+
Tests in ReFrame are simple Python classes that specify the basic variables and parameters of the test.
22+
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.
23+
ReFrame will load the tests and send them down a well-defined pipeline that will execute them in parallel.
2324
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.
2425

25-
Writing system regression tests in a high-level modern programming language, like Python, poses a great advantage in organizing and maintaining the tests.
26-
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.
27-
2826
Please visit the project's documentation [page](https://reframe-hpc.readthedocs.io/) for all the details!
2927

3028

docs/index.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,19 @@
22
Welcome to ReFrame
33
==================
44

5-
ReFrame is a high-level framework for writing regression tests for HPC systems.
6-
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.
7-
This allows users to write easily portable regression tests, focusing only on the functionality.
5+
ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems.
6+
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.
7+
This allows users to write portable tests in a declarative way that describes only the test's functionality.
88

9-
Regression tests in ReFrame are simple Python classes that specify the basic parameters of the test.
10-
The framework will load the test and will send it down a well-defined pipeline that will take care of its execution.
9+
Tests in ReFrame are simple Python classes that specify the basic variables and parameters of the test.
10+
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.
11+
ReFrame will load the tests and send them down a well-defined pipeline that will execute them in parallel.
1112
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.
1213

1314
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.
1415

15-
Writing system regression tests in a high-level modern programming language, like Python, poses a great advantage in organizing and maintaining the tests.
16-
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.
17-
1816
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.
1917

20-
2118
Use Cases
2219
=========
2320

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = ReFrame-HPC
33
version = attr: reframe.VERSION
44
author = CSCS Swiss National Supercomputing Center
5-
description = ReFrame is a framework for writing regression tests for HPC systems
5+
description = ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems
66
url = https://github.com/eth-cscs/reframe
77
license = BSD 3-Clause
88
long_description = file: README.md

0 commit comments

Comments
 (0)