Metadata-Version: 2.4
Name: a4x-orchestration
Version: 0.1.0rc1
Summary: Abstracts the process of configuring workflows for various workflow management systems (WMS)
Author-email: Ian Lumsden <ilumsden@vols.utk.edu>, Michela Taufer <mtaufer@utk.edu>
Maintainer-email: Ian Lumsden <ilumsden@vols.utk.edu>, Michela Taufer <mtaufer@utk.edu>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
           
           ---- LLVM Exceptions to the Apache 2.0 License ----
           
           As an exception, if, as a result of your compiling your source code, portions
           of this Software are embedded into an Object form of such source code, you
           may redistribute such embedded portions in such Object form without complying
           with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
           
           In addition, if you combine or link compiled forms of this Software with
           software that is licensed under the GPLv2 ("Combined Software") and if a
           court of competent jurisdiction determines that the patent provision (Section
           3), the indemnity provision (Section 9) or other Section of the License
           conflicts with the conditions of the GPLv2, you may retroactively and
           prospectively choose to deem waived or otherwise exclude such Section(s) of
           the License, but only in their entirety and only with respect to the Combined
           Software.
        
        
Project-URL: Repository, https://github.com/Analytics4MD/a4x-orchestration
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: importlib-metadata; python_version < "3.10"
Requires-Dist: StrEnum; python_version < "3.11"
Requires-Dist: ruamel.yaml==0.18.*
Requires-Dist: networkx
Requires-Dist: Jinja2
Requires-Dist: jsonschema~=4.23
Requires-Dist: referencing~=0.35
Dynamic: license-file

A4X-Orchestration

## About

A4X-Orchestration is a Python library that abstracts the process of configuring a workflow to be
agnostic of the workflow management system (WMS) used. When using A4X-Orchestration, users can configure their
workflow for any supported WMS by performing the following steps:
1. Define workflow tasks using A4X-Orchestration
2. Combine workflow tasks into a workflow represented as a DAG using A4X-Orchestration
3. Call A4X-Orchestration's `Workflow.convert` method to get a WMS-specific representation of the workflow
4. If desired, perform additional, WMS-specific configuration using the output of `Workflow.convert`

Support for different WMSes is (for the most part) not built directly into A4X-Orchestration. Instead, A4X-Orchestration
uses entry point-based plugins to support different WMSes. So, to use A4X-Orchestration with a specific
WMS, users must install the plugin for that WMS. Below is an unofficial list of all supported
WMSes and how to install them:

         Plugin Name
         Workflow Management System or
Resource Manager
         Install Command

         A4X Pegasus WMS
         Pegasus (https://pegasus.isi.edu/)
         pip install a4x-pegasus-wms

         Flux Plugin
         Flux (https://flux-framework.org/)
         N.A. (builtin)

## Dependencies

A4X-Orchestration has the following dependencies:
* Python 3.7 or newer
* [networkx](https://networkx.org/)
* [ruamel.yaml](https://pypi.org/project/ruamel.yaml/)
* [Jinja2](https://jinja.palletsprojects.com/en/stable/)
* [importlib-metadata](https://pypi.org/project/importlib-metadata/) (only for Python versions less than 3.10)

Note that most users should not have to install these manually. Most Python package managers (e.g., `pip`)
will automatically install all these dependencies (except Python itself) when you install A4X-Orchestration.

## Installation

There are two ways to install A4X-Orchestration: (1) with `pip` and (2) with Spack.

### (1) Pip

A4X-Orchestration can be installed like most other Python packages by simply running:
```bash
$ python3 -m pip install a4x-orchestration
```

Additionally, users can install A4X-Orchestration from source by cloning the repository and running:
```bash
$ python3 -m pip install [-e] .
```

### (2) Spack

Support for building with Spack is not yet implemented.

## Using in Other Projects

A4X-Orchestration can be used by other projects once installed by simply importing it with:
```python
from a4x.orchestration import ...
```

To make A4X-Orchestration a dependency of your project, simply add the following to `pyproject.toml`
for a `pip`-installable project:
```toml
[project]
dependencies = [
    "a4x-orchestration"
]
```

Or add the following to `package.py` for a Spack-installable project:
```python
depends_on("a4x-orchestration")
```



## Contact Us

A4X-Orchestration is part of the Analytics4X project from the [Global Computing Lab](https://globalcomputing.group/).
For more information, please contact Michela Taufer (email: taufer@acm.org).

## Copyright and License

Copyright 2025 Global Computing Lab.

A4X-Core is distributed under the terms of the [Apache License, Version 2.0](https://spdx.org/licenses/Apache-2.0.html)
with [LLVM Exceptions](https://spdx.org/licenses/LLVM-exception.html).

See [LICENSE](./LICENSE) and [COPYRIGHT](./COPYRIGHT) for more details.

SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

## Acknowledgements

This material is based upon work supported
by the US National Science Foundation under Grant No. 
2530461, 2513101, 2331152, 2223704, 2138811, and 2103845.

This work was performed under the auspices of the U.S. Department of Energy by Lawrence Livermore
National Laboratory under Contract DE-AC52-07NA27344 and was supported by the LLNL-LDRD Program
under Project No. 24-SI-005. 
