././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1717059854.3851166
JUBE-2.7.1/ 0000775 0001747 0001747 00000000000 14626040416 014433 5 ustar 00gitlab-runner gitlab-runner ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/AUTHORS 0000664 0001747 0001747 00000001073 14626040416 015504 0 ustar 00gitlab-runner gitlab-runner # This is the list of JUBE's significant contributors.
#
# This does not necessarily list everyone who has contributed code,
# especially since many employees of one corporation may be contributing.
# To see the full list of contributors, see the revision history in
# source control.
Forschungszentrum Jülich GmbH
Alexander Trautmann
Alexandre Strube
Andreas Herten
Andreas Klasen
Carina Himmels
Filipe Guimarães
Jan-Oliver Mirus
Julia Wellmann
Kay Thust
Sebastian Achilles
Sebastian Lührs
Thomas Breuer
Wolfgang Frings
Yannik Müller
Universiteit Gent
Andy Georges
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/CITATION.cff 0000664 0001747 0001747 00000001617 14626040416 016332 0 ustar 00gitlab-runner gitlab-runner cff-version: 1.2.0
title: JUBE
message: 'If you use this software, please cite it as below.'
type: software
authors:
- family-names: Breuer
given-names: Thomas
orcid: 'https://orcid.org/0000-0003-3979-4795'
- family-names: Wellmann
given-names: Julia
orcid: 'https://orcid.org/0000-0001-6631-8220'
- family-names: Souza Mendes Guimarães
given-names: Filipe
orcid: 'https://orcid.org/0000-0002-5618-6727'
- family-names: Himmels
given-names: Carina
orcid: 'https://orcid.org/0009-0009-8095-7112'
- family-names: Luehrs
given-names: Sebastian
orcid: 'https://orcid.org/0000-0001-8496-8630'
identifiers:
- type: doi
value: 10.5281/zenodo.7534372
description: The concept DOI of this software
repository-code: 'https://github.com/FZJ-JSC/JUBE'
url: 'https://www.fz-juelich.de/jsc/jube'
license: GPL-3.0-or-later
contact:
- email: jube.jsc@fz-juelich.de ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/CODE_OF_CONDUCT.md 0000664 0001747 0001747 00000012566 14626040416 017244 0 ustar 00gitlab-runner gitlab-runner
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement
[here](jube.jsc@fz-juelich.de).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/CONTRIBUTING.md 0000664 0001747 0001747 00000015547 14626040416 016700 0 ustar 00gitlab-runner gitlab-runner # Contributing to JUBE
If you are interested in doing so, you can:
- [Send feedback](#send-feedback)
- [Contribute to Code](#contribute-to-code)
We are happy to receive them!
## Send Feedback
Report any bugs or send us requests [here](https://github.com/FZJ-JSC/JUBE/issues).
Please try to avoid duplications and describe your feedback as best as possible.
Alternatively, you can contact the JSC JUBE developers via the following email address:
[jube.jsc@fz-juelich.de](mailto:jube.jsc@fz-juelich.de)
## Contribute to Code
You are welcome to contribute to JUBE's code! To do so, please fork the repository on [GitHub](https://github.com/FZJ-JSC/JUBE) and create a pull request (PR). Contributions should follow the following rules:
1. We suggest to follow some [Guidelines for Contributions](#guidelines-for-contributions) (we also try to follow them, although not always successfully)
2. The code is currently distributed under the GPLv3 License
3. You should **agree to the [Contributors License Agreement](#jube-contributor-license-agreement)**
### Guidelines for Contributions
Please, try to follow these guidelines for your code contributions:
- Add comments when possible
- Use clean code
- Use 4 spaces for indentation
- Update the documentation in `docs` and make sure it is properly formatted
- Update the `docs/glossar.rst` file (Don't forget to update the `general structure` section if necessary)
- Update the `docs/commandline.rst` file if you have modified or added command line options
- Adapt `contrib/schema/*` files and yaml converter corresponding to newly developed options
- Conform the source code to pep8, for example with `autopep8`
- Add new examples within `examples`, if there are new features
- Extend `docs/release_notes.rst` with small sentence about new feature, change or fix information
- Extend and execute testsuite `tests/run_all_tests.py` and debug if necessary
- Update the `AUTHORS` file if necessary
- Prefer to use `git rebase` instead of `git merge`, to keep a cleaner commit history
- Test your code before sending a PR
### JUBE Contributor License Agreement
Thank you for your interest in contributing to JUBE ("We" or "Us").
The purpose of this contributor agreement is to clarify and document the rights granted by contributors to Us.
To make this document effective, please follow the instructions below.
#### How to use this CLA
If You do not own the Copyright in the entire work of authorship, any other author of the Contribution must also sign this.
If you contribute outside of any legal obligations towards third parties, you may do so without the additional steps below.
If You are an employee and have created the Contribution as part of your employment, You need to have Your employers approval as a Legal Entity.
If you are a Legal Entity you must provide and update a list of your employees that will contribute to the Material, as well as your contact information. All contributions of employees must be individualy attributable to each one.
#### Definitions
"You" means the individual Copyright owner who Submits a Contribution to Us.
"Legal Entity" means an entity that is not a natural person.
"Contribution" means any original work of authorship, including any original modifications or additions to an existing work of authorship, Submitted by You to Us, in which You own the Copyright.
"Copyright" means all rights protecting works of authorship, including copyright, moral and neighboring rights, as appropriate, for the full term of their existence.
"Material" means the software or documentation made available by Us to third parties. When this Agreement covers more than one software project, the Material means the software or documentation to which the Contribution was Submitted. After You Submit the Contribution, it may be included in the Material.
"Submit" means any act by which a Contribution is transferred to Us by You by means of tangible or intangible media, including but not limited to electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Us, but excluding any transfer that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
"Documentation" means any non-software portion of a Contribution.
#### Rights and Obligations
You hereby grant to Us a worldwide, royalty-free, non-exclusive, perpetual and irrevocable license, with the right to transfer an unlimited number of licenses or to grant sublicenses to third parties, under the Copyright covering the Contribution to use the Contribution by all means.
We agree to (sub)license the Contribution or any Materials containing it, based on or derived from your Contribution non-exclusively under the terms of any licenses the Free Software Foundation classifies as Free Software License, and which are approved by the Open Source Initiative as Open Source licenses.
#### Copyright
You warrant, that you are legitimated to license the Contribution to us.
#### Acceptance of the CLA
By submitting your Contribution via the Repository you accept this agreement.
#### Liability
Except in cases of willful misconduct or physical damage directly caused to natural persons, the Parties will not be liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the Material, including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss of data or any commercial damage. However, the Licensor will be liable under statutory product liability laws as far such laws apply to the Material.
#### Warranty
The Material is a work in progress, which is continuously being improved by numerous Contributors. It is not a finished work and may therefore contain defects or "bugs" inherent to this type of development. For the above reason, the Material is provided on an "as is" basis and without warranties of any kind concerning the Material, including without limitation, merchantability, fitness for a particular purpose, absence of defects or errors, accuracy, non-infringement of intellectual property rights other than copyright.
#### Miscellaneous
This Agreement and all disputes, claims, actions, suits or other proceedings arising out of this agreement or relating in any way to it shall be governed by the laws of Germany excluding its private international law provisions. If any provision of this Agreement is found void and unenforceable, such provision will be replaced to the extent possible with a provision that comes closest to the meaning of the original provision and that is enforceable. The terms and conditions set forth in this Agreement shall apply notwithstanding any failure of essential purpose of this Agreement or any limited remedy to the maximum extent possible under law. You agree to notify Us of any facts or circumstances of which You become aware that would make this Agreement inaccurate in any respect. ././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1717059854.3731167
JUBE-2.7.1/JUBE.egg-info/ 0000775 0001747 0001747 00000000000 14626040416 016652 5 ustar 00gitlab-runner gitlab-runner ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/JUBE.egg-info/PKG-INFO 0000664 0001747 0001747 00000003634 14626040416 017755 0 ustar 00gitlab-runner gitlab-runner Metadata-Version: 2.1
Name: JUBE
Version: 2.7.1
Summary: JUBE Benchmarking Environment
Home-page: www.fz-juelich.de/ias/jsc/jube
Author: Forschungszentrum Juelich GmbH
Author-email: jube.jsc@fz-juelich.de
License: GPLv3
Download-URL: www.fz-juelich.de/ias/jsc/jube
Keywords: JUBE Benchmarking Environment
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.2
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Benchmark
Classifier: Topic :: Software Development :: Testing
License-File: LICENSE
License-File: AUTHORS
Automating benchmarks is important for reproducibility and hence comparability which is the major intent when performing benchmarks. Furthermore managing different combinations of parameters is error-prone and often results in significant amounts work especially if the parameter space gets large.
In order to alleviate these problems JUBE helps performing and analyzing benchmarks in a systematic way. It allows custom work flows to be able to adapt to new architectures.
For each benchmark application the benchmark data is written out in a certain format that enables JUBE to deduct the desired information. This data can be parsed by automatic pre- and post-processing scripts that draw information, and store it more densely for manual interpretation.
The JUBE benchmarking environment provides a script based framework to easily create benchmark sets, run those sets on different computer systems and evaluate the results. It is actively developed by the Juelich Supercomputing Centre of Forschungszentrum Juelich, Germany.
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/JUBE.egg-info/SOURCES.txt 0000664 0001747 0001747 00000006476 14626040416 020553 0 ustar 00gitlab-runner gitlab-runner AUTHORS
CITATION.cff
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
RELEASE_NOTES
setup.py
JUBE.egg-info/PKG-INFO
JUBE.egg-info/SOURCES.txt
JUBE.egg-info/dependency_links.txt
JUBE.egg-info/requires.txt
JUBE.egg-info/top_level.txt
bin/jube
bin/jube-autorun
contrib/schema/jube.dtd
contrib/schema/jube.json
contrib/schema/jube.rnc
contrib/schema/jube.xsd
docs/JUBE.pdf
examples/cycle/cycle.xml
examples/cycle/cycle.yaml
examples/dependencies/dependencies.xml
examples/dependencies/dependencies.yaml
examples/do_log/do_log.xml
examples/do_log/do_log.yaml
examples/do_log/loreipsum1
examples/do_log/loreipsum2
examples/do_log/loreipsum3
examples/do_log/loreipsum4
examples/do_log/loreipsum5
examples/duplicate/duplicate.xml
examples/duplicate/duplicate.yaml
examples/environment/environment.xml
examples/environment/environment.yaml
examples/files_and_sub/file.in
examples/files_and_sub/files_and_sub.xml
examples/files_and_sub/files_and_sub.yaml
examples/hello_world/hello_world.xml
examples/hello_world/hello_world.yaml
examples/include/include_data.xml
examples/include/include_data.yaml
examples/include/main.xml
examples/include/main.yaml
examples/iterations/iterations.xml
examples/iterations/iterations.yaml
examples/jobsystem/job.run.in
examples/jobsystem/jobsystem.xml
examples/jobsystem/jobsystem.yaml
examples/parallel_workpackages/parallel_workpackages.xml
examples/parallel_workpackages/parallel_workpackages.yaml
examples/parameter_dependencies/include_file.xml
examples/parameter_dependencies/include_file.yaml
examples/parameter_dependencies/parameter_dependencies.xml
examples/parameter_dependencies/parameter_dependencies.yaml
examples/parameter_update/parameter_update.xml
examples/parameter_update/parameter_update.yaml
examples/parameterspace/parameterspace.xml
examples/parameterspace/parameterspace.yaml
examples/result_creation/result_creation.xml
examples/result_creation/result_creation.yaml
examples/result_database/result_database.xml
examples/result_database/result_database.yaml
examples/result_database/result_database_filter.xml
examples/scripting_parameter/scripting_parameter.xml
examples/scripting_parameter/scripting_parameter.yaml
examples/scripting_pattern/scripting_pattern.xml
examples/scripting_pattern/scripting_pattern.yaml
examples/shared/shared.xml
examples/shared/shared.yaml
examples/statistic/statistic.xml
examples/statistic/statistic.yaml
examples/tagging/tagging.xml
examples/tagging/tagging.yaml
examples/yaml/hello_world.yaml
examples/yaml/special_values.yaml
jube/__init__.py
jube/analyser.py
jube/benchmark.py
jube/completion.py
jube/conf.py
jube/fileset.py
jube/help.py
jube/help.txt
jube/info.py
jube/jubeio.py
jube/log.py
jube/main.py
jube/parameter.py
jube/pattern.py
jube/result.py
jube/step.py
jube/substitute.py
jube/workpackage.py
jube/result_types/__init__.py
jube/result_types/database.py
jube/result_types/genericresult.py
jube/result_types/keyvaluesresult.py
jube/result_types/syslog.py
jube/result_types/table.py
jube/util/__init__.py
jube/util/output.py
jube/util/util.py
jube/util/version.py
jube/util/yaml_converter.py
platform/lsf/platform.xml
platform/lsf/submit.job.in
platform/moab/chainJobs.sh
platform/moab/platform.xml
platform/moab/submit.job.in
platform/pbs/chainJobs.sh
platform/pbs/platform.xml
platform/pbs/submit.job.in
platform/slurm/chainJobs.sh
platform/slurm/platform.xml
platform/slurm/submit.job.in ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/JUBE.egg-info/dependency_links.txt 0000664 0001747 0001747 00000000001 14626040416 022720 0 ustar 00gitlab-runner gitlab-runner
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/JUBE.egg-info/requires.txt 0000664 0001747 0001747 00000000007 14626040416 021247 0 ustar 00gitlab-runner gitlab-runner pyyaml
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/JUBE.egg-info/top_level.txt 0000664 0001747 0001747 00000000005 14626040416 021377 0 ustar 00gitlab-runner gitlab-runner jube
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/LICENSE 0000664 0001747 0001747 00000104513 14626040416 015444 0 ustar 00gitlab-runner gitlab-runner GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1717059854.3851166
JUBE-2.7.1/PKG-INFO 0000664 0001747 0001747 00000003634 14626040416 015536 0 ustar 00gitlab-runner gitlab-runner Metadata-Version: 2.1
Name: JUBE
Version: 2.7.1
Summary: JUBE Benchmarking Environment
Home-page: www.fz-juelich.de/ias/jsc/jube
Author: Forschungszentrum Juelich GmbH
Author-email: jube.jsc@fz-juelich.de
License: GPLv3
Download-URL: www.fz-juelich.de/ias/jsc/jube
Keywords: JUBE Benchmarking Environment
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.2
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Benchmark
Classifier: Topic :: Software Development :: Testing
License-File: LICENSE
License-File: AUTHORS
Automating benchmarks is important for reproducibility and hence comparability which is the major intent when performing benchmarks. Furthermore managing different combinations of parameters is error-prone and often results in significant amounts work especially if the parameter space gets large.
In order to alleviate these problems JUBE helps performing and analyzing benchmarks in a systematic way. It allows custom work flows to be able to adapt to new architectures.
For each benchmark application the benchmark data is written out in a certain format that enables JUBE to deduct the desired information. This data can be parsed by automatic pre- and post-processing scripts that draw information, and store it more densely for manual interpretation.
The JUBE benchmarking environment provides a script based framework to easily create benchmark sets, run those sets on different computer systems and evaluate the results. It is actively developed by the Juelich Supercomputing Centre of Forschungszentrum Juelich, Germany.
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/README.md 0000664 0001747 0001747 00000010261 14626040416 015712 0 ustar 00gitlab-runner gitlab-runner
[](https://doi.org/10.5281/zenodo.7534372)
[](https://www.gnu.org/licenses/gpl-3.0)
# What is JUBE?
The JUBE benchmarking environment provides a script-based framework for easily
creating benchmark and workflow sets, running those sets on different computer
systems, and evaluating the results.
It is actively developed by the [Juelich Supercomputing Centre](https://www.fz-juelich.de/en/ias/jsc).
It focuses on managing the complexity of combinatorial benchmarks and ensuring reproducibility of the benchmarks.
JUBE provides support for different workflows and the ability to use vendor-supplied platform configurations.
The benchmark configuration and scripts can be specified in either YAML or XML format.
JUBE is primarily designed for use on supercomputers with *scheduding* systems
like Slurm or PBS, but also works on laptops running Linux or MacOS operating systems.
## Documentation
JUBE is not (yet) available on `pypi` (it is work in progress).
The source code can be downloaded from any of the following places:
- [GitHub](https://github.com/FZJ-JSC/JUBE)
- [JSC JUBE Webpage](https://www.fz-juelich.de/en/ias/jsc/services/user-support/software-tools/jube/download)
JUBE can be installed using `pip` or `setup.py` and needs *python 3.2* or higher.
You will also need *SQLite* version 3.35.0 (or higher) to use the database as a result output.
Installation instructions can be found [here](https://apps.fz-juelich.de/jsc/jube/docu/tutorial.html#installation).
The documentation for JUBE is split into Beginner Tutorial, Advanced Tutorial,
FAQ, CLI, and Glossary and can be found in the
**[User Guide](https://apps.fz-juelich.de/jsc/jube/docu/index.html)**.
In addition to the documentation, there are also
[tutorial examples](examples)
which are described in the tutorials of the user guide and
[benchmark examples](https://github.com/FZJ-JSC/jube-configs), which are curated
examples of JUBE benchmarks (the latter will be either replaced or
updated/extended soon).
For more information on the design and architecture of JUBE, please refer to
this [paper](https://ebooks.iospress.nl/DOI/10.3233/978-1-61499-621-7-431).
## Community and Contributing
JUBE is an open-source project and we welcome your questions, discussions and contributions.
Questions can be asked directly to the JSC JUBE developers via mail to
[jube.jsc@fz-juelich.de](mailto:jube.jsc@fz-juelich.de) and issues can be
reported in the issue tracker.
We also welcome contributions in the form of pull requests.
Contributions can include anything from bug fixes and documentation to new features.
JUBE development is currently still taking place on an internal GitLab instance.
However, we are in a transition phase to move development to GitHub. The complete
move will take some time. In the meantime, we will decide individually how to
proceed with Pull Requests opened on GitHub. Before you start implementing new
features, we would recommended to contact us, as we still have several open
branches in GitLab.
- **[GitHub Issue Tracker](https://github.com/FZJ-JSC/JUBE/issues)**
- **[Github Discussions](https://github.com/FZJ-JSC/JUBE/discussions)**
- **[GitHub Pull Requests](https://github.com/FZJ-JSC/JUBE/pulls)**
Please ensure that your contributions to JUBE are compliant with the
[contribution](CONTRIBUTING.md),
[developer](https://apps.fz-juelich.de/jsc/jube/docu/devel.html) and
[community](CODE_OF_CONDUCT.md) guidelines.
# Citing JUBE
If you use JUBE in your work, please cite the
[software release](https://zenodo.org/records/7534372)
and the [paper](https://ebooks.iospress.nl/DOI/10.3233/978-1-61499-621-7-431).
# Acknowledgments
We gratefully acknowledge the support of the following research projects and
institutions in the development of JUBE and for granting compute time to develop JUBE.
- UNSEEN (BMWi project, ID: 03EI1004A-F)
- Gauss Centre for Supercomputing e.V. (www.gauss-centre.eu) and the John von
Neumann Institute for Computing (NIC) on the GCS Supercomputer JUWELS at
Jülich Supercomputing Centre (JSC)
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1717059854.0
JUBE-2.7.1/RELEASE_NOTES 0000664 0001747 0001747 00000065773 14626040416 016430 0 ustar 00gitlab-runner gitlab-runner Release notes
*************
Version 2.7.1
=============
Release: 2024-05-30
* Added: GitLab-CI tests for *make* commands.
* Added: *jube continue* test for tagging example.
* Fixed: Only in the case of *jube run*, check that there is a tag
attribute description for tags that are not used in the input file.
* Fixed: Glossar and *jube help*.
Version 2.7.0
=============
Release: 2024-05-21
* Added: New ** tag, which includes the ** tag to write a
description for each tag specified in the input file.
* Added: New command *jube tag* to print out the tag description of a
given input file or benchmark directory.
* Added: A new operator *^* (exclusive disjunction (*xor*)) for the
*tag* attribute and **.
* Added: New *primekey* attribute for the *key*-tag of the *database*
to define whether this *key* is a primary key of the database or
not. Can be set to *true* or *false* (default: *false*).
* Added: New environment variable *JUBE_VERBOSE* to set the verbosity
level.
* Added: Warning when the current verbosity level from the command
line or environment variable is out of range.
* Added: New environment variable *JUBE_BENCHMARK_OUTPATH* to set the
benchmark outpath.
* Added: New command line option *--outpath* of *jube run* to specify
the benchmark outpath.
* Changed: The *jube info* command now also shows information about
all sets, steps, analyser and result from the *configuration.xml*.
* Changed: The *outpath* attribute of the ** tag no longer
needs to be specified in the input file if either the command line
option *--outpath* is set or the new environment variable
*JUBE_BENCHMARK_OUTPATH* is used. The command line option overrides
the environment variable, which in turn overrides the attribute in
the input file.
* Changed: The modified convert type warning is only logged to the
*analyse.log* file and no longer printed to the console output.
* Changed: If the *title* attribute of a ** ** is set,
then this title is used as the name of the database column instead
of the parameter or pattern name.
* Changed: The ** tag is now a subelement of the new
** tag.
* Changed: Changed the name of the source directory from *jube2* to
*jube* and adapted the code to the name change. The links to the
documentation on the websites have also been adjusted accordingly.
* Deprecated: The *primekeys* attribute of the ** is no
longer supported. Use the new *primekey* attribute of the
** ** instead.
* Deprecated: ** will no longer be supported on a global
level. Instead, it should be specified in the ** tag.
* Removed: Comma character (*,*) is no longer supported in
** and the *tag* attribute. Instead use *|*, *^* *+* and
*!*.
* Fixed: Allow YAML scripts to include a list of nested parametersets
with *!include*.
* Fixed: Allow YAML scripts to use the *tag* attribute in the **
of the **-tag.
Version 2.6.2
=============
Release: 2024-04-05
* Added: *CONTRIBUTING.md* file
* Added: New *parameter* named *jobname* in *parameterset*
*systemParameter* of file *platform/slurm/platform.xml* to modify
the value of the *--job-name* argument in *submit.job*. During
substitution in *executesub*, quotes are added around the value of
*jobname*.
* Added: Test to verify that a *step* with a *do* operation that
contains a *done_file* has been successfully executed.
* Added: *CODE_OF_CONDUCT.md* file
* Added: JUBE logo in svg and eps format
* Fixed: Resolved deprecation warnings
* Fixed: Parameters of a dependent step with an update_mode *step* are
updated when a *jube continue* is executed.
* Fixed: Allow YAML and XML scripts to include paths per *include* in
*include-path*.
* Fixed: Use correct *continue* log file for parallel *step*
execution.
* Deprecated: Comma character (*,*) will not be supported anymore in
*tag* attributes. Instead use *|*, *+* and *!*.
* Changed: The *unit* of a *parameter* or *pattern* will also be
displayed in the results output when a *title* is specified.
* Changed: Redesign of the *README.md* file
* Changed: Colors on website
Version 2.6.1
=============
Release: 2023-11-28
* Added: CITATION.cff file
* Added: New argument *-w* for command line option *jube info* to
print information about the given workpackage.
* Fixed: Overwrite the *sub* with the same *source*, so that the
substitution with *init_with* will work again.
* Changed: The *substitute_tests* has been adapted so that the tests
fail when the bug fixed in this release occurs.
Version 2.6.0
=============
Release: 2023-11-16
* Added: New option **, which allows you to specify tags
that must be set for the script to run.
* Added: New optional *mode* attribute to the *sub*-tag, allowing
*regex* substitution as an alternative to *text*-based substitution.
The latter remains the default.
* Added: The *jube result* command line call has been extended by the
options *--select* and *--exclude* to show and hide selected result
columns.
* Added: New command line option *jube output* to print out the path
and the contents of the files stdout and stderr.
* Added: A new *unit* attribute to *parameter*, which has the same
function as the *unit* attribute of *pattern*.
* Added: New jube variable *$jube_wp_status* which contains the status
of the current workpackage at the time the variable is evaluated.
* Added: New YAML schema file.
* Added: Missing *database*-tag to dtd, rnc and xsd schema files.
(Issue #1 on GitHub)
* Added: A validity check by use of the pip package ruamel.yaml is
introduced. This package is used if it is installed. Otherwise,
there will be no validity check for yaml files.
* Fixed: The *include-path* for YAML scripts and added an usage
example to the advanced tutorial. (Issue #2 on GitHub)
* Fixed: *export* of an empty *parameter*. (Issue #3 on GitHub)
* Fixed: Backward compatibility for floating number value definitions
of parameters of type int was restored such that only warning
messages are printed in this case.
* Fixed: Typos and bugs in the glossary and the help message.
* Changed: The *files_and_sub*, *parallel_workpackages*,
*result_creation*, *result_database* and *tagging* example has been
updated.
* Changed: The *jube complete* help output was debugged.
* Changed: The tests for the examples have been completely rewritten
to avoid using *run.log* files.
* Changed: Improved CI: separated tests and automatic tasks for
releases.
Version 2.5.1
=============
Release: 2022-08-24
* The default behaviour of replacing two parameters with different
options without throwing an error was restored.
* The testing suite was extended.
* The schema files were corrected such that they contain the duplicate
option.
Version 2.5.0
=============
Release: 2022-08-22
* Several independent workpackages within a step can be executed by
multiple processes in parallel by stating
*procs=#number_of_parallel_processes#* within the *step* tag. An
example and a documentation entry was added.
* A result database can be produced by use of the *database* tag. An
example and a documentation entry was added.
* *python2*-support was removed.
* A couple of unittests were added which now include the testing of
most of the examples.
* Sample *run.log* of most examples were added to
*tests/examples_output*.
* Some yaml example scripts were corrected.
* The MANIFEST file was removed.
* A typo in the error message was fixed.
* Fix result command documentation.
* A wrong result entry in the glossary was fixed.
* A bug for the usage of a newline separator within yaml scripts is
resolved.
* A feature to create a do_log file for every workpackage of a step is
integrated. The do_log file contains the whole environment while
execution, the execution shell, the change of current work
directories, comments if a directive was executed in a shared
fashion and the do directives of the steps.
* The execution cancels now, when a parameter is of type int or float
and the parameter value has not the form of a int or float
correspondingly.
* The FAQ documentation was extended with yaml examples.
* The option duplicate for parametersets and parameters was
introduced.
Version 2.4.3
=============
Release: 2022-07-20
* Fixes a bug related to ** and *init-with* combinations.
* *JUBE_EXEC_SHELL* is now also taken into account during parameter
evaluation.
* *jube status* now also returns *ERROR* state.
* Fixes a bug of using *$$* in shell commands.
* Updates *SLURM* *gres* default value in platform files.
* Fixes a bug of having a list of benchmarks in YAML format.
Version 2.4.2
=============
Release: 2021-11-30
* JUBE will raise an error if an changed *work_dir* contains unknown
variables.
* A bug was solved which enabled *dotall="true"* by default for all
pattern, which can make those costly to evaluate.
* Fixes a bug in result data processing.
* Fixes a bug in YAML input format if *benchmark* key is not used.
* A empty value in YAML input format will now be treated liek an empty
String not as a *None* value.
* Avoid crash due to overflow error for huge pattern values.
* Fixes a bug, which blocked *include* blocks to include other
*include* blocks.
* *setup.py* now moves all additional non-code data to
*.../share/jube*, which allows better utilization of *pip* based
installation
Version 2.4.1
=============
Release: 2021-02-09
* A bug was solved, if a benchmark used the older *,*-separated *tag=*
format in contrast to the new layout introduced in *version 2.2.2*.
* A warning message in context of newer *YAML* versions was removed.
* A Python3 problem inside the *YAML* parser was solved.
* A bug was solved, which was raised if the benchmark was started on a
different filesystem then the one which was configured within
*outpath*.
* The *jube* base script within *bin* will now use *python3* by
default. This is necessary as many newer systems does not have a
"standard" *python* defined by default. In addition the additional
script *jube-python2* is now available, which utilizes *python2*. So
far Python 2 is still fully supported but can be seen deprecated and
future versions of *JUBE* might break the Python 2 backwards
compatibility.
* All *style=pretty* tables in *JUBE* will now use a markdown like
format to allow easier integration within other tools.
Version 2.4.0
=============
Release: 2020-07-03
* New *YAML* based *JUBE* input format. The existing *XML* format
still stays available. Both formats cover the same amount of
features. If you plan to use *YAML* based *JUBE* input files, you
have to add the pyyaml-module to your *Python* module library. See
also Input format
* New "" attribute: "error_file="..."". In contrast to the
existing "done_file" this file handle can be used to mark a broken
asynchronous execution (the job templates in the "platform" folder
were updated accordingly)
* The "analyse" step is now automatically called when a result is
shown and if it was not executed before (instead of showing an error
message).
* New option "--workpackage" for "remove" command line sub command.
Allows to remove an individual workpackage from a benchmark. See
also: Restart a workpackage execution
* New "table" output format: "aligned"
Version 2.3.0
=============
Release: 2019-11-07
* New command line option "-s {pretty,csv}, --style {pretty,csv}" for
the "result" command allows to overwrite the selected table style
* New command line option "-o OUTPATH, --outpath OUTPATH" for the
"run" command allows to overwrite the selected outpath for the
benchmark run
* New parameter modes: "env" and "tag"
* "mode="env": include the content of an available environment
variable
* "mode="tag": include the tag name if the tag was set during
execution, otherwise the content is empty
* New option "dotall=true" in "" (default: "false") allows
that "." within a regular expression also matches newline
characters. This can be very helpfull to extract a line only after a
specific header was mentioned. See Extract data from a specifc text
block
* "--tags" used in combination with the "--update" option will now be
added to the existing tags of the original run instead of
overwriting the old tags. If no new tags need to be added within an
update "--tags" can now be skipped.
* "parse.log" is now automatically moved into the specifc job run
folder and is also available within the "jube log" command
Version 2.2.2
=============
Release: 2019-02-04
* New "tag" handling: Tags can now be mixed by using boolean
operations ("+" for and, "|" for or), brackets are allowed as well.
Old "," separated lists of tags are automatically converted. See
Tagging
* Extend parameter update documentation. See Parameter update
* Platform files were renamed (system specific to queuing system
specific)
* Fix "$jube_wp_relpath" and "$jube_wp_abspath" if *JUBE* is executed
from a relative directory
* Fixed missing or wrong environment variable evaluation within *JUBE*
parameters
* Fix for derived pattern handling if no match for regular pattern was
found
* Fix default value handling for derived pattern
* Fix unicode decoding problems for environment variables
Version 2.2.1
=============
Release: 2018-06-22
* Allow separator selection when using the "jube info ... -c" option
* Fix internal handling if a script parameter or a template is
evaluated to an empty value
* Fix for different Python3 parsing conflicts
Version 2.2.0
=============
Release: 2017-12-21
* New feature: step cycles. See Step cycle
* New parameter "update_mode". See Parameter update
* Result creation by scanning multiple steps now automatically creates
a combined output
* Speed up of the *JUBE* internal management if a large number of work
packages is used
* *JUBE* 1 conversion tool is not available any more
* New general commandline option "--strict" stops *JUBE* if there is a
version mismatch
* Broken analysis files will now be ignored
* Fix combination of "active" and "shared"
* Fix sorting problem for multiple result columns
* Fix parameter problem, if the continue command is used and the
parameter holds a value having multiple lines
Version 2.1.4
=============
Release: 2016-12-20
* "--id" indices on the commandline can now be negative to count from
the end of the available benchmarks
* *JUBE* now allows a basic auto completion mechanism if using *BASH*.
To activate: "eval "$(jube complete)""
* Fix result sorting bug in Python3
* New "jube_benchmark_rundir" variable which holds the top level
*JUBE* directory (the absolute "outpath" directory)
* Fix CSV output format, if parameter contain linebreaks.
* "active" attribute can now be used in "", "" and
""
* New FAQ entry concerning multiple file analysis: Frequently Asked
Questions
* "" using "mode="shell"" or "mode="perl"" will now stop
program execution if an error occurs (similar to "mode="python"")
* "" specfic "work_dir" is now created automatically if needed
* "directory" attribute in "" and "" was renamed to
"source_dir" (old attribute name is still possible)
* "source_dir" now allows parameter substitution
* New attribute "target_dir" in "" and "" to specify the
target directory path prefix
Version 2.1.3
=============
Release: 2016-09-01
* Fix broken CSV table output style
* Fix "jube_wp_..." parameter handling bug, if these parameter are
used inside another script parameter
* Added new optional argument "suffix="..."" to the "" tag
* Parameter are allowed inside this argument string.
* The evaluated string will be attached to the default workpackage
directory name to allow users to find specific directories in an
easier way (e.g. "000001_stepname_suffix" ).
* The *XML* schema files can now be found inside the "contrib" folder
* Added new advanced error handling
* JUBE will not stop any more if an error occurs inside a "run" or
"continue". The error will be marked and the corresponding
workpackage will not be touched anymore.
* There is also a "-e"/"--exit" option to overwrite this behaviour
to directly exit if there is an error.
Version 2.1.2
=============
Release: 2016-07-29
* The internal parameter handling is much faster now, especially if a
large number of parameter is used within the same step.
* Fix critical bug when storing environment variables. Environment
variables wasn't read correctly inside a step if this step was only
executed after a "jube continue" run.
* Fix bug inside a "" if it contains any linebreak
* Quotes are added automatically inside the "$jube_wp_envstr" variable
to support spaces in the environment variable argument list
* Combining "-u" and "tags" in a "jube result" run will not filter the
result branches anymore
* Allow lowercase "false" in bool expressions (e.g. the "active"
option)
* Fix bug when using *JUBE* in a *Python3.x* environment
* The "jube help" output was restructed to display separate key
columns instead of a keyword list
* "" can now contain a "default=..." attribute which set
their default value if the pattern can't be found or if it can't be
evaluated
* "null_value=..." was removed from the "" and ""-tag
because the new default attribute matches its behaviour
* Added first *JUBE* FAQ entries to the documentation: Frequently
Asked Questions
* New "active"-attribute inside a ""-tag. The attribute enables
or disables the corresponding step (and all following steps). It can
contain any bool expression and available parameter.
* Fix bug in "" handling if an alternative link name is used
which points to a sub directory
* Added new option "-c / --csv-parametrization" to "jube info" command
to show a workpackage specfic parametrisation by using the CSV
format (similar to the existing "-p" option)
* Allow Shell expansion in "" tags. "" now also support
the "*"
* Restructure internal "" and "" handling
* All example platform files were updated an simplified
Version 2.1.1
=============
Release: 2016-04-14
* *JUBE* will now show only the latest benchmark result by default, "
--id all" must be used to see all results
* Bool expressions can now be used directly in the ""
attribute
* Added "filter" attribute in "
" and "" to show only
specifix result entries (based on a bool expression)
* New "" and "" mode: "mode="shell""
* Allow multiline output in result tables
* Fix wrong group handling if "JUBE_GROUP_NAME" is used
* Scripting parameter (e.g. "mode="python"") can now handle $ to allow
access to environment variables
* Fix $$ bug ($$ were ignored when used within a parameter)
* Fix "$jube_wp_parent_..._id" bug if "$jube_wp_parent_..._id" is used
within another parameter
* Fix bug in std calculation when creating statistical result values
* Fix bug if tags are used within ""
Version 2.1.0
=============
Release: 2015-11-10
* Fix slow verbose mode
* Fix empty debug output file
* Fix broken command line "--include-path" option
* Allow recursive "" and "" handling
(additional include-paths can now be included by using the
"" tag)
* Allow multiple "" and "" areas
* New "transpose="true"" attribute possible in "