Skip to content

qsp-stack

Convenience meta-package that bundles the main QSP layers into one install for end users.

What it is

qsp-stack is a convenience meta-package. It has no implementation code of its own — its sole purpose is to declare the other QSP packages as dependencies, so that users can install the full ecosystem with a single command.

Why it exists

When getting started with QSP, most users do not know which specific packages they will need. qsp-stack removes that friction: install one package, get everything. As workflows mature, users can narrow their dependencies to specific packages.

Key responsibilities

  • Bundling all main QSP packages into a single installable unit
  • Providing a stable, versioned entry point to the full ecosystem
  • Simplifying onboarding for new users and quick-start deployments

Typical users

  • New users exploring the QSP ecosystem
  • Teams prototyping workflows that span multiple QSP packages
  • Deployment environments where a full-stack install is preferred for simplicity
  • CI/CD pipelines that need the complete ecosystem available

Example use cases

  • Getting started with QSP in one install: pip install qsp-stack
  • Ensuring all QSP packages are available in a development environment
  • Validating cross-package workflows without managing individual package versions

Relationship to other QSP packages

qsp-stack depends on all main QSP packages:

qsp-stack → qsp-core
          → qsp-fft
          → qsp-filter
          → qsp-modulation
          → qsp-orientation

Installing qsp-stack is equivalent to installing all five packages individually.

Migrating away from qsp-stack

When moving from exploration to production, consider replacing qsp-stack with the specific packages your code actually imports. This keeps your dependency footprint minimal and makes your requirements explicit.

See Migration Paths for guidance.

Status

qsp-stack is versioned in lockstep with the ecosystem. When packages are updated, a new version of qsp-stack is released with updated dependency constraints. Future expansion of the QSP ecosystem will be reflected in new qsp-stack versions.