Installation

Requires Python 3.12+.

VS Code First

For a guided editor-first path through environment creation, package install, interpreter selection, and a first script, see Run An Example In VS Code.

Package Install

python -m pip install design-research-problems

On Windows, if python resolves to an older interpreter, use py -3.12 -m pip install design-research-problems and py -3.12 -m venv .venv.

Editable Install

git clone https://github.com/cmudrc/design-research-problems.git
cd design-research-problems
python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"

Maintainer Shortcut

make dev

Family Extras

Install only the problem-family integrations needed for your study.

python -m pip install "design-research-problems[grammar]"
python -m pip install "design-research-problems[battery]"
python -m pip install "design-research-problems[mcp,cad]"
python -m pip install "design-research-problems[solvers,pandas]"
python -m pip install "design-research-problems[all]"

Optimization primitives are already available in the base install via SciPy, so there is no separate opt extra. Use solvers for external optimization backends or all for the broadest packaged add-on set.

When working from a source checkout, replace design-research-problems with . and add -e to install the same extras in editable mode.

Use Dependencies and Extras for a compact matrix and practical profile guidance.