Study-definition and orchestration layer for the cmudrc design research ecosystem
Project description
design-research-experiments
[!IMPORTANT] Current monthly release: Mariner Matrix - May 2026
Due: May 1, 2026
Tracks: April 2026 work
design-research-experiments is the hypothesis-first study-definition and
experiment-orchestration layer in the cmudrc design research ecosystem.
It composes sibling libraries rather than reimplementing them:
design-research-agentsfor executable agent behavior, workflows, and tracesdesign-research-problemsfor problem catalogs, registries, and evaluatorsdesign-research-analysisfor downstream unified-table analysis and reporting
Overview
This package centers on reproducible experiment structure and execution:
- typed schemas for studies, factors, blocks, hypotheses, outcomes, and analysis plans
- design-of-experiments materialization (full/constrained factorial, randomized block, repeated measures, latin square, custom matrices)
- run orchestration with deterministic seeding, checkpointing, resume support, and
interactive
tqdmprogress on terminal runs - canonical artifact exports (
study.yaml,manifest.json,conditions.csv,runs.csv,events.csv,evaluations.csv, and machine-readable hypothesis/plan files) - documented artifact contracts that downstream analysis can ingest directory-first
- thin adapters that connect to the public APIs of sibling agent/problem/analysis libraries
Quickstart
Requires Python 3.12+.
Maintainer workflows target Python 3.12 (.python-version).
python -m venv .venv
source .venv/bin/activate
make dev
make test
Run a basic example:
make run-example
This repo maintains a hard 90% total line-coverage floor in CI via
make coverage. The repo-specific rule tracks the family-wide coverage policy
in cmudrc/design-research#4.
CLI
The package installs a drexp CLI:
drexp validate-study path/to/study.yaml
drexp materialize-design path/to/study.yaml
drexp generate-doe --kind lhs --factors-json '{"x": [0, 1], "y": [10, 20]}' --n-samples 12 --out artifacts/doe.csv
drexp run-study path/to/study.yaml
drexp resume-study path/to/study.yaml
drexp export-analysis path/to/study.yaml
drexp bundle-results path/to/output_dir
Examples
See examples/README.md for runnable scripts, including end-to-end recipe executions.
Docs
See the published documentation for guides, the artifact contract, and API reference.
Build docs locally with:
make docs
Public API
Top-level exports are intentionally small:
Study,Factor,Level,Constraint,Condition,BlockRecipeStudyConfig,ComparisonStudyConfig, and recipe-specific typed config classesHypothesis,OutcomeSpec,AnalysisPlanRunSpec,RunResult,BenchmarkBundlebuild_design,generate_doe,materialize_conditionsbuild_univariate_comparison_study,build_bivariate_comparison_study,build_strategy_comparison_study, and other recipe buildersrun_study,resume_studyexport_analysis_tables,validate_study
Contributing
Contribution workflow and quality gates are documented in CONTRIBUTING.md.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file design_research_experiments-0.1.2.tar.gz.
File metadata
- Download URL: design_research_experiments-0.1.2.tar.gz
- Upload date:
- Size: 80.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1813b03eccfdd0fad48c90267e08ee072b4d452982f6d2bd8aaf6780ae05b8be
|
|
| MD5 |
f5723b682182dd23aa75751bf505022a
|
|
| BLAKE2b-256 |
6afbd2ab41f9593ca513ec46521b52a3673242d29df0c2bd20696cd6632a7310
|
Provenance
The following attestation bundles were made for design_research_experiments-0.1.2.tar.gz:
Publisher:
workflow.yml on cmudrc/design-research-experiments
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
design_research_experiments-0.1.2.tar.gz -
Subject digest:
1813b03eccfdd0fad48c90267e08ee072b4d452982f6d2bd8aaf6780ae05b8be - Sigstore transparency entry: 1203974110
- Sigstore integration time:
-
Permalink:
cmudrc/design-research-experiments@abe14d6696b95147932cfdc06f91b9907a0152ca -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/cmudrc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
workflow.yml@abe14d6696b95147932cfdc06f91b9907a0152ca -
Trigger Event:
release
-
Statement type:
File details
Details for the file design_research_experiments-0.1.2-py3-none-any.whl.
File metadata
- Download URL: design_research_experiments-0.1.2-py3-none-any.whl
- Upload date:
- Size: 62.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
762768bad3eadd1b9f22fd5716346d40eeec41c286cad283309c6f0b194d860a
|
|
| MD5 |
d20d59776d02398991c1eb125b55caf0
|
|
| BLAKE2b-256 |
37e7379ceff9285aa481c164475a7dded9ada1197b96949d4c9b28ff19b1e668
|
Provenance
The following attestation bundles were made for design_research_experiments-0.1.2-py3-none-any.whl:
Publisher:
workflow.yml on cmudrc/design-research-experiments
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
design_research_experiments-0.1.2-py3-none-any.whl -
Subject digest:
762768bad3eadd1b9f22fd5716346d40eeec41c286cad283309c6f0b194d860a - Sigstore transparency entry: 1203974117
- Sigstore integration time:
-
Permalink:
cmudrc/design-research-experiments@abe14d6696b95147932cfdc06f91b9907a0152ca -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/cmudrc
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
workflow.yml@abe14d6696b95147932cfdc06f91b9907a0152ca -
Trigger Event:
release
-
Statement type: