Metadata-Version: 2.1
Name: covalent
Version: 0.238.0
Summary: Covalent Workflow Tool
Home-page: https://github.com/AgnostiqHQ/covalent
Download-URL: https://github.com/AgnostiqHQ/covalent/archive/v0.238.0.tar.gz
Author: Agnostiq
Author-email: support@agnostiq.ai
Maintainer: Agnostiq
License: Apache License 2.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Adaptive Technologies
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Distributed Computing
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiofiles>=0.8.0
Requires-Dist: aiohttp>=3.8.1
Requires-Dist: alembic>=1.8.0
Requires-Dist: boto3>=1.26.110
Requires-Dist: click>=8.1.3
Requires-Dist: cloudpickle>=2.0.0
Requires-Dist: dask[distributed]>=2022.6.0
Requires-Dist: fastapi>=0.100.0
Requires-Dist: filelock>=3.12.2
Requires-Dist: furl>=2.1.3
Requires-Dist: natsort>=8.4.0
Requires-Dist: networkx>=2.8.6
Requires-Dist: psutil>=5.9.0
Requires-Dist: pydantic>=2.1.1
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: python-socketio>=5.7.1
Requires-Dist: requests>=2.24.0
Requires-Dist: rich<=13.3.5,>=12.0.0
Requires-Dist: sqlalchemy<2.0.0,>=1.4.37
Requires-Dist: sqlalchemy_utils>=0.38.3
Requires-Dist: toml>=0.10.2
Requires-Dist: typing-extensions>=4.8.0
Requires-Dist: uvicorn[standard]
Requires-Dist: watchdog>=2.2.1
Provides-Extra: aws
Requires-Dist: boto3>=1.20.48; extra == "aws"
Provides-Extra: azure
Requires-Dist: azure-identity>=1.13.0; extra == "azure"
Requires-Dist: azure-storage-blob>=12.16.0; extra == "azure"
Provides-Extra: braket
Requires-Dist: amazon-braket-pennylane-plugin>=1.17.4; extra == "braket"
Requires-Dist: boto3>=1.28.5; extra == "braket"
Provides-Extra: gcp
Requires-Dist: google-auth>=2.16.2; extra == "gcp"
Requires-Dist: google-cloud-storage>=2.7.0; extra == "gcp"
Provides-Extra: mysql
Requires-Dist: mysqlclient>=2.1.1; extra == "mysql"
Provides-Extra: postgres
Requires-Dist: psycopg2-binary>=2.9.5; extra == "postgres"
Provides-Extra: qiskit
Requires-Dist: pennylane-qiskit==0.30; extra == "qiskit"
Requires-Dist: qiskit==0.43.1; extra == "qiskit"
Requires-Dist: qiskit-ibm-provider==0.6.1; extra == "qiskit"
Requires-Dist: qiskit-ibm-runtime==0.10.0; extra == "qiskit"

<div align="center">
  <img src="./doc/source/_static/banner_executor.gif" alt="hero" />
</div>
</br>
<div align="center">

[![version](https://img.shields.io/github/v/tag/AgnostiqHQ/covalent?color=%235552FF&include_prereleases&label=version&sort=semver)](https://github.com/AgnostiqHQ/covalent/blob/develop/CHANGELOG.md)
[![Static Badge](https://img.shields.io/badge/python-3.8_%7C_3.9_%7C_3.10-%235552FF)](#)
[![Static Badge](https://img.shields.io/badge/tests-passing-%235552FF?logo=github)](https://github.com/AgnostiqHQ/covalent/actions/workflows/tests.yml)
[![Static Badge](https://img.shields.io/badge/docs-passing-%235552FF)](https://docs.covalent.xyz/docs/)
[![Static Badge](https://img.shields.io/badge/codecov-88%25-%235552FF?logo=codecov)](https://codecov.io/gh/AgnostiqHQ/covalent)
[![apache](https://img.shields.io/badge/License-Apache_License_2.0-blue?color=%235552FF)](https://www.apache.org/licenses/LICENSE-2.0)</div>

<div align="center"><b>Run AI, ML, and Scientific Research Code on Any Cloud or On-Prem Cluster with a Single Line</b></div>
</br>
 <div align="center">
<a href="https://docs.covalent.xyz/docs/get-started/quick-start"><img src="./doc/source/_static/getting_started.svg" width="150" alt="divider"></a>
&nbsp&nbsp
<a href="https://docs.covalent.xyz/docs/"><img src="./doc/source/_static/documentation.svg" alt="divider" width="150"></a>
&nbsp&nbsp
<a href="https://docs.covalent.xyz/docs/user-documentation/tutorials/"><img src="./doc/source/_static/examples.svg" alt="divider" width="105"></a>
&nbsp&nbsp
<a href="https://covalentworkflows.slack.com/join/shared_invite/zt-1ew7f2rfk-dKSXVQmRniu5mQW4Z_eQuw#/shared-invite/email"><img src="./doc/source/_static/slack.svg" alt="divider" width="70"></a>
</div>
</br>


```bash
pip install covalent --upgrade
```
Check our [Quick Start Guide](https://docs.covalent.xyz/docs/get-started/quick-start/) for setup instructions or dive into your [First Experiment](https://docs.covalent.xyz/docs/get-started/first-experiment/). Learn more on the [Concepts](https://docs.covalent.xyz/docs/user-documentation/concepts/concepts-index/).

### What is Covalent?

Covalent is a Python library for AI/ML engineers, developers, and researchers. It provides a straightforward approach to running compute jobs, like LLMs, generative AI, and scientific research, on various cloud platforms or on-prem clusters.


<details>
<summary><i><b>Run Code Anywhere:</b> Execute Python functions in any cloud or on-prem cluster by changing just a single line of code.</i></summary>
<br>

It is as simple as swapping the decorator with our executor plugins. Choose from [existing plugins](https://docs.covalent.xyz/docs/plugin) or [create custom ones](https://github.com/AgnostiqHQ/covalent-executor-template) for tailored interactions with any infrastructure.
<div align="center"><img src="./doc/source/_static/executors_ship.png"  width="700"></div>
</details>

<details>
<summary><i><b>Abstraction of Infrastructure Management:</b> Abstract the complexities of cloud consoles, terraform, or IaC in the background.</i> </summary>
<br>
<div align="center"><img src="./doc/source/_static/abstract_infra.png"  width="700"></div>
</details>

<details>
<summary><i><b>Serverless Infrastructure:</b> Automatically converts any infrastructure, including on-prem SLURM clusters or cloud compute, into a serverless setup.</i></summary>
<br>
<div align="center"><img src="./doc/source/_static/serverless-illustration.png"  width="700"></div>
</details>


If you find Covalent useful or interesting, feel free to give us a ⭐ on GitHub! Your support helps us to continue developing and improving this framework.


</br>
<table border="0">
 <tr>
    <td><b style="font-size:18px; padding-right: 20px;">For AI/ML Practitioners and Developers</b></td>
    <td><b style="font-size:18px; padding-left: 20px;">For Researchers</b></td>
 </tr>
 <tr>
    <td valign="top">
        <ul style="font-size:16px; list-style-type: circle; padding-right: 20px;">
            <li><b>Robust Compute Backend:</b> Ideal as a backend compute framework for AI/ML applications, Large Language Models (LLMs), Generative AI, and more.</li>
            <li><b>Cloud-Agnostic Execution:</b> Execute high-compute tasks seamlessly across different cloud environments.</li>
            <li><b>Infrastructure Abstraction:</b> Directly use computing resources while keeping your business code independent from the infrastructure/resource definitions.</li>
        </ul>
    </td>
    <td valign="top">
        <ul style="font-size:16px; list-style-type: circle; padding-left: 20px;">
            <li><b>Local-Like Access:</b> Effortlessly connect to compute resources from your laptop, eliminating the need for SSH or complex scripts.</li>
            <li><b>Unified Interface Across Environments:</b> Consistent experience with on-prem HPC clusters and cloud platforms like SLURM, PBS, LSF, AWS, GCP, Azure.</li>
            <li><b>Real-Time Monitoring Monitoring:</b> <a href="http://demo.covalent.xyz/"> User-friendly UI </a> for real-time monitoring, enabling cost-effective and iterative R&D.</li>
        </ul>
    </td>
 </tr>
</table>

### Out-of-box observability - [Try out the demo](http://demo.covalent.xyz/)

If you find Covalent useful or interesting, feel free to give us a ⭐ on GitHub! Your support helps us to continue developing and improving this framework.

<!-- https://github.com/AgnostiqHQ/covalent/assets/116076079/87268cc8-4d53-4053-b739-1d03f2eafa7c -->
<div align="center">
  <img src="./doc/source/_static/readmeVid-gif.gif" alt="video" />
</div>



### Explore Covalent Through Examples

Jump right into practical examples to see Covalent in action. These tutorials cover a range of applications, giving you a hands-on experience:

<div align="center">
  <a href="https://docs.covalent.xyz/docs/user-documentation/tutorials/generativeai/">
    <img src="./doc/source/_static/ai_tutorial.svg" alt="AI Tutorial">
  </a>
  <a href="https://docs.covalent.xyz/docs/user-documentation/tutorials/mnist/">
    <img src="./doc/source/_static/mnist_tutorial.svg" alt="MNIST Tutorial">
  </a>
  <a href="https://docs.covalent.xyz/docs/user-documentation/tutorials/quantumchemistry/">
    <img src="./doc/source/_static/quantum_tutorial.svg" alt="Quantum Tutorial">
  </a>
</div>

### Explore Our Extensive Plugin Ecosystem

Covalent integrates seamlessly with a variety of platforms. Discover our range of plugins to enhance your Covalent experience:

</br>
  <div align="center">
<a href="https://docs.covalent.xyz/docs/user-documentation/api-reference/executors/aws-plugins/"><img src="./doc/source/_static/aws.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/user-documentation/api-reference/executors/azurebatch/"><img src="./doc/source/_static/azure.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/user-documentation/api-reference/executors/gcp/"><img src="./doc/source/_static/google.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs"><img src="./doc/source/_static/kubernetes.svg" alt="divider"></a>
</div>
<div align="center"><a href="https://docs.covalent.xyz/docs/user-documentation/api-reference/executors/slurm/"><img src="./doc/source/_static/slurm.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/user-documentation/api-reference/executors/dask/"><img src="./doc/source/_static/dask.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/user-documentation/api-reference/executors/ibmq/"><img src="./doc/source/_static/ibmq.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/plugin"><img src="./doc/source/_static/many_more.svg" alt="divider"></a></div>

### Key Features at a Glance

Get a quick overview of what Covalent offers. Our infographic summarizes the main features, providing you with a snapshot of our capabilities:

</br>
  <div align="center">
  <a href="https://docs.covalent.xyz/docs/"><img src="./doc/source/_static/development.svg"  alt="development"></img></a>
 </div>

</br>

---

### Know More About Covalent

For a more in-depth description of Covalent's features and how they work, see the [Concepts](https://docs.covalent.xyz/docs/user-documentation/concepts/concepts-index/) page in the documentation.

</br>

<div align="center">
<a href="https://www.covalent.xyz/what-is-covalent/"><img src="./doc/source/_static/what_is_covalent.svg" alt="divider"></a>
<a href="https://www.covalent.xyz/navigating-the-modern-hpc-landscape/"><img src="./doc/source/_static/cloud_hpc.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/user-documentation/concepts/covalent-basics/"><img src="./doc/source/_static/concepts_of_covalent.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/user-documentation/concepts/covalent-arch/covalent-architecture"><img src="./doc/source/_static/covalent_work.svg" alt="divider"></a>
</div>

<div >

### Installation

Covalent is developed using Python on Linux and macOS. The easiest way to install Covalent is by using the PyPI package manager.

```
pip install covalent --upgrade
```

For other methods of installation, please [check the docs.](https://docs.covalent.xyz/docs/get-started/install/)

**Deployments**

<div>
Covalent offers flexible deployment options, from Docker image/AMIs for self-hosting to pip package for local installations, accommodating various use cases
</div>

</br>

<div align="center">

<a href="https://docs.covalent.xyz/docs/user-documentation/server-deployment"><img src="./doc/source/_static/local-laptop.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/user-documentation/sd-docker"><img src="./doc/source/_static/onprem_hosted.svg" alt="divider"></a>
<a href="https://docs.covalent.xyz/docs/user-documentation/sd-systemd"><img src="./doc/source/_static/cloud_hosted.svg" alt="divider"></a>

</div>

</br>
</div>

### Contributing

 <!-- <div><img src="./contributing_heading.svg" alt="divider"></div> -->

To contribute to Covalent, refer to the [Contribution Guidelines](https://github.com/AgnostiqHQ/covalent/blob/master/CONTRIBUTING.md). We use GitHub's [issue tracking](https://github.com/AgnostiqHQ/covalent/issues) to manage known issues, bugs, and pull requests. Get started by forking the `develop` branch and submitting a pull request with your contributions. Improvements to the documentation, including tutorials and how-to guides, are also welcome from the community. For more information on adding tutorials, check the [Tutorial Guidelines](https://github.com/AgnostiqHQ/covalent/blob/master/doc/TUTORIAL_GUIDELINES.md). Participation in the Covalent community is governed by the [Code of Conduct](https://github.com/AgnostiqHQ/covalent/blob/master/CODE_OF_CONDUCT.md).

### Citation

Please use the following citation in any publications.

[https://doi.org/10.5281/zenodo.5903364](https://zenodo.org/records/8369670)

### License

Covalent is licensed under the Apache 2.0 License. See the [LICENSE](https://github.com/AgnostiqHQ/covalent/blob/master/LICENSE) file or contact the [support team](mailto:support@aqnostic.ai) for more details.

For a detailed history of changes and new features, see the [Changelog](https://github.com/AgnostiqHQ/covalent/blob/master/CHANGELOG.md).
