reframe-hpc 4.10.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (159) hide show
  1. reframe_hpc-4.10.0/.gitignore +102 -0
  2. reframe_hpc-4.10.0/CONTRIBUTING.md +5 -0
  3. reframe_hpc-4.10.0/LICENSE +29 -0
  4. reframe_hpc-4.10.0/PKG-INFO +234 -0
  5. reframe_hpc-4.10.0/README.md +195 -0
  6. reframe_hpc-4.10.0/examples/cscs-webinar-2022/config/mysettings.py +164 -0
  7. reframe_hpc-4.10.0/examples/cscs-webinar-2022/cscs-webinar-2022.cast +4228 -0
  8. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/src/stream.c +585 -0
  9. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream1.py +14 -0
  10. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream2.py +18 -0
  11. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream3.py +29 -0
  12. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream4.py +43 -0
  13. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream5.py +46 -0
  14. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream6.py +48 -0
  15. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream7.py +59 -0
  16. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream8.py +75 -0
  17. reframe_hpc-4.10.0/examples/cscs-webinar-2022/tests/stream9.py +87 -0
  18. reframe_hpc-4.10.0/examples/howto/flux/README.md +4 -0
  19. reframe_hpc-4.10.0/examples/howto/flux/example1.py +30 -0
  20. reframe_hpc-4.10.0/examples/howto/flux/settings.py +85 -0
  21. reframe_hpc-4.10.0/examples/howto/reference_index.py +94 -0
  22. reframe_hpc-4.10.0/examples/howto/testlib/__init__.py +0 -0
  23. reframe_hpc-4.10.0/examples/howto/testlib/simple.py +27 -0
  24. reframe_hpc-4.10.0/examples/howto/testlib/utility/__init__.py +7 -0
  25. reframe_hpc-4.10.0/examples/howto/testlib_example.py +12 -0
  26. reframe_hpc-4.10.0/examples/tutorial/config/baseline.py +29 -0
  27. reframe_hpc-4.10.0/examples/tutorial/config/baseline.yaml +18 -0
  28. reframe_hpc-4.10.0/examples/tutorial/config/baseline_contplatf.py +24 -0
  29. reframe_hpc-4.10.0/examples/tutorial/config/baseline_environs.py +43 -0
  30. reframe_hpc-4.10.0/examples/tutorial/config/baseline_modules.py +24 -0
  31. reframe_hpc-4.10.0/examples/tutorial/config/cluster.py +71 -0
  32. reframe_hpc-4.10.0/examples/tutorial/config/cluster_logging.py +94 -0
  33. reframe_hpc-4.10.0/examples/tutorial/config/cluster_mpi.py +78 -0
  34. reframe_hpc-4.10.0/examples/tutorial/config/cluster_perflogs.py +90 -0
  35. reframe_hpc-4.10.0/examples/tutorial/config/cluster_perflogs_httpjson.py +128 -0
  36. reframe_hpc-4.10.0/examples/tutorial/config/cluster_resources.py +71 -0
  37. reframe_hpc-4.10.0/examples/tutorial/config/multifile/common/settings.py +32 -0
  38. reframe_hpc-4.10.0/examples/tutorial/config/multifile/environments/settings.py +27 -0
  39. reframe_hpc-4.10.0/examples/tutorial/config/multifile/pseudo-cluster/settings.py +31 -0
  40. reframe_hpc-4.10.0/examples/tutorial/containers/container_test.py +26 -0
  41. reframe_hpc-4.10.0/examples/tutorial/deps/deps_complex.py +197 -0
  42. reframe_hpc-4.10.0/examples/tutorial/deps/parameterized.py +40 -0
  43. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/eb-spack.dockerfile +38 -0
  44. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/flux.dockerfile +13 -0
  45. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/singlenode.Dockerfile +31 -0
  46. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/README.txt +6 -0
  47. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/dbd/Dockerfile +38 -0
  48. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/dbd/cgroup.conf +5 -0
  49. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/dbd/docker-entrypoint.sh +19 -0
  50. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/dbd/slurm.conf +156 -0
  51. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/dbd/slurmdbd.conf +35 -0
  52. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/docker-compose.yml +163 -0
  53. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/master/Dockerfile +24 -0
  54. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/master/docker-entrypoint.sh +6 -0
  55. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/munge/Dockerfile +19 -0
  56. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/munge/entrypoint.sh +5 -0
  57. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/node/Dockerfile +35 -0
  58. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/node/docker-entrypoint.sh +6 -0
  59. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/reframe/Dockerfile +49 -0
  60. reframe_hpc-4.10.0/examples/tutorial/dockerfiles/slurm-cluster/reframe/docker-entrypoint.sh +11 -0
  61. reframe_hpc-4.10.0/examples/tutorial/dummy/params.py +49 -0
  62. reframe_hpc-4.10.0/examples/tutorial/easybuild/eb_test.py +30 -0
  63. reframe_hpc-4.10.0/examples/tutorial/mpi/osu.py +111 -0
  64. reframe_hpc-4.10.0/examples/tutorial/mpi/osu_deps.py +126 -0
  65. reframe_hpc-4.10.0/examples/tutorial/scripts/runall.sh +23 -0
  66. reframe_hpc-4.10.0/examples/tutorial/spack/spack_test.py +27 -0
  67. reframe_hpc-4.10.0/examples/tutorial/stream/src/stream.c +585 -0
  68. reframe_hpc-4.10.0/examples/tutorial/stream/stream_build_run.py +33 -0
  69. reframe_hpc-4.10.0/examples/tutorial/stream/stream_config.yaml +18 -0
  70. reframe_hpc-4.10.0/examples/tutorial/stream/stream_cpuinfo.py +51 -0
  71. reframe_hpc-4.10.0/examples/tutorial/stream/stream_fixtures.py +46 -0
  72. reframe_hpc-4.10.0/examples/tutorial/stream/stream_make.py +51 -0
  73. reframe_hpc-4.10.0/examples/tutorial/stream/stream_multistep.py +52 -0
  74. reframe_hpc-4.10.0/examples/tutorial/stream/stream_parameters.py +51 -0
  75. reframe_hpc-4.10.0/examples/tutorial/stream/stream_parameters_fixtures.py +53 -0
  76. reframe_hpc-4.10.0/examples/tutorial/stream/stream_runonly.py +26 -0
  77. reframe_hpc-4.10.0/examples/tutorial/stream/stream_runonly_xfail.py +26 -0
  78. reframe_hpc-4.10.0/examples/tutorial/stream/stream_runonly_xfail_cond.py +31 -0
  79. reframe_hpc-4.10.0/examples/tutorial/stream/stream_variables.py +50 -0
  80. reframe_hpc-4.10.0/examples/tutorial/stream/stream_variables_fixtures.py +50 -0
  81. reframe_hpc-4.10.0/examples/tutorial/stream/stream_workflows.py +62 -0
  82. reframe_hpc-4.10.0/pyproject.toml +105 -0
  83. reframe_hpc-4.10.0/reframe/__init__.py +26 -0
  84. reframe_hpc-4.10.0/reframe/core/backends.py +72 -0
  85. reframe_hpc-4.10.0/reframe/core/buildsystems.py +1027 -0
  86. reframe_hpc-4.10.0/reframe/core/builtins.py +240 -0
  87. reframe_hpc-4.10.0/reframe/core/config.py +720 -0
  88. reframe_hpc-4.10.0/reframe/core/containers.py +302 -0
  89. reframe_hpc-4.10.0/reframe/core/decorators.py +248 -0
  90. reframe_hpc-4.10.0/reframe/core/deferrable.py +397 -0
  91. reframe_hpc-4.10.0/reframe/core/environments.py +340 -0
  92. reframe_hpc-4.10.0/reframe/core/exceptions.py +485 -0
  93. reframe_hpc-4.10.0/reframe/core/fields.py +206 -0
  94. reframe_hpc-4.10.0/reframe/core/fixtures.py +1061 -0
  95. reframe_hpc-4.10.0/reframe/core/hooks.py +214 -0
  96. reframe_hpc-4.10.0/reframe/core/launchers/__init__.py +153 -0
  97. reframe_hpc-4.10.0/reframe/core/launchers/local.py +18 -0
  98. reframe_hpc-4.10.0/reframe/core/launchers/mpi.py +198 -0
  99. reframe_hpc-4.10.0/reframe/core/launchers/rsh.py +39 -0
  100. reframe_hpc-4.10.0/reframe/core/logging.py +1186 -0
  101. reframe_hpc-4.10.0/reframe/core/meta.py +1007 -0
  102. reframe_hpc-4.10.0/reframe/core/modules.py +1045 -0
  103. reframe_hpc-4.10.0/reframe/core/namespaces.py +165 -0
  104. reframe_hpc-4.10.0/reframe/core/parameters.py +478 -0
  105. reframe_hpc-4.10.0/reframe/core/pipeline.py +3582 -0
  106. reframe_hpc-4.10.0/reframe/core/runtime.py +505 -0
  107. reframe_hpc-4.10.0/reframe/core/schedulers/__init__.py +731 -0
  108. reframe_hpc-4.10.0/reframe/core/schedulers/flux.py +153 -0
  109. reframe_hpc-4.10.0/reframe/core/schedulers/local.py +218 -0
  110. reframe_hpc-4.10.0/reframe/core/schedulers/lsf.py +150 -0
  111. reframe_hpc-4.10.0/reframe/core/schedulers/oar.py +200 -0
  112. reframe_hpc-4.10.0/reframe/core/schedulers/pbs.py +410 -0
  113. reframe_hpc-4.10.0/reframe/core/schedulers/registry.py +44 -0
  114. reframe_hpc-4.10.0/reframe/core/schedulers/sge.py +140 -0
  115. reframe_hpc-4.10.0/reframe/core/schedulers/slurm.py +825 -0
  116. reframe_hpc-4.10.0/reframe/core/schedulers/ssh.py +228 -0
  117. reframe_hpc-4.10.0/reframe/core/settings.py +97 -0
  118. reframe_hpc-4.10.0/reframe/core/shell.py +131 -0
  119. reframe_hpc-4.10.0/reframe/core/systems.py +737 -0
  120. reframe_hpc-4.10.0/reframe/core/variables.py +973 -0
  121. reframe_hpc-4.10.0/reframe/core/warnings.py +101 -0
  122. reframe_hpc-4.10.0/reframe/frontend/__init__.py +0 -0
  123. reframe_hpc-4.10.0/reframe/frontend/argparse.py +369 -0
  124. reframe_hpc-4.10.0/reframe/frontend/autodetect.py +288 -0
  125. reframe_hpc-4.10.0/reframe/frontend/ci.py +104 -0
  126. reframe_hpc-4.10.0/reframe/frontend/cli.py +1930 -0
  127. reframe_hpc-4.10.0/reframe/frontend/dependencies.py +273 -0
  128. reframe_hpc-4.10.0/reframe/frontend/executors/__init__.py +874 -0
  129. reframe_hpc-4.10.0/reframe/frontend/executors/policies.py +671 -0
  130. reframe_hpc-4.10.0/reframe/frontend/filters.py +126 -0
  131. reframe_hpc-4.10.0/reframe/frontend/loader.py +248 -0
  132. reframe_hpc-4.10.0/reframe/frontend/printer.py +303 -0
  133. reframe_hpc-4.10.0/reframe/frontend/reporting/__init__.py +801 -0
  134. reframe_hpc-4.10.0/reframe/frontend/reporting/storage.py +462 -0
  135. reframe_hpc-4.10.0/reframe/frontend/reporting/utility.py +449 -0
  136. reframe_hpc-4.10.0/reframe/frontend/testgenerators.py +245 -0
  137. reframe_hpc-4.10.0/reframe/schemas/config.json +733 -0
  138. reframe_hpc-4.10.0/reframe/schemas/junit.xsd +212 -0
  139. reframe_hpc-4.10.0/reframe/schemas/runreport.json +130 -0
  140. reframe_hpc-4.10.0/reframe/utility/__init__.py +1496 -0
  141. reframe_hpc-4.10.0/reframe/utility/color.py +91 -0
  142. reframe_hpc-4.10.0/reframe/utility/cpuinfo.py +299 -0
  143. reframe_hpc-4.10.0/reframe/utility/jsonext.py +145 -0
  144. reframe_hpc-4.10.0/reframe/utility/osext.py +967 -0
  145. reframe_hpc-4.10.0/reframe/utility/profile.py +90 -0
  146. reframe_hpc-4.10.0/reframe/utility/sanity.py +1059 -0
  147. reframe_hpc-4.10.0/reframe/utility/typecheck.py +488 -0
  148. reframe_hpc-4.10.0/reframe/utility/udeps.py +166 -0
  149. reframe_hpc-4.10.0/reframe/utility/versioning.py +91 -0
  150. reframe_hpc-4.10.0/share/completions/reframe.bash +46 -0
  151. reframe_hpc-4.10.0/share/completions/reframe.fish +17 -0
  152. reframe_hpc-4.10.0/share/completions/reframe.tcsh +1 -0
  153. reframe_hpc-4.10.0/tools/gendoclistings.py +350 -0
  154. reframe_hpc-4.10.0/tools/plot_pipeline_progress.py +42 -0
  155. reframe_hpc-4.10.0/tools/plot_poll_rate.py +89 -0
  156. reframe_hpc-4.10.0/tools/python/3.6/get-pip.py +27079 -0
  157. reframe_hpc-4.10.0/tools/python/3.7/get-pip.py +33038 -0
  158. reframe_hpc-4.10.0/tools/python/get-pip.py +28425 -0
  159. reframe_hpc-4.10.0/tools/requirements.txt +4 -0
