QA/QC with Speckle Automate: Workshop

Showcase!
, ,
1

Wait until Wednesday! The Speckle Automate Public Beta goes live then.

Hello Specklers! :tada:

At SpeckleCon 2024, our QA/QC Workshop was standing-room-only! This post serves as a reminder for those who attended and an overview for anyone eager to explore the materials covered.

:rotating_light: Important: This isn’t a full tutorial (yet). It’s a package of materials summarising what we explored during the workshop. While some in-person explanations are missing, it’s a solid starting point for those wanting to dive into QA/QC automation.

:video_camera: Note: A video walkthrough is in the works to provide a step-by-step guide—stay tuned!

image
image2400Ă—1600 477 KB

What Will You Learn?

This workshop introduces:

  • Deploying your first Speckle Automate function using the Public Beta.
  • Adding user-configurable inputs for adaptable automation.
  • Defining and validating rules directly in code.
  • Transitioning to spreadsheet-driven rule systems for collaboration and scalability.

Why This Matters

With the Public Beta of Speckle Automate, now is the perfect time to start building collaborative QA/QC workflows:

  • Customisable and Scalable: Adjust your validation rules without needing code changes.
  • Collaborative Workspaces: Private functions run securely in Workspaces, enabling shared workflows.
  • Future-Ready: Automate compliance checks, reporting, and more—all integrated with Speckle’s ecosystem.

What You’ll Need

  1. A verified Speckle account: Sign up here.
  2. A Workspaces-based project with at least one model containing Revit data.
  3. Basic Python knowledge and a Python-ready development environment.

How to Replicate the Workshop

Step 1: Create a Function Using the Speckle Automate Wizard

  1. Navigate to Speckle Automate.
  2. Click “New Function”.
  3. Follow the wizard:
    • Choose the Python template.
    • Add details like name, description, and optional tags (e.g., “QA/QC”, “Workshop”).
  4. Finish the wizard to create your function repository.

Step 2: Import Workshop Files Into Your Function Repository

  1. Open the function repository created by the wizard.
  2. Replace the default files with those from the QA/QC Workshop Repo.

Step 3: Follow the Workshop Exercises

  1. Access the slides here: Workshop Slides.
  2. Progress through the exercises:
    • :rocket: Exercise 0: From Zero to Deployment – Create and deploy your first function.
    • :trophy: Exercise 1: Adding Configuration – Users customise automation inputs.
    • :trophy: Exercise 2: QA/QC I – Define rules in code to extract and check properties.
    • :trophy: Exercise 3: QA/QC II – Implement flexible rule systems to validate design data.

Step 4: For Exercise 3 – Publish the Template Google Sheet

  1. Access the template Google Sheet: QAQC with Speckle Automate.
  2. Make a copy in your own Google account.
  3. Publish it as a Tab-Separated Values (TSV) file:
    • File → Share → Publish to the web → Select TSV.
    • Copy the published link.
  4. Use this link when running the function.

Step 5 (Optional): Learn About Local Testing

  • If you want to explore further:
    1. Use the repo files to set up the project on your local machine.
    2. Use the Speckle Python SDK to fetch live data.
    3. Test and debug your logic locally before redeploying.

This guide is the perfect primer for getting started with QA/QC workflows using Speckle Automate. Stay tuned for more resources and the upcoming video walkthrough.

Happy automating! :rocket:

2 Likes