Skip to content

[META] Refactor opportunities #735

@waltsims

Description

@waltsims

Umbrella issue rolling up the standing refactor backlog. The individual issues below are scoped, low-risk cleanups that don't block any user but are worth picking up when touching the surrounding code.

Bundled here

  • Refactor package file layout #219 — Promote kWaveArray to the top-level kwave/ namespace. It's still buried at kwave/utils/kwave_array.py, which forces awkward imports for what's a primary user-facing class. (The original issue had broader scope, but most other classes are already at top level — only kWaveArray is the outstanding case.)
  • Remove redundant arguments from simulation_options #339 — Deprecate the per-axis pml_x_size / pml_y_size / pml_z_size fields on SimulationOptions in favour of the unified pml_size (scalar or vector). The modern kspaceFirstOrder() already exposes only pml_size; this is internal-plumbing cleanup.

Originally bundled but reassessed

How to use this issue

Pick either of the two listed items when you're already in the affected area. PRs should link Closes #N for the specific sub-issue they address. When both are closed, this umbrella can be closed too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions