Skip to content

Installation

Install the small numerical core first, then add analysis, machine-learning, or documentation dependencies only when you need them.

Requirements

Requirement Supported
Python 3.11, 3.12, 3.13
Operating system Any platform supported by NumPy and SciPy
Core runtime NumPy, SciPy, Zarr
Package manager pip or uv

Install the core package

python -m pip install dynaresp

uv add dynaresp

The core installation supports systems, loads, sensors, simulation, in-memory datasets, and Zarr-backed datasets.

Optional integrations

Install only the integration your workflow uses:

python -m pip install "dynaresp[analysis]"

Adds pandas and xarray for dataset.properties() and dataset.to_xarray().

python -m pip install "dynaresp[torch]"

Adds the lazy dataset.to_torch(...) adapter.

uv sync --group docs

Installs MkDocs, notebook execution, and plotting dependencies for this documentation site.

Verify the environment

python -c "import dynaresp; print('DynaResp import OK')"

Then run a minimal modal calculation:

from dynaresp import systems

system = systems.ShearBuilding(
    masses=[1.0, 1.0],
    stiffnesses=[100.0, 80.0],
)
print(system.modal_analysis([0, 1]).frequencies_hz)

You should receive two finite natural frequencies.

Development installation

From a source checkout:

uv sync --group dev --group docs
uv run pytest

See Development for the full quality gate.

Use one unit system

DynaResp does not perform unit conversion. SI units are recommended, but any internally consistent unit system is valid.