Skip to content

Latest commit

 

History

History
128 lines (85 loc) · 3.21 KB

README.md

File metadata and controls

128 lines (85 loc) · 3.21 KB
Raw

Alt Text

The Experiment Orchestration System (EOS)

os python

Note: EOS is currently in the alpha development stage. Much additional functionality and enhancements are planned. It currently has a core feature set to use for research. Please report any issues, make feature requests, or contribute to development!

The Experiment Orchestration System (EOS) is a comprehensive software framework and runtime for laboratory automation, designed to serve as the foundation for one or more automated or self-driving labs (SDLs).

EOS provides:

  • A common framework to implement laboratory automation
  • A plugin system for defining labs, devices, experiments, tasks, and optimizers
  • A package system for sharing and reusing code and resources across the community
  • Extensive static and dynamic validation of experiments, task parameters, and more
  • A runtime for executing tasks, experiments, and experiment campaigns
  • A central authoritative orchestrator that can communicate with and control multiple devices
  • Distributed task execution and optimization using the Ray framework
  • Built-in Bayesian experiment parameter optimization
  • Optimized task scheduling
  • Device and sample container allocation system to prevent conflicts
  • Result aggregation such as automatic output file storage

Documentation is available at https://unc-robotics.github.io/eos/.

Installation

1. Install PDM

PDM is used as the project manager for EOS, making it easier to install dependencies and build it.

Linux/Mac

curl -sSL https://pdm-project.org/install-pdm.py | python3 -

Windows

(Invoke-WebRequest -Uri https://pdm-project.org/install-pdm.py -UseBasicParsing).Content | py -

2. Clone the EOS Repository

git clone https://github.com/UNC-Robotics/eos

3. Install Dependencies

Navigate to the cloned repository and run:

pdm install

(Optional) If you wish to contribute to EOS development:

pdm install -G dev

(Optional) If you also wish to contribute to the EOS documentation:

pdm install -G docs

Configuration

After installation, you need to configure external services such as MongoDB and MinIO as well as EOS itself.

1. Configure External Services

We provide a Docker Compose file that can run all external services for you.

Copy the example environment file:

cp docker/.env.example docker/.env

Edit docker/.env and provide values for all fields.

2. Configure EOS

EOS reads parameters from a YAML configuration file.

Copy the example configuration file:

cp config.example.yml config.yml

Edit config.yml. Ensure that credentials are provided for the MongoDB and MinIO services.

Running

1. Start External Services

cd docker
docker compose up -d

2. Source the Virtual Environment

source env/bin/activate

3. Start the EOS Orchestrator

eos orchestrator

4. Start the EOS REST API

eos api