Get Started with Peach in Minutes

Setting up your HPC environment has never been this easy. Follow these simple steps to go from installation to running your first job. For more details, dive into our comprehensive documentation.

Read the Full Documentation

1. Install Peach CLI

Download and install the Peach CLI with a single command. We support macOS, Linux, and Windows (via WSL). This script adds the Peach binary to your system path.

$curl -fsSL https://install.peach.lat | sh

2. Configure Your Cluster

Create a `config.yaml` file to define your cluster specifications, cloud provider credentials, and other settings like instance types and node counts.

$# config.yaml
cluster_name: "my-hpc-cluster"
region: "us-east-2"
instance_size: "t3.large"
node_count: 5
# ... and more options

3. Create and Start a Cluster

With your configuration file ready, run a single command to provision the entire cluster and start the Slurm services. Peach handles all the underlying cloud resources for you.

$peach --config config.yaml --create

4. Submit Your First Job

Submit your job script to the cluster and monitor its status. Results can be automatically uploaded to S3 upon completion if configured.

$peach --submit-job --job-file my_analysis.slurm

5. Estimate Job Cost (Optional)

Before running a large-scale job, estimate its cost to stay within budget. This helps in planning and resource allocation.

$peach --estimate-cost --job-duration 120 --instance-count 10

6. Destroy Your Cluster

When your work is finished, tear down the entire cluster with a single command to stop incurring cloud costs. Use with caution!

$peach --destroy