{"id":13478573,"url":"https://github.com/reframe-hpc/reframe","last_synced_at":"2026-03-05T23:54:22.067Z","repository":{"id":37074294,"uuid":"89384186","full_name":"reframe-hpc/reframe","owner":"reframe-hpc","description":"A powerful Python framework for writing and running portable regression tests and benchmarks for HPC systems.","archived":false,"fork":false,"pushed_at":"2026-03-02T22:03:46.000Z","size":52423,"stargazers_count":268,"open_issues_count":129,"forks_count":120,"subscribers_count":16,"default_branch":"develop","last_synced_at":"2026-03-02T23:47:37.832Z","etag":null,"topics":["benchmarking","continuous-integration","framework","hpc","performance-testing","python3","regression-testing","validation-testing"],"latest_commit_sha":null,"homepage":"https://reframe-hpc.readthedocs.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reframe-hpc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-04-25T16:43:23.000Z","updated_at":"2026-03-02T22:03:43.000Z","dependencies_parsed_at":"2025-12-16T07:02:49.367Z","dependency_job_id":null,"html_url":"https://github.com/reframe-hpc/reframe","commit_stats":{"total_commits":6279,"total_committers":86,"mean_commits":73.01162790697674,"dds":0.7343526039178213,"last_synced_commit":"35fce1ebcb5a9d562e7130ea148a2ee860d48aa9"},"previous_names":["eth-cscs/reframe"],"tags_count":161,"template":false,"template_full_name":null,"purl":"pkg:github/reframe-hpc/reframe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reframe-hpc%2Freframe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reframe-hpc%2Freframe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reframe-hpc%2Freframe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reframe-hpc%2Freframe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reframe-hpc","download_url":"https://codeload.github.com/reframe-hpc/reframe/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reframe-hpc%2Freframe/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30156253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T22:39:40.138Z","status":"ssl_error","status_checked_at":"2026-03-05T22:39:24.771Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["benchmarking","continuous-integration","framework","hpc","performance-testing","python3","regression-testing","validation-testing"],"created_at":"2024-07-31T16:01:58.868Z","updated_at":"2026-03-05T23:54:22.041Z","avatar_url":"https://github.com/reframe-hpc.png","language":"Python","readme":"\u003cdiv align=\"left\"\u003e\n \u003cimg src=\"docs/_static/img/reframe_logo-width400p.png#gh-light-mode-only\" width=\"400px\"\u003e\n \u003cimg src=\"docs/_static/img/reframe-logo-dark-bg.png#gh-dark-mode-only\" width=\"400px\"\u003e\n\u003c/div\u003e\n\n[![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)\n[![Documentation Status](https://readthedocs.org/projects/reframe-hpc/badge/?version=latest)](https://reframe-hpc.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/reframe-hpc/reframe/graph/badge.svg?token=OCsdagJHcX)](https://codecov.io/gh/reframe-hpc/reframe)\u003cbr/\u003e\n![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/reframe-hpc/reframe?include_prereleases)\n![GitHub commits since latest release](https://img.shields.io/github/commits-since/reframe-hpc/reframe/latest)\n![GitHub contributors](https://img.shields.io/github/contributors-anon/reframe-hpc/reframe)\u003cbr/\u003e\n[![PyPI version](https://badge.fury.io/py/ReFrame-HPC.svg)](https://badge.fury.io/py/ReFrame-HPC)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/reframe-hpc)\n[![Downloads](https://pepy.tech/badge/reframe-hpc)](https://pepy.tech/project/reframe-hpc)\n[![Downloads](https://pepy.tech/badge/reframe-hpc/month)](https://pepy.tech/project/reframe-hpc)\u003cbr/\u003e\n[![Slack](https://badgen.net/badge/icon/slack?icon=slack\u0026label)](https://join.slack.com/t/reframetalk/shared_invite/zt-3706f0tj6-2CjHh07HdQNbmLw1qAasjg)\n[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![DOI](https://zenodo.org/badge/89384186.svg)](https://zenodo.org/badge/latestdoi/89384186)\u003cbr/\u003e\n[![Twitter Follow](https://img.shields.io/twitter/follow/ReFrameHPC?style=social)](https://twitter.com/ReFrameHPC)\n\n# ReFrame in a Nutshell\n\nReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems.\nThe 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.\nThis allows users to write portable tests in a declarative way that describes only the test's functionality.\n\nTests in ReFrame are simple Python classes that specify the basic variables and parameters of the test.\nReFrame 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.\nReFrame will load the tests and send them down a well-defined pipeline that will execute them in parallel.\nThe 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.\n\nReFrame also supports storing the test results in a database allowing for later inspection, basic analytics and performance comparisons.\n\nPlease visit the project's documentation [page](https://reframe-hpc.readthedocs.io/) for all the details!\n\n\n## Installation\n\nReFrame is fairly easy to install.\nAll you need is Python 3.6 or above and to run its bootstrap script:\n\n```bash\ngit clone https://github.com/reframe-hpc/reframe.git\ncd reframe\n./bootstrap.sh\n./bin/reframe -V\n```\n\nIf you want a specific release, please refer to the documentation [page](https://reframe-hpc.readthedocs.io/en/stable/started.html).\n\n\n### Running the unit tests\n\nYou can optionally run the framework's unit tests with the following command:\n\n```bash\n./test_reframe.py -v\n```\n\nNOTE: Unit tests require a POSIX-compliant C compiler (available through the `cc` command), as well as the `make` utility.\n\n### Building the documentation locally\n\nYou may build the documentation of the master manually as follows:\n\n```\n./bootstrap.sh +docs\n```\n\nFor viewing it, you may do the following:\n\n```\ncd docs/html\npython3 -m http.server\n```\n\nThe documentation is now up on [localhost:8000](http://localhost:8000), where you can navigate with your browser.\n\n## Test library\n\nThe framework comes with an experimental library of tests that users can either run from the command line directly or extend and fine tune them for their systems. See [here](https://reframe-hpc.readthedocs.io/en/stable/hpctestlib.html) for more details.\n\n## Public test repositories\n\nThe ReFrame HPC [community Github page](https://github.com/reframe-hpc) provides mirror forks of interesting ReFrame test repositories maintained by various sites or projects.\nYou can use those tests as an additional guidance to implement your own tests.\n\nIf you maintain a public test repository and you would like it to be listed in the community page, feel free to open an issue or contact us through [Slack](#slack).\n\n## Contact\n\nYou can get in contact with the ReFrame community in the following ways:\n\n### Slack\n\nPlease join the community's [Slack channel](https://join.slack.com/t/reframetalk/shared_invite/zt-3706f0tj6-2CjHh07HdQNbmLw1qAasjg) for keeping up with the latest news about ReFrame, posting questions and, generally getting in touch with other users and the developers.\n\n\u003e NOTE: Slack invite links expire for security reasons. Although we update them regularly, if you encounter problems joining the community Slack channel, please open an issue.\n\n## Contributing back\n\nReFrame is an open-source project and we welcome and encourage contributions!\nCheck out our Contribution Guide [here](https://github.com/reframe-hpc/reframe/wiki/contributing-to-reframe).\n\n## Citing ReFrame\n\nYou can cite ReFrame in publications as follows:\n\n\u003e Vasileios Karakasis et al. \"Enabling Continuous Testing of HPC Systems Using ReFrame\". In: *Tools and Techniques for High Performance Computing. HUST - Annual Workshop on HPC User Support Tools* (Denver, Colorado, USA, Nov. 17–18, 2019). Ed. by Guido Juckeland and Sunita Chandrasekaran. Vol. 1190. Communications in Computer and Information Science. Cham, Switzerland: Springer International Publishing, Mar. 2020, pp. 49–68. isbn: 978-3-030-44728-1. doi: 10.1007/978-3-030-44728-1_3.\n\nThe corresponding BibTeX entry is the following:\n\n```bibtex\n@InProceedings{karakasis20a,\n  author     = {Karakasis, Vasileios and Manitaras, Theofilos and Rusu, Victor Holanda and\n                Sarmiento-P{\\'e}rez, Rafael and Bignamini, Christopher and Kraushaar, Matthias and\n                Jocksch, Andreas and Omlin, Samuel and Peretti-Pezzi, Guilherme and\n                Augusto, Jo{\\~a}o P. S. C. and Friesen, Brian and He, Yun and Gerhardt, Lisa and\n                Cook, Brandon and You, Zhi-Qiang and Khuvis, Samuel and Tomko, Karen},\n  title      = {Enabling Continuous Testing of {HPC} Systems Using {ReFrame}},\n  booktitle  = {Tools and Techniques for High Performance Computing},\n  editor     = {Juckeland, Guido and Chandrasekaran, Sunita},\n  year       = {2020},\n  month      = mar,\n  series     = {Communications in Computer and Information Science},\n  volume     = {1190},\n  pages      = {49--68},\n  address    = {Cham, Switzerland},\n  publisher  = {Springer International Publishing},\n  doi        = {10.1007/978-3-030-44728-1_3},\n  venue      = {Denver, Colorado, USA},\n  eventdate  = {2019-11-17/2019-11-18},\n  eventtitle = {{HUST} - Annual Workshop on {HPC} User Support Tools},\n  isbn       = {978-3-030-44728-1},\n  issn       = {1865-0937},\n}\n```\n\nFor a complete list of publications and talks about ReFrame, please refer to the latest documentation page [here](https://reframe-hpc.readthedocs.io/en/latest/#publications).\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freframe-hpc%2Freframe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freframe-hpc%2Freframe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freframe-hpc%2Freframe/lists"}