Skip to main content
The Python SDK is the customer-facing entry point for Hardsim.

​
Install

pip install hardsim

​
Core Methods

  • submit(...): create a cloud simulation job.
  • step(...): alias for submit-oriented cloud simulation call.
  • status(job_id): get current job state.
  • wait(job_id): poll until terminal state.
  • download(job_id, out_dir): download generated artifacts.
  • cancel(job_id): cancel queued/running jobs.
  • upload_input(local_path): upload local files and return an s3:// URI.

​
Environment Variables

  • HARDSIM_API_KEY (required)
  • HARDSIM_API_URL (production: https://api-sim.hardlightsim.com)
  • HARDSIM_HTTP_TIMEOUT_S
  • HARDSIM_HTTP_RETRIES
  • HARDSIM_HTTP_BACKOFF_S
Direct-S3 mode only (optional):
  • HARDSIM_INPUT_S3_BUCKET
  • HARDSIM_INPUT_S3_PREFIX
  • HARDSIM_INPUT_S3_REGION
  • HARDSIM_INPUT_S3_ENDPOINT_URL

​
Upload Behavior

  • Default: SDK uses POST /v0/inputs/presign-upload and uploads without AWS credentials.
  • Optional: set prefer_presigned=False (and configure bucket/AWS creds) to use direct-S3 upload.
job = hs.step(
    robot="s3://bucket/franka.urdf",
    scene="table_top_v0",
    num_envs=64,
    steps=2000,
    idempotency_key="train-run-42-shard-0001",
)

​
More Detail

  • SDK release process in repository: docs/sdk-release.md
  • SDK README in repository: sdk/README.md