Skip to main content

Thin umbrella package for the CMU Design Research Collective ecosystem

Project description

design-research

CI Docs

design-research is the umbrella entry-point package in the cmudrc design research ecosystem.

It provides a thin, curated top-level import surface over the ecosystem's specialized component libraries.

Overview

This package focuses on discoverability and coherence rather than reimplementation:

  • Submodule-first top-level API: problems, agents, experiments, analysis
  • Curated re-exports of stable, user-facing APIs from component libraries
  • Shared ecosystem framing and philosophy in one canonical package
  • Lightweight wrapper design that preserves modular versioning boundaries

Quickstart

Requires Python 3.12+. Reproducible release installs are pinned to Python 3.12.12 (.python-version).

python -m venv .venv
source .venv/bin/activate
make dev
make test

Install from PyPI:

pip install design-research

Then start from the umbrella namespace:

import design_research as dr
from design_research import problems, agents, experiments, analysis

problem_ids = problems.list_problems()
problem = problems.get_problem(problem_ids[0])

print(type(problem).__name__)
print(agents.MultiStepAgent)
print(experiments.Study)
print(analysis.validate_unified_table)

Ecosystem Integration

The Design Research Collective maintains a modular ecosystem of libraries for studying human and AI design behavior.

  • design-research-agents implements AI participants, workflows, and tool-using reasoning patterns.
  • design-research-problems provides benchmark design tasks, prompts, grammars, and evaluators.
  • design-research-analysis analyzes the traces, event tables, and outcomes generated during studies.
  • design-research-experiments sits above the stack as the study-design and orchestration layer, defining hypotheses, factors, conditions, replications, and artifact flows across agents, problems, and analysis.

Together these libraries support end-to-end design research pipelines, from study design through execution and interpretation.

Philosophy

The full ecosystem philosophy is documented in docs/philosophy.rst and in the published docs site.

Docs

See the published documentation for quickstart, concepts, workflow framing, philosophy, and API reference.

Build docs locally with:

make docs

Public API

The supported top-level public surface is whatever is exported from design_research.__all__.

Top-level exports include:

  • Wrapper submodules: problems, agents, experiments, analysis
  • Package metadata: __version__

Contributing

Contribution workflow and quality gates are documented in CONTRIBUTING.md.

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

design_research-0.1.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

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

design_research-0.1.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file design_research-0.1.0.tar.gz.

File metadata

  • Download URL: design_research-0.1.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for design_research-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2ecd1081cce8fa4a0454d901689b645de663ffa7a9606eded417247f58eb4d1e
MD5 e4967b4a9e03f9e57922308c753b0a6a
BLAKE2b-256 22b78ae0246911f6c815728457adca07b2861ae7afea7de62b59589ee835453f

See more details on using hashes here.

Provenance

The following attestation bundles were made for design_research-0.1.0.tar.gz:

Publisher: workflow.yml on cmudrc/design-research

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file design_research-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for design_research-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2fe48951851ae00d8bc072053d44199bc493bf0c36ae916f85cd49108a522f6
MD5 d41448a361a0d6646d429641603b0242
BLAKE2b-256 32be0c66847f647e10c8a66521718f324f501e353f8e9fa6d496ffb6113f96c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for design_research-0.1.0-py3-none-any.whl:

Publisher: workflow.yml on cmudrc/design-research

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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