From b0cf3578dec43897188a0f23812452ea29404d93 Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 09:57:31 +0200 Subject: [PATCH 01/11] Add dark logo in the README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 734e146ce1..afa555c873 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +
+ + +
+ [![ReFrame Logo](https://raw.githubusercontent.com/reframe-hpc/reframe/master/docs/_static/img/reframe_logo-width400p.png)](https://github.com/reframe-hpc/reframe)
[![Build Status](https://github.com/reframe-hpc/reframe/workflows/ReFrame%20CI/badge.svg)](https://github.com/reframe-hpc/reframe/actions?query=workflow%3A%22ReFrame+CI%22) [![Documentation Status](https://readthedocs.org/projects/reframe-hpc/badge/?version=latest)](https://reframe-hpc.readthedocs.io/en/latest/?badge=latest) From f4f3a1209ad84f607b1563e1660564a7d6cdf59c Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 09:59:22 +0200 Subject: [PATCH 02/11] Remove old logo --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index afa555c873..de51cc86ee 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ -[![ReFrame Logo](https://raw.githubusercontent.com/reframe-hpc/reframe/master/docs/_static/img/reframe_logo-width400p.png)](https://github.com/reframe-hpc/reframe)
[![Build Status](https://github.com/reframe-hpc/reframe/workflows/ReFrame%20CI/badge.svg)](https://github.com/reframe-hpc/reframe/actions?query=workflow%3A%22ReFrame+CI%22) [![Documentation Status](https://readthedocs.org/projects/reframe-hpc/badge/?version=latest)](https://reframe-hpc.readthedocs.io/en/latest/?badge=latest) [![codecov.io](https://codecov.io/gh/reframe-hpc/reframe/branch/master/graph/badge.svg)](https://codecov.io/github/reframe-hpc/reframe)
From 27f6df05d9aa9ffb07056bb8144da5e9eda0a41e Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 10:00:27 +0200 Subject: [PATCH 03/11] Align logo to the left --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index de51cc86ee..b16f627b9c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
+
From 7cc25a6635508ee7431f07585183826151a5460e Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 10:22:53 +0200 Subject: [PATCH 04/11] Update logo --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b16f627b9c..86b0528bef 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -
- - -
+ + + + ReFrame logo + [![Build Status](https://github.com/reframe-hpc/reframe/workflows/ReFrame%20CI/badge.svg)](https://github.com/reframe-hpc/reframe/actions?query=workflow%3A%22ReFrame+CI%22) [![Documentation Status](https://readthedocs.org/projects/reframe-hpc/badge/?version=latest)](https://reframe-hpc.readthedocs.io/en/latest/?badge=latest) From 551047651fc406286bd0804b005b99ee1be34c37 Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 10:25:42 +0200 Subject: [PATCH 05/11] Fix typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86b0528bef..f9603b5e50 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ - - + + ReFrame logo From 8460cead5096758c4ef45daf118d199758567087 Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 10:27:37 +0200 Subject: [PATCH 06/11] fix typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f9603b5e50..95a65b47d6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ - - + + ReFrame logo From d4d9b5ce0a643bc565d684b5cd224d10de19f4b3 Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 10:29:39 +0200 Subject: [PATCH 07/11] Remove alt --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 95a65b47d6..abd8fc7016 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ - ReFrame logo [![Build Status](https://github.com/reframe-hpc/reframe/workflows/ReFrame%20CI/badge.svg)](https://github.com/reframe-hpc/reframe/actions?query=workflow%3A%22ReFrame+CI%22) From d3f0205e3a7aa2debd8e09c30d9a10b216b8bb5a Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 17:28:52 +0200 Subject: [PATCH 08/11] Revert "Remove alt" This reverts commit d4d9b5ce0a643bc565d684b5cd224d10de19f4b3. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index abd8fc7016..95a65b47d6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ + ReFrame logo [![Build Status](https://github.com/reframe-hpc/reframe/workflows/ReFrame%20CI/badge.svg)](https://github.com/reframe-hpc/reframe/actions?query=workflow%3A%22ReFrame+CI%22) From 64e5e0bdf7db3d246311ab091db04d21db0e77a1 Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Wed, 28 Sep 2022 17:42:27 +0200 Subject: [PATCH 09/11] Revert last commits --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 95a65b47d6..b16f627b9c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ - - - - ReFrame logo - +
+ + +
[![Build Status](https://github.com/reframe-hpc/reframe/workflows/ReFrame%20CI/badge.svg)](https://github.com/reframe-hpc/reframe/actions?query=workflow%3A%22ReFrame+CI%22) [![Documentation Status](https://readthedocs.org/projects/reframe-hpc/badge/?version=latest)](https://reframe-hpc.readthedocs.io/en/latest/?badge=latest) From f01ba78a1da1991adbbcf3a9b8c8729f5660c4f8 Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Fri, 7 Oct 2022 10:31:31 +0200 Subject: [PATCH 10/11] Use different README for pypi --- README_pypi.md | 104 +++++++++++++++++++++++++++++++++++++++++++++++++ setup.cfg | 2 +- 2 files changed, 105 insertions(+), 1 deletion(-) create mode 100644 README_pypi.md diff --git a/README_pypi.md b/README_pypi.md new file mode 100644 index 0000000000..734e146ce1 --- /dev/null +++ b/README_pypi.md @@ -0,0 +1,104 @@ +[![ReFrame Logo](https://raw.githubusercontent.com/reframe-hpc/reframe/master/docs/_static/img/reframe_logo-width400p.png)](https://github.com/reframe-hpc/reframe)
+[![Build Status](https://github.com/reframe-hpc/reframe/workflows/ReFrame%20CI/badge.svg)](https://github.com/reframe-hpc/reframe/actions?query=workflow%3A%22ReFrame+CI%22) +[![Documentation Status](https://readthedocs.org/projects/reframe-hpc/badge/?version=latest)](https://reframe-hpc.readthedocs.io/en/latest/?badge=latest) +[![codecov.io](https://codecov.io/gh/reframe-hpc/reframe/branch/master/graph/badge.svg)](https://codecov.io/github/reframe-hpc/reframe)
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/reframe-hpc/reframe?include_prereleases) +![GitHub commits since latest release](https://img.shields.io/github/commits-since/reframe-hpc/reframe/latest) +![GitHub contributors](https://img.shields.io/github/contributors-anon/reframe-hpc/reframe)
+[![PyPI version](https://badge.fury.io/py/ReFrame-HPC.svg)](https://badge.fury.io/py/ReFrame-HPC) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/reframe-hpc) +[![Downloads](https://pepy.tech/badge/reframe-hpc)](https://pepy.tech/project/reframe-hpc) +[![Downloads](https://pepy.tech/badge/reframe-hpc/month)](https://pepy.tech/project/reframe-hpc)
+[![Slack](https://reframe-slack.herokuapp.com/badge.svg)](https://reframe-slack.herokuapp.com/)
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) +[![DOI](https://zenodo.org/badge/89384186.svg)](https://zenodo.org/badge/latestdoi/89384186)
+[![Twitter Follow](https://img.shields.io/twitter/follow/ReFrameHPC?style=social)](https://twitter.com/ReFrameHPC) + +# ReFrame in a Nutshell + +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. + +Please visit the project's documentation [page](https://reframe-hpc.readthedocs.io/) for all the details! + + +## Installation + +ReFrame is fairly easy to install. +All you need is Python 3.6 or above and to run its bootstrap script: + +```bash +git clone https://github.com/reframe-hpc/reframe.git +cd reframe +./bootstrap.sh +./bin/reframe -V +``` + +If you want a specific release, please refer to the documentation [page](https://reframe-hpc.readthedocs.io/en/stable/started.html). + + +### Running the unit tests + +You can optionally run the framework's unit tests with the following command: + +```bash +./test_reframe.py -v +``` + +NOTE: Unit tests require a POSIX-compliant C compiler (available through the `cc` command), as well as the `make` utility. + +### Building the documentation locally + +You may build the documentation of the master manually as follows: + +``` +./bootstrap.sh +docs +``` + +For viewing it, you may do the following: + +``` +cd docs/html +python3 -m http.server +``` + +The documentation is now up on [localhost:8000](http://localhost:8000), where you can navigate with your browser. + + +## Test library + +The framework comes with a library of tests that users can either run them from the command line directly or extend them and fine tune them for their systems. See [here](https://reframe-hpc.readthedocs.io/en/stable/hpctestlib.html) for more details. + + +## Test examples + +You can find examples of real tests under the ReFrame HPC [community Github page](https://github.com/reframe-hpc). +The most complete suite of tests currently publicly available is that of [CSCS](https://cscs.ch/), which you can also find [here](https://github.com/eth-cscs/cscs-reframe-tests). +You can use those tests as a starting point for implementing your own tests. + + +## Contact + +You can get in contact with the ReFrame community in the following ways: + +### Slack + +Please join the community's [Slack channel](https://reframe-slack.herokuapp.com) for keeping up with the latest news about ReFrame, posting questions and, generally getting in touch with other users and the developers. + +### Mailing list + +You may also [subscribe](mailto:reframe-subscribe@sympa.cscs.ch) to the [mailing list](mailto:reframe@sympa.cscs.ch). +Only subscribers can send messages to the list. +For unsubscribing, you may send an empty message [here](mailto:reframe-unsubscribe@sympa.cscs.ch). + + +## Contributing back + +ReFrame is an open-source project and we welcome and encourage contributions! +Check out our Contribution Guide [here](https://github.com/reframe-hpc/reframe/wiki/contributing-to-reframe). diff --git a/setup.cfg b/setup.cfg index ce8d2c2818..fab86aa2a4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ author = CSCS Swiss National Supercomputing Center description = ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems url = https://github.com/reframe-hpc/reframe license = BSD 3-Clause -long_description = file: README.md +long_description = file: README_pypi.md long_description_content_type = text/markdown classifiers = Development Status :: 5 - Production/Stable From e78ccd1603afdb36fef8846a89a86fd4371799af Mon Sep 17 00:00:00 2001 From: Eirini Koutsaniti Date: Mon, 10 Oct 2022 18:09:26 +0200 Subject: [PATCH 11/11] Replace pypi README --- README_pypi.md => README_minimal.md | 58 +---------------------------- setup.cfg | 2 +- 2 files changed, 2 insertions(+), 58 deletions(-) rename README_pypi.md => README_minimal.md (69%) diff --git a/README_pypi.md b/README_minimal.md similarity index 69% rename from README_pypi.md rename to README_minimal.md index 734e146ce1..bde42132ad 100644 --- a/README_pypi.md +++ b/README_minimal.md @@ -25,63 +25,7 @@ ReFrame offers an intuitive and very powerful syntax that allows users to create 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. -Please visit the project's documentation [page](https://reframe-hpc.readthedocs.io/) for all the details! - - -## Installation - -ReFrame is fairly easy to install. -All you need is Python 3.6 or above and to run its bootstrap script: - -```bash -git clone https://github.com/reframe-hpc/reframe.git -cd reframe -./bootstrap.sh -./bin/reframe -V -``` - -If you want a specific release, please refer to the documentation [page](https://reframe-hpc.readthedocs.io/en/stable/started.html). - - -### Running the unit tests - -You can optionally run the framework's unit tests with the following command: - -```bash -./test_reframe.py -v -``` - -NOTE: Unit tests require a POSIX-compliant C compiler (available through the `cc` command), as well as the `make` utility. - -### Building the documentation locally - -You may build the documentation of the master manually as follows: - -``` -./bootstrap.sh +docs -``` - -For viewing it, you may do the following: - -``` -cd docs/html -python3 -m http.server -``` - -The documentation is now up on [localhost:8000](http://localhost:8000), where you can navigate with your browser. - - -## Test library - -The framework comes with a library of tests that users can either run them from the command line directly or extend them and fine tune them for their systems. See [here](https://reframe-hpc.readthedocs.io/en/stable/hpctestlib.html) for more details. - - -## Test examples - -You can find examples of real tests under the ReFrame HPC [community Github page](https://github.com/reframe-hpc). -The most complete suite of tests currently publicly available is that of [CSCS](https://cscs.ch/), which you can also find [here](https://github.com/eth-cscs/cscs-reframe-tests). -You can use those tests as a starting point for implementing your own tests. - +Please visit the project's documentation [page](https://reframe-hpc.readthedocs.io/) and [GitHub repository](https://github.com/reframe-hpc/reframe) for all the details! ## Contact diff --git a/setup.cfg b/setup.cfg index fab86aa2a4..04fbc84721 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ author = CSCS Swiss National Supercomputing Center description = ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems url = https://github.com/reframe-hpc/reframe license = BSD 3-Clause -long_description = file: README_pypi.md +long_description = file: README_minimal.md long_description_content_type = text/markdown classifiers = Development Status :: 5 - Production/Stable