Get Started#
To get started with Coiled, follow these steps:
1. Sign up#
Sign up for Coiled using GitHub, Google, or by making your own username and password.
Sign up with Google2. Install Coiled#
Install the Coiled client Python library with pip or conda.
pip install coiled "dask[complete]"
coiled login
This will redirect you to the Coiled website to authenticate your computer. It will also save your token on your computer (see API Tokens).
3. Start using Coiled#
Run the coiled quickstart CLI command to get started with Coiled
$ coiled quickstart
╭──────────────────────────────────────────────────────────────────────────────╮
│ Welcome! │
│ │
│ Welcome to Coiled, a lightweight cloud computing platform! │
│ To get started we'll go through these steps: │
│ │
│ 1 ✅ Login to Coiled │
│ 2 Run "Hello world" │
│ 3 Choose larger examples to run like: │
│ • Process 1 TB of Parquet data │
│ • Train a PyTorch model on a GPU │
│ • Churn through 2 TB of geospatial data │
│ • And more... │
╰──────────────────────────────────────────────────────────────────────────────╯
Or run Coiled yourself anywhere you run Python
import coiled
import dask
# Create a cluster with 15 workers
cluster = coiled.Cluster(n_workers=15)
client = cluster.get_client()
# Run a sample computation
df = dask.datasets.timeseries("2000", "2005", partition_freq="2W").persist()
result = df.groupby("name").agg({"x": "sum", "y": "max"}).compute()
This runs within a very small allocation within our cloud account.
4. Connect to Your Cloud#
Next, you’ll likely want to connect Coiled to run within your own cloud account.
New accounts initially run in a small cloud account managed by Coiled. Moving to your own cloud gives you better access to your data, more security, and a larger free tier allocation ($500 vs $10)
Coiled creates the IAM policies and network configuration for your account, asking you for permission at each step.
coiled setup aws
Alternatively, configure Coiled with custom network configuration (e.g. pre-existing VPC). This is more common for larger organization than for individuals.
coiled setup aws --manual-final-setup
Coiled creates the IAM policies and network configuration for your account, asking you for permission at each step.
coiled setup gcp
Alternatively, configure Coiled with custom network configuration (e.g. pre-existing VPC). This is more common for larger organization than for individuals.
coiled setup gcp --manual-final-setup
Coiled on Azure is currently in public beta.
Our setup CLI will create the service account and network resources for running Coiled in your Azure subscription.
coiled setup azure
We’re also happy to chat if you have any special requirements for Azure permissions, network configuration, or anything else! Please contact support@coiled.io if you have any questions or problems.
For more details, refer to the Coiled Get Started Guide.