@@ -0,0 +1,102 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ env/
12
+ build/
13
+ develop-eggs/
14
+ dist/
15
+ downloads/
16
+ eggs/
17
+ .eggs/
18
+ lib/
19
+ lib64/
20
+ parts/
21
+ sdist/
22
+ var/
23
+ *.egg-info/
24
+ .installed.cfg
25
+ *.egg
26
+
27
+ # Ignore Mac DS_Store files
28
+ .DS_Store
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *,cover
49
+ .hypothesis/
50
+
51
+ # Translations
52
+ *.mo
53
+ *.pot
54
+
55
+ # Django stuff:
56
+ *.log
57
+ local_settings.py
58
+
59
+ # Flask stuff:
60
+ instance/
61
+ .webassets-cache
62
+
63
+ # Scrapy stuff:
64
+ .scrapy
65
+
66
+ # Sphinx documentation
67
+ docs/_build/
68
+ docs/html/
69
+ docs/html/
70
+ .doctrees/
71
+
72
+ # PyBuilder
73
+ target/
74
+
75
+ # IPython Notebook
76
+ .ipynb_checkpoints
77
+
78
+ # pyenv
79
+ .python-version
80
+
81
+ # celery beat schedule file
82
+ celerybeat-schedule
83
+
84
+ # dotenv
85
+ .env
86
+
87
+ # virtualenv
88
+ venv*
89
+ .venv*
90
+ ENV/
91
+
92
+ # Spyder project settings
93
+ .spyderproject
94
+
95
+ # Rope project settings
96
+ .ropeproject
97
+
98
+ # TextMATE files
99
+ ._*
100
+
101
+ # Vim temp files
102
+ *.swp
@@ -0,0 +1,5 @@
1
+ # Contributing to ReFrame
2
+
3
+ We are glad to accept contributions to this project from interested parties.
4
+ You can contribute with new ReFrame tests, new features or bug fixes.
5
+ Before submitting your contribution, please have a look into our [coding style guide](https://github.com/reframe-hpc/reframe/wiki/Coding-Style-Guide) and our [contribution guidelines](https://github.com/reframe-hpc/reframe/wiki/Contributing-to-ReFrame).
@@ -0,0 +1,29 @@
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2016-2024, Swiss National Supercomputing Center (CSCS/ETH Zurich)
4
+ All rights reserved.
5
+
6
+ Redistribution and use in source and binary forms, with or without
7
+ modification, are permitted provided that the following conditions are met:
8
+
9
+ * Redistributions of source code must retain the above copyright notice, this
10
+ list of conditions and the following disclaimer.
11
+
12
+ * Redistributions in binary form must reproduce the above copyright notice,
13
+ this list of conditions and the following disclaimer in the documentation
14
+ and/or other materials provided with the distribution.
15
+
16
+ * Neither the name of the copyright holder nor the names of its
17
+ contributors may be used to endorse or promote products derived from
18
+ this software without specific prior written permission.
19
+
20
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,234 @@
1
+ Metadata-Version: 2.4
2
+ Name: reframe-hpc
3
+ Version: 4.10.0
4
+ Summary: ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems
5
+ Project-URL: documentation, https://reframe-hpc.readthedocs.io/
6
+ Project-URL: releasenotes, https://github.com/reframe-hpc/reframe/releases
7
+ Project-URL: repository, https://github.com/reframe-hpc/reframe
8
+ Project-URL: tracker, https://github.com/reframe-hpc/reframe/issues
9
+ Author: Swiss National Supercomputing Center (CSCS/ETH Zurich), ReFrame Project Developers
10
+ License-Expression: BSD-3-Clause
11
+ License-File: LICENSE
12
+ Keywords: benchmarking,continuous integration,framework,hpc,performance testing,regresion testing,validation testing
13
+ Classifier: Development Status :: 5 - Production/Stable
14
+ Classifier: Environment :: Console
15
+ Classifier: License :: OSI Approved :: BSD License
16
+ Classifier: Operating System :: MacOS
17
+ Classifier: Operating System :: POSIX :: Linux
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Programming Language :: Python :: 3.14
23
+ Requires-Python: >=3.10
24
+ Requires-Dist: archspec>=0.2.4
25
+ Requires-Dist: argcomplete~=3.6
26
+ Requires-Dist: clustershell~=1.9
27
+ Requires-Dist: fasteners~=0.20
28
+ Requires-Dist: jinja2~=3.1
29
+ Requires-Dist: jsonschema~=4.26
30
+ Requires-Dist: lxml~=6.0
31
+ Requires-Dist: polars~=1.39
32
+ Requires-Dist: pyyaml~=6.0
33
+ Requires-Dist: requests~=2.33
34
+ Requires-Dist: semver~=3.0
35
+ Requires-Dist: tabulate~=0.10
36
+ Provides-Extra: graylog
37
+ Requires-Dist: pygelf~=0.4; extra == 'graylog'
38
+ Description-Content-Type: text/markdown
39
+
40
+ <div align="left">
41
+ <img src="docs/_static/img/reframe_logo-width400p.png#gh-light-mode-only" width="400px">
42
+ <img src="docs/_static/img/reframe-logo-dark-bg.png#gh-dark-mode-only" width="400px">
43
+ </div>
44
+
45
+ [![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)
46
+ [![Documentation Status](https://readthedocs.org/projects/reframe-hpc/badge/?version=latest)](https://reframe-hpc.readthedocs.io/en/latest/?badge=latest)
47
+ [![codecov](https://codecov.io/gh/reframe-hpc/reframe/graph/badge.svg?token=OCsdagJHcX)](https://codecov.io/gh/reframe-hpc/reframe)<br/>
48
+ ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/reframe-hpc/reframe?include_prereleases)
49
+ ![GitHub commits since latest release](https://img.shields.io/github/commits-since/reframe-hpc/reframe/latest)
50
+ ![GitHub contributors](https://img.shields.io/github/contributors-anon/reframe-hpc/reframe)<br/>
51
+ [![PyPI version](https://badge.fury.io/py/ReFrame-HPC.svg)](https://badge.fury.io/py/ReFrame-HPC)
52
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/reframe-hpc)
53
+ [![Downloads](https://pepy.tech/badge/reframe-hpc)](https://pepy.tech/project/reframe-hpc)
54
+ [![Downloads](https://pepy.tech/badge/reframe-hpc/month)](https://pepy.tech/project/reframe-hpc)<br/>
55
+ [![Slack](https://badgen.net/badge/icon/slack?icon=slack&label)](https://join.slack.com/t/reframetalk/shared_invite/zt-3706f0tj6-2CjHh07HdQNbmLw1qAasjg)
56
+ [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
57
+ [![DOI](https://zenodo.org/badge/89384186.svg)](https://zenodo.org/badge/latestdoi/89384186)<br/>
58
+ [![Twitter Follow](https://img.shields.io/twitter/follow/ReFrameHPC?style=social)](https://twitter.com/ReFrameHPC)
59
+
60
+ # Overview
61
+
62
+ ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems.
63
+ 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.
64
+ This allows users to write portable tests in a declarative way that describes only the test's functionality.
65
+
66
+ Tests in ReFrame are simple Python classes that specify the basic variables and parameters of the test.
67
+ 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.
68
+ ReFrame will load the tests and send them down a well-defined pipeline that will execute them in parallel.
69
+ 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.
70
+
71
+ ReFrame also supports storing the test results in a database allowing for later inspection, basic analytics and performance comparisons.
72
+
73
+ Please visit the project's documentation [page](https://reframe-hpc.readthedocs.io/) for all the details!
74
+
75
+
76
+ ## Installation
77
+
78
+ ReFrame is fairly easy to install as PyPI package.
79
+
80
+ ```bash
81
+ # Fetch uv
82
+ curl -LsSf https://astral.sh/uv/install.sh | sh
83
+
84
+ # Install ReFrame
85
+ uv tool install reframe-hpc
86
+
87
+ # Check the installation
88
+ reframe -V
89
+ ```
90
+
91
+ This will place the `reframe` executable under `$HOME/.local/bin` and the package under `$HOME/.local/share/uv/tools/reframe-hpc`.
92
+ To make available the manpage and the shell completions add the following lines in your shell's profile script:
93
+
94
+ ### Bash/Zsh
95
+
96
+ Add the following lines to your `$HOME/.profile`:
97
+
98
+ ```bash
99
+ export MANPATH=${HOME}/.local/share/uv/tools/reframe-hpc/share/man:${MANPATH}:
100
+ source ${HOME}/.local/share/uv/tools/reframe-hpc/share/bash-completion/completions/reframe
101
+ ```
102
+
103
+ ### Fish
104
+
105
+ Add the following lines to your `$HOME/.config/fish/config.fish`:
106
+
107
+ ```bash
108
+ set -apgx MANPATH ${HOME}/.local/share/uv/tools/reframe-hpc/share/man ""
109
+ source ${HOME}/.local/share/uv/tools/reframe-hpc/share/fish/vendor_completions.d/reframe.fish
110
+ ```
111
+
112
+ > NOTE: Using `uv` is not required to install ReFrame.
113
+ > You can use any modern Python build system that recognizes the `pyproject.toml` file.
114
+
115
+ ### Multi-architecture installations on shared filesystem
116
+
117
+ If you plan to install ReFrame for multiple platforms in a shared installation, you should make sure each installation resides in a different prefix.
118
+ You can achieve this with `uv` as follows:
119
+
120
+ ```bash
121
+ export UV_TOOL_BIN_DIR=$HOME/.local/$(uname -m)/bin
122
+ export UV_TOOL_DIR=$HOME/.local/$(uname -m)/share/uv/tools
123
+ uv tool install reframe-hpc
124
+ export PATH=$UV_TOOL_BIN_DIR:$PATH
125
+ reframe -V
126
+ ```
127
+
128
+ Alternatively, you can use ephemeral venvs and let `uv` handle them with `uvx`:
129
+
130
+ ```bash
131
+ uvx reframe --version
132
+ ```
133
+
134
+ This will pull ReFrame's dependencies and run it.
135
+ It also caches them, so that the next time you invoke it, it will not download and install them again.
136
+ The only "downside" of this method is that you have to always invoke ReFrame through `uvx`, as opposed to the `uv tool install` method, where the `reframe` executable is installed in a standard path.
137
+
138
+
139
+ ## Running from source
140
+
141
+ If you want to run the latest ReFrame directly from the repo, you can simply clone the repo and `uv run` ReFrame:
142
+
143
+ ```bash
144
+ git clone https://github.com/reframe-hpc/reframe.git
145
+ cd reframe
146
+ uv run reframe --version
147
+ ```
148
+
149
+ ### Running the unit tests
150
+
151
+ To run the the framework's unit tests use the following command:
152
+
153
+ ```bash
154
+ uv sync --group dev
155
+ uv run ./test_reframe.py -v
156
+ ```
157
+
158
+ > NOTE: Unit tests require a POSIX-compliant C compiler (available through the `cc` command), as well as the `make` utility.
159
+
160
+ ### Building the documentation locally
161
+
162
+ You may also build the documentation locally:
163
+
164
+ ```bash
165
+ uv sync --group docs
166
+ uv run make -C docs
167
+ ```
168
+
169
+ For viewing it, you may do the following:
170
+
171
+ ```bash
172
+ cd docs/html
173
+ python3 -m http.server
174
+ ```
175
+
176
+ The documentation is now up on [localhost:8000](http://localhost:8000), where you can navigate with your browser.
177
+
178
+ ## Public test repositories
179
+
180
+ The ReFrame HPC [community Github page](https://github.com/reframe-hpc) provides mirror forks of interesting ReFrame test repositories maintained by various sites or projects.
181
+ You can use those tests as an additional guidance to implement your own tests.
182
+
183
+ If 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).
184
+
185
+ ## Contact
186
+
187
+ You can get in contact with the ReFrame community in the following ways:
188
+
189
+ ### Slack
190
+
191
+ Please 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.
192
+
193
+ > 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.
194
+
195
+ ## Contributing back
196
+
197
+ ReFrame is an open-source project and we welcome and encourage contributions!
198
+ Check out our Contribution Guide [here](https://github.com/reframe-hpc/reframe/wiki/contributing-to-reframe).
199
+
200
+ ## Citing ReFrame
201
+
202
+ You can cite ReFrame in publications as follows:
203
+
204
+ > 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.
205
+
206
+ The corresponding BibTeX entry is the following:
207
+
208
+ ```bibtex
209
+ @InProceedings{karakasis20a,
210
+ author = {Karakasis, Vasileios and Manitaras, Theofilos and Rusu, Victor Holanda and
211
+ Sarmiento-P{\'e}rez, Rafael and Bignamini, Christopher and Kraushaar, Matthias and
212
+ Jocksch, Andreas and Omlin, Samuel and Peretti-Pezzi, Guilherme and
213
+ Augusto, Jo{\~a}o P. S. C. and Friesen, Brian and He, Yun and Gerhardt, Lisa and
214
+ Cook, Brandon and You, Zhi-Qiang and Khuvis, Samuel and Tomko, Karen},
215
+ title = {Enabling Continuous Testing of {HPC} Systems Using {ReFrame}},
216
+ booktitle = {Tools and Techniques for High Performance Computing},
217
+ editor = {Juckeland, Guido and Chandrasekaran, Sunita},
218
+ year = {2020},
219
+ month = mar,
220
+ series = {Communications in Computer and Information Science},
221
+ volume = {1190},
222
+ pages = {49--68},
223
+ address = {Cham, Switzerland},
224
+ publisher = {Springer International Publishing},
225
+ doi = {10.1007/978-3-030-44728-1_3},
226
+ venue = {Denver, Colorado, USA},
227
+ eventdate = {2019-11-17/2019-11-18},
228
+ eventtitle = {{HUST} - Annual Workshop on {HPC} User Support Tools},
229
+ isbn = {978-3-030-44728-1},
230
+ issn = {1865-0937},
231
+ }
232
+ ```
233
+
234
+ For 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).
@@ -0,0 +1,195 @@
1
+ <div align="left">
2
+ <img src="docs/_static/img/reframe_logo-width400p.png#gh-light-mode-only" width="400px">
3
+ <img src="docs/_static/img/reframe-logo-dark-bg.png#gh-dark-mode-only" width="400px">
4
+ </div>
5
+
6
+ [![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)
7
+ [![Documentation Status](https://readthedocs.org/projects/reframe-hpc/badge/?version=latest)](https://reframe-hpc.readthedocs.io/en/latest/?badge=latest)
8
+ [![codecov](https://codecov.io/gh/reframe-hpc/reframe/graph/badge.svg?token=OCsdagJHcX)](https://codecov.io/gh/reframe-hpc/reframe)<br/>
9
+ ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/reframe-hpc/reframe?include_prereleases)
10
+ ![GitHub commits since latest release](https://img.shields.io/github/commits-since/reframe-hpc/reframe/latest)
11
+ ![GitHub contributors](https://img.shields.io/github/contributors-anon/reframe-hpc/reframe)<br/>
12
+ [![PyPI version](https://badge.fury.io/py/ReFrame-HPC.svg)](https://badge.fury.io/py/ReFrame-HPC)
13
+ ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/reframe-hpc)
14
+ [![Downloads](https://pepy.tech/badge/reframe-hpc)](https://pepy.tech/project/reframe-hpc)
15
+ [![Downloads](https://pepy.tech/badge/reframe-hpc/month)](https://pepy.tech/project/reframe-hpc)<br/>
16
+ [![Slack](https://badgen.net/badge/icon/slack?icon=slack&label)](https://join.slack.com/t/reframetalk/shared_invite/zt-3706f0tj6-2CjHh07HdQNbmLw1qAasjg)
17
+ [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
18
+ [![DOI](https://zenodo.org/badge/89384186.svg)](https://zenodo.org/badge/latestdoi/89384186)<br/>
19
+ [![Twitter Follow](https://img.shields.io/twitter/follow/ReFrameHPC?style=social)](https://twitter.com/ReFrameHPC)
20
+
21
+ # Overview
22
+
23
+ ReFrame is a powerful framework for writing system regression tests and benchmarks, specifically targeted to HPC systems.
24
+ 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.
25
+ This allows users to write portable tests in a declarative way that describes only the test's functionality.
26
+
27
+ Tests in ReFrame are simple Python classes that specify the basic variables and parameters of the test.
28
+ 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.
29
+ ReFrame will load the tests and send them down a well-defined pipeline that will execute them in parallel.
30
+ 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.
31
+
32
+ ReFrame also supports storing the test results in a database allowing for later inspection, basic analytics and performance comparisons.
33
+
34
+ Please visit the project's documentation [page](https://reframe-hpc.readthedocs.io/) for all the details!
35
+
36
+
37
+ ## Installation
38
+
39
+ ReFrame is fairly easy to install as PyPI package.
40
+
41
+ ```bash
42
+ # Fetch uv
43
+ curl -LsSf https://astral.sh/uv/install.sh | sh
44
+
45
+ # Install ReFrame
46
+ uv tool install reframe-hpc
47
+
48
+ # Check the installation
49
+ reframe -V
50
+ ```
51
+
52
+ This will place the `reframe` executable under `$HOME/.local/bin` and the package under `$HOME/.local/share/uv/tools/reframe-hpc`.
53
+ To make available the manpage and the shell completions add the following lines in your shell's profile script:
54
+
55
+ ### Bash/Zsh
56
+
57
+ Add the following lines to your `$HOME/.profile`:
58
+
59
+ ```bash
60
+ export MANPATH=${HOME}/.local/share/uv/tools/reframe-hpc/share/man:${MANPATH}:
61
+ source ${HOME}/.local/share/uv/tools/reframe-hpc/share/bash-completion/completions/reframe
62
+ ```
63
+
64
+ ### Fish
65
+
66
+ Add the following lines to your `$HOME/.config/fish/config.fish`:
67
+
68
+ ```bash
69
+ set -apgx MANPATH ${HOME}/.local/share/uv/tools/reframe-hpc/share/man ""
70
+ source ${HOME}/.local/share/uv/tools/reframe-hpc/share/fish/vendor_completions.d/reframe.fish
71
+ ```
72
+
73
+ > NOTE: Using `uv` is not required to install ReFrame.
74
+ > You can use any modern Python build system that recognizes the `pyproject.toml` file.
75
+
76
+ ### Multi-architecture installations on shared filesystem
77
+
78
+ If you plan to install ReFrame for multiple platforms in a shared installation, you should make sure each installation resides in a different prefix.
79
+ You can achieve this with `uv` as follows:
80
+
81
+ ```bash
82
+ export UV_TOOL_BIN_DIR=$HOME/.local/$(uname -m)/bin
83
+ export UV_TOOL_DIR=$HOME/.local/$(uname -m)/share/uv/tools
84
+ uv tool install reframe-hpc
85
+ export PATH=$UV_TOOL_BIN_DIR:$PATH
86
+ reframe -V
87
+ ```
88
+
89
+ Alternatively, you can use ephemeral venvs and let `uv` handle them with `uvx`:
90
+
91
+ ```bash
92
+ uvx reframe --version
93
+ ```
94
+
95
+ This will pull ReFrame's dependencies and run it.
96
+ It also caches them, so that the next time you invoke it, it will not download and install them again.
97
+ The only "downside" of this method is that you have to always invoke ReFrame through `uvx`, as opposed to the `uv tool install` method, where the `reframe` executable is installed in a standard path.
98
+
99
+
100
+ ## Running from source
101
+
102
+ If you want to run the latest ReFrame directly from the repo, you can simply clone the repo and `uv run` ReFrame:
103
+
104
+ ```bash
105
+ git clone https://github.com/reframe-hpc/reframe.git
106
+ cd reframe
107
+ uv run reframe --version
108
+ ```
109
+
110
+ ### Running the unit tests
111
+
112
+ To run the the framework's unit tests use the following command:
113
+
114
+ ```bash
115
+ uv sync --group dev
116
+ uv run ./test_reframe.py -v
117
+ ```
118
+
119
+ > NOTE: Unit tests require a POSIX-compliant C compiler (available through the `cc` command), as well as the `make` utility.
120
+
121
+ ### Building the documentation locally
122
+
123
+ You may also build the documentation locally:
124
+
125
+ ```bash
126
+ uv sync --group docs
127
+ uv run make -C docs
128
+ ```
129
+
130
+ For viewing it, you may do the following:
131
+
132
+ ```bash
133
+ cd docs/html
134
+ python3 -m http.server
135
+ ```
136
+
137
+ The documentation is now up on [localhost:8000](http://localhost:8000), where you can navigate with your browser.
138
+
139
+ ## Public test repositories
140
+
141
+ The ReFrame HPC [community Github page](https://github.com/reframe-hpc) provides mirror forks of interesting ReFrame test repositories maintained by various sites or projects.
142
+ You can use those tests as an additional guidance to implement your own tests.
143
+
144
+ If 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).
145
+
146
+ ## Contact
147
+
148
+ You can get in contact with the ReFrame community in the following ways:
149
+
150
+ ### Slack
151
+
152
+ Please 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.
153
+
154
+ > 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.
155
+
156
+ ## Contributing back
157
+
158
+ ReFrame is an open-source project and we welcome and encourage contributions!
159
+ Check out our Contribution Guide [here](https://github.com/reframe-hpc/reframe/wiki/contributing-to-reframe).
160
+
161
+ ## Citing ReFrame
162
+
163
+ You can cite ReFrame in publications as follows:
164
+
165
+ > 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.
166
+
167
+ The corresponding BibTeX entry is the following:
168
+
169
+ ```bibtex
170
+ @InProceedings{karakasis20a,
171
+ author = {Karakasis, Vasileios and Manitaras, Theofilos and Rusu, Victor Holanda and
172
+ Sarmiento-P{\'e}rez, Rafael and Bignamini, Christopher and Kraushaar, Matthias and
173
+ Jocksch, Andreas and Omlin, Samuel and Peretti-Pezzi, Guilherme and
174
+ Augusto, Jo{\~a}o P. S. C. and Friesen, Brian and He, Yun and Gerhardt, Lisa and
175
+ Cook, Brandon and You, Zhi-Qiang and Khuvis, Samuel and Tomko, Karen},
176
+ title = {Enabling Continuous Testing of {HPC} Systems Using {ReFrame}},
177
+ booktitle = {Tools and Techniques for High Performance Computing},
178
+ editor = {Juckeland, Guido and Chandrasekaran, Sunita},
179
+ year = {2020},
180
+ month = mar,
181
+ series = {Communications in Computer and Information Science},
182
+ volume = {1190},
183
+ pages = {49--68},
184
+ address = {Cham, Switzerland},
185
+ publisher = {Springer International Publishing},
186
+ doi = {10.1007/978-3-030-44728-1_3},
187
+ venue = {Denver, Colorado, USA},
188
+ eventdate = {2019-11-17/2019-11-18},
189
+ eventtitle = {{HUST} - Annual Workshop on {HPC} User Support Tools},
190
+ isbn = {978-3-030-44728-1},
191
+ issn = {1865-0937},
192
+ }
193
+ ```
194
+
195
+ For 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).