Skip to main content

The Modular Autonomous Discovery for Science (MADSci) Experiment Manager.

Project description

MADSci Experiment Manager

Manages experimental runs and campaigns across a MADSci-powered lab, providing experiment design, tracking, and lifecycle management.

Features

  • Experiment Campaigns: Organize related experiments under a common research goal
  • Experiment Designs: Define experimental parameters, conditions, and metadata
  • Experiment Runs: Track individual experiment executions with status and results
  • Lifecycle Management: Monitor experiment progress from design to completion
  • Integration: Works with all MADSci managers for comprehensive lab coordination

Installation

See the main README for installation options. This package is available as:

Dependencies: MongoDB database (see example_lab)

Usage

Quick Start

Use the example_lab as a starting point:

# Start with working example
docker compose up  # From repo root
# Experiment Manager available at http://localhost:8002/docs

# Or run standalone
python -m madsci.experiment_manager.experiment_server

Manager Setup

For custom deployments, see example_experiment.manager.yaml for configuration options.

Experiment Client

Use ExperimentClient to manage experiments programmatically:

from madsci.client.experiment_client import ExperimentClient
from madsci.common.types.experiment_types import (
    ExperimentDesign,
    ExperimentRegistration,
    ExperimentalCampaign
)

client = ExperimentClient("http://localhost:8002")

# Create an experiment campaign
campaign = ExperimentalCampaign(
    name="Drug Discovery Campaign",
    description="Testing compound effectiveness",
    principal_investigator="Dr. Smith"
)
created_campaign = client.create_campaign(campaign)

# Design an experiment
design = ExperimentDesign(
    name="Compound Screen Experiment",
    description="Screen compounds for activity",
    campaign_id=created_campaign.campaign_id,
    parameters={"compounds": ["A", "B", "C"], "concentrations": [1, 10, 100]}
)
created_design = client.create_experiment_design(design)

# Register and run an experiment
registration = ExperimentRegistration(
    experiment_design_id=created_design.design_id,
    parameters={"compound": "A", "concentration": 10}
)
experiment = client.register_experiment(registration)

# Track experiment status
status = client.get_experiment_status(experiment.experiment_id)

Core Concepts

Experiment Campaigns

Group related experiments under a research theme or project:

  • Campaign management: Track multiple related experiments
  • Principal investigator: Associate experiments with researchers
  • Metadata: Store campaign-level information and goals

Experiment Designs

Templates defining experimental parameters and structure:

  • Parameter definitions: Specify experiment variables and ranges
  • Conditions: Define prerequisites and constraints
  • Metadata: Store design rationale and protocols

Experiment Runs

Individual executions of an experiment design:

  • Status tracking: Monitor progress from registration to completion
  • Results storage: Capture experimental outcomes and data
  • Lineage: Link runs to their designs and campaigns

Experiment Application

The ExperimentApplication class provides scaffolding for custom experiment logic:

from madsci.experiment_application import ExperimentApplication

class MyExperiment(ExperimentApplication):
    def run_experiment(self, experiment_id: str) -> dict:
        # Custom experimental logic
        # Use other MADSci clients (workcell, data, etc.)
        return {"result": "success"}

app = MyExperiment(experiment_server_url="http://localhost:8002")
app.start()

Integration with MADSci Ecosystem

The Experiment Manager coordinates with other MADSci components:

  • Workcell Manager: Execute workflows as part of experiments
  • Data Manager: Store experimental results and files
  • Event Manager: Log experimental events and milestones
  • Resource Manager: Track samples and consumables used

Example: See example_lab/ for complete integration examples with all managers working together.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

madsci_experiment_manager-0.5.0rc2.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

madsci_experiment_manager-0.5.0rc2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file madsci_experiment_manager-0.5.0rc2.tar.gz.

File metadata

  • Download URL: madsci_experiment_manager-0.5.0rc2.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.26.0 CPython/3.9.24 Linux/6.14.0-1012-azure

File hashes

Hashes for madsci_experiment_manager-0.5.0rc2.tar.gz
Algorithm Hash digest
SHA256 3ac1db04f48734779a88eaab28c6892b4ea36941ca69a2dd23db277eab01f2dc
MD5 d3c0a39fd3930d3313f3f314e680f94c
BLAKE2b-256 aa2d320ac606c24f86225b8daa267762bf000914b707e6df1684c52facc33180

See more details on using hashes here.

File details

Details for the file madsci_experiment_manager-0.5.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for madsci_experiment_manager-0.5.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 0c42c2fa01c167ed52d9b4625fd61ae8023e3722fea780f75fae342a912cbeb5
MD5 42a0575580eff201e552f77ee247b773
BLAKE2b-256 52aaac936f49cb3324870371e842d9172fcf0564ab71a33004a7d42c5724d3c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page