Covalent Cloud API

Welcome to the Covalent Cloud SDK API documentation. This section will guide you through the key functions that our SDK provides.

Contents

Account Management

cc.save_api_key

Saves the API key to the config file.

cc.get_api_key

Get the API key to the config file.

Workflow

ct.electron

Electron decorator to be applied to a function. Returns the wrapper function with the same functionality as _func*.

covalent.leptons.bash

Bash decorator which wraps a Python function as a Bash Lepton.

@ct.lattice

Lattice decorator to be called upon a function Returns a new Lattice <covalent._workflow.lattice.Lattice> object.

ct.wait

Instructs Covalent that an electron should wait for some other tasks to complete before it is dispatched.

class covalent._file_transfer.file.File

File Transfer from (source) and to (destination) local or remote files prior/post electron execution. Instances are are provided to files keyword argument in an electron decorator

class covalent.DepsCall

Functions, shell commands, PyPI packages, and other types of dependencies to be called in an electron’s execution environment

class covalent.DepsBash

Deps class to encapsulate Bash dependencies for an electron.

Execution

cc.dispatch

The dispatch function takes a Covalent workflow, also called a lattice, and sends it to the Covalent Cloud Server for execution.

cc.get_result

Gets the result of a Covalent workflow that has been dispatched to the cloud.

Compute Resources

cc.CloudExecutor

CloudExecutor represents a configuration for executing a Covalent workflow on the Covalent Cloud.

Execution Environment

cc.create_env

Sends the create request to the Covalent Cloud server with the environment dependency list.

Secret Management

cc.store_secret

Stores a new secret in the Covalent Cloud.

cc.delete_secret

Deletes a specific secret from the Covalent Cloud.

cc.list_secrets

Retrieves a list of all stored secrets in the Covalent Cloud.

Persistent Storage

cc.volume

Creates or retrieves a persistent storage volume in Covalent Cloud.