D³TaLES Robotics UI and API Documentation!

Here you will find complete documentation for the D³TaLES robotics Python software hosted in the roboticsUI repository GitHub repository. This includes documentation ExpFlow and Robotics Robotics App user interfaces as well as the Robotics API for interacting with the robotics hardware directly.

RoboticsUI Contents

The roboticsUI repository contains several directories:

• _setup: Files for setting up the repo including setting up the conda environment and documentation source files.

• docs: Automatically produced documentation HTML files.

• GUI: Code for the robotics Robotics App. Uses Tkinter.

• robotics_api: Robotics API that manages robotic workflows. (More discussion below.)

• test_data: Example, standard, and test experimental data.

Overview

• Installation and Setup
  • Software Installation
    • Clone this GitHub Repository
    • Create Environment
    • Activate Environment
  • Hardware Setup
    • Robot Setup
    • Station Setup
• QuickStart
  • Creating Robotic Workflows: ExpFlow
  • Managing Robotic Workflows
  • Running an Experiment…
• Terminology and Structure
  • Experiments and Workflows
  • Software Setup
  • Hardware Setup
• Robot Run Checklist
  • Before Running a Workflow
  • After Running a Workflow
• Common Errors

User Interfaces

• ExpFlow Robotic Workflows
  • Building a Template
    • Create new Template
    • Add materials (reagents, apparatus, and instruments)
    • Add actions
    • Important notes for building a Template for Robotic Workflows
  • Use Template for Robotic Workflow
    • Set default parameters
    • Establish variable parameters
    • Download robotic workflow
• Robotics App
  • Loading a workflow
  • Monitoring workflows with FireWorks WebGUI
  • Managing Jobs
  • Launching Jobs!

Robotics API

• Overview
• Settings and Snapshots
  • Settings
  • Snapshots
• Module - Fireworks
  • Workflows
  • Fireworks
    • Categories:
  • Firetasks
    • Actions (Firetask_Actions.py)
    • Processing (Firetasks_Processing.py)
• Module - Actions
  • Overview
    • High-Level Workflow
  • 1. DB Manipulations
  • 2. Standard Actions
    • Example Usage:
  • 3. System Tests
• Module - Utils
  • Note about Robotic Motion
• Robotics Databases
  • Status Collections
    • status_reagents
    • status_stations
    • status_vials
  • Data Collections
    • experimentation
    • metadata
  • Standards Collections
    • standards_CACalib

Raw API Code Docs

• robotics_api package
  • Subpackages
    • robotics_api.actions package
      • Submodules
      • robotics_api.actions.db_manipulations module
      • robotics_api.actions.standard_actions module
      • robotics_api.actions.system_tests module
      • Module contents
    • robotics_api.fireworks package
      • Subpackages
      • Submodules
      • robotics_api.fireworks.Firetasks_Actions module
      • robotics_api.fireworks.Firetasks_Processing module
      • robotics_api.fireworks.Fireworks module
      • robotics_api.fireworks.Workflow_Writer module
      • Module contents
    • robotics_api.snapshots package
      • Module contents
    • robotics_api.utils package
      • Submodules
      • robotics_api.utils.base_utils module
      • robotics_api.utils.kinova_gripper module
      • robotics_api.utils.kinova_move module
      • robotics_api.utils.kinova_utils module
      • robotics_api.utils.mongo_dbs module
      • robotics_api.utils.processing_utils module
      • Module contents
  • Submodules
  • robotics_api.settings module
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page