OS API
Covalent server
Start the Covalent server.
Check if the Covalent server is running.
Stop the Covalent server.
Workflow Components
Electron decorator to be applied to a function.
Lattice decorator to be called upon a function.
QElectron decorator to be called upon a Pennylane QNode.
A cluster of quantum executors.
Bash decorator which wraps a Python function as a Bash Lepton.
Task Helper
Generic dependency class used in specifying any kind of dependency for an electron.
Dependencies
Shell commands to run before an electron.
Deps class to encapsulate python functions to be called in the same execution environment as the electron.
Deps Call
Python modules to be imported in an electron’s execution environment.
PyPI packages to be installed before executing an electron.
File Transfer from (source) and to (destination) local or remote files prior/post electron execution.
A set of classes with a shared interface to perform copy, download, and upload operations given two (source & destination) File objects that support various protocols.
Executors
Base executor class to be used for defining any executor plugin.
Async base executor class to be used for defining any executor plugin.
Dask executor class that submits the input function to a running dask cluster.
Local executor class that directly invokes the input function.
A collection of plugins that provide interfaces to various AWS services, enabling users to leverage the power and scalability of AWS for their tasks.
This executor plugin interfaces Covalent with AWS Batch which allows tasks in a covalent workflow to be executed as AWS batch jobs.
This plugin allows executing quantum circuits and quantum-classical hybrid jobs in Amazon Braket when you use Covalent.
This plugin allows tasks to be executed in an AWS EC2 instance (which is auto-created) when you execute your workflow with covalent.
AWS ECS offers very quick spin up times, this executor is a good fit for workflows with a large number of independent tasks that can be dispatched simultaneously.
This executor, users can execute tasks (electrons) or entire lattices using the AWS Lambda serverless compute service.
Covalent Azure Batch executor is an interface between Covalent and Microsoft Azure Batch.
Covalent Google Batch executor is an interface between Covalent and Google Cloud Platform’s Batch compute service.
This executor plugin interfaces Covalent with HPC systems managed by Slurm.
This executor plugin interfaces Covalent with other machines accessible to the user over SSH.
Quantum Executor Plugins
This quantum executor provides efficient access to IBM Quantum backends by using runtime sessions for submitting jobs.
This quantum executor accesses IBM Quantum backends through Pennylane's 'qiskit.ibmq' device.
This quantum executor accesses quantum resources operating under the qubit model as made available through AWS ('braket.aws.qubit').
This quantum executor accesses the local Braket quantum circuit simulator ('braket.local.qubit').
This quantum executor introduces thread- or process-based parallelism to Pennylane circuits that utilize simulation-based devices (like 'default.qubit' or 'lightning.qubit').
Dispatch Infrastructure
Wrapping the dispatching functionality to allow input passing and server address specification.
Execute a workflow triggered by a specific type of event
Cancel a running dispatch.
Get the results of a dispatch from the Covalent server.
Covalent CLI Tool
Covalent CLI tool used to manage the servers.
Default configuration for covalent can be set by defining the environment variable COVALENT_CONFIG_DIR. By default, config files are stored in ~/.config/covalent/covalent.conf.