User Guide

Getting Started

• Installation
  • 1. Install PDM
  • 2. Clone the EOS Repository
  • 3. Make a Virtual Environment
  • 4. Install Dependencies
• Configuration
  • 1. Configure External Services
  • 2. Configure EOS
• Running
  • 1. Start External Services
  • 2. Source the Virtual Environment
  • 3. Start the EOS Orchestrator
  • 4. Start the EOS REST API
• Infrastructure Setup

Concepts

• Packages
  • Create a Package
• Devices
  • Device Implementation
    • YAML File (device.yml)
    • Python File (device.py)
• Laboratories
  • Laboratory Implementation
    • Locations (Optional)
    • Computers (Optional)
    • Devices (Required)
    • Containers (Optional)
• Tasks
  • Parameters
  • Containers
  • Files
  • Task Implementation
    • YAML File (task.yml)
      • Parameter Specification
      • Integer
      • Decimal
      • String
      • Boolean
      • Choice
      • List
      • Dictionary
    • Python File (task.yml)
• Experiments
  • Experiment Implementation
    • YAML File (experiment.yml)
    • Optimizer File (optimizer.py)
• Campaigns
  • Optimization Setup (Analyze and Design Phases)
  • Automation Setup (Make and Test Phases)
• Optimizers
  • Distributed Execution
  • Optimizer Implementation
    • Input and Output Parameter Naming
  • Example Custom Optimizer

Interfaces

• REST API
  • Documentation

Advanced

• Jinja2 Templating
  • Variables
  • Arithmetic
  • Conditionals
  • Loops
  • Macros
  • Include Files

Examples

• Color Mixing
  • Installation
  • Sample Usage
  • Package Structure
  • Devices
  • Tasks
  • Laboratory
  • Experiment