Step 1: Set up your workspace#

This tutorial will walk you through the steps to set up your workspace so that you’ll be able to write and publish your own Workflows.

To simplify the setup process for this tutorial, you’ll write and deploy your Workflows using Codespaces, a cloud-based development environment hosted by GitHub that we’ve pre-configured to include the Artificial SDK.

Create a GitHub account#

  1. Create a GitHub account associated with your company email.

  2. Optional: To promote standardization and collaboration in the lab automation community, Workflows is a community platform. However, we understand that some users prefer to maintain anonymity and privacy. In these cases, you can opt out of being publicly listed on shared community Artificial repos.

    To do this, in GitHub, turn off Settings ‣ Notifications ‣ Automatically watch repositories.

    Note

    Repositories with your workflows are private and not public to the community.

  3. Provide your GitHub User ID to your Customer Success Manager.

Create a Codespace#

  1. Open the link to your GitHub Repo from your Customer Success Manager.

  2. Create a branch for your work so it doesn’t conflict with anybody else’s. For example: “name/tutorial”.

  3. Click the green button labeled <> Code and then the green button labeled Create codespace on name/tutorial. This step may take a few minutes to complete.

Connect your Codespace to Artificial#

  1. Copy the URL of the Artificial instance that you want to connect to. Make sure to include http://

  2. Open the Command Palette by clicking in the search bar or using CMD-SHIFT-P/CTRL-SHIFT-P, then type >Artificial: Sign in and press enter to run the Sign in command.

  3. Click Open when prompted and follow the window instructions.

  4. If successful, you will see two dialogs that say Sign in successful! and Add File to Context completed successfully.