Documentation

Sign In

Quickstart

Upload a job within five minutes.

Prerequisites

Before you begin, make sure you have:

  • A GitHub account for authentication
  • A machine running Ubuntu >= 20.04

Step 1: Sign In

  1. Navigate to the Compute Share dashboard
  2. Click Sign In and authenticate with your GitHub account

Step 2: Join an Organization

If you're the first member:

  1. Complete the account setup process
  2. Create your organization

If you're joining an existing organization:

  1. Enter the invite code you received from your administrator

Step 3. Install the CLI and Agent

Visit the Installation guide for details, but in short, run:

# Add repository to keyring
curl -fsSL ...
apt install -y polter

Step 3: Register a Machine

Go to the Machines page, and click Add Machine. Enter the code to register your machine

polter register --code 0123-4567

Your machine will now be available to submit and receive jobs from your organization.

Step 4: Initialize and Submit a Project

Navigate into the directory of a Python project. We provide a sample project here.

Initialize the project:

polter project init

(Optional but highly recommended) Test out the job locally:

polter project test

Submit a job:

polter project submit

Step 5: Monitor Progress

Track your job through the dashboard:

  1. Go to the Jobs page
  2. View your job's status
  3. Check logs and output when complete

Next Steps

Now that you're set up, explore more features:

Need Help?

If you encounter any issues during setup, check the Installation guide for detailed troubleshooting steps.