Development documentation · 0.2.3 30c2f8ba · Intro examples tested with 0.2.3 · Version details · Known limitations

Roadmap#

This page provides the public roadmap entry point for GWexpy documentation and feature planning. It is intended as a lightweight overview rather than a release contract.

Last updated: 2026-09-06.

How to Read This Page#

  • Released baseline: the shipped v0.2.3 maintenance baseline and the v0.2.0 semantic contract

  • Directional themes: areas we may improve in upcoming iterations

  • Mid-term: work we want to expose more broadly after the current docs and API cleanup

  • Long-term: exploratory directions that are useful but not yet scheduled

The roadmap is public, but priorities can change based on research needs, maintenance cost, and upstream dependencies.

Current Release Baseline#

  • v0.2.3 is the current released maintenance baseline. It restores the audited GWpy 4.0.1 / 4.0.2 default behavior without adding a public API or dependency.

  • v0.2.0 establishes the container-arithmetic baseline: predictable units, metadata propagation, and explicit failures instead of silent type downgrades

  • Exact timing, interoperable persistence, deterministic provenance, and public GWpy compatibility were established in v0.2.0 and are retained by v0.2.3

The v0.2.3 release is available on PyPI, conda-forge, and Zenodo (DOI 10.5281/zenodo.22344992). No next-minor release theme is committed; future work remains directional.

Directional Themes#

No next minor theme is committed. The following are directional themes, not a release promise or a reserved version number.

  • Documentation quality improvements across navigation, accessibility, and search

  • Clearer migration guidance for GWpy users

  • Better notebook and tutorial reliability in CI

  • More explicit references between tutorials, guides, and API pages

Longer-Term Directions#

  • Direct file reading and writing for field containers (regular-grid scalar, vector, and tensor fields), including terrain/elevation and GeoTIFF sources, with units, axes, and metadata preserved end to end

  • A complete segment-based analysis workflow: load segments, select, process with explicit error and missing-data handling, persist, and resume

  • Aggregating and summarizing many experiment segments together, without hand-written loops

  • Consistent handling of physical coordinate systems for field and terrain data

  • Broader CLI coverage beyond the current prototype-stage interface

  • More analysis workflows for noise characterization and time-frequency studies

  • Expanded interoperability guides for external scientific Python libraries, including reading HDF5 products written by data-preparation tools and importing outputs from interferometer design and simulation packages

  • More public validation notes for numerical and physics-facing algorithms

For how these bridges relate to the surrounding ecosystem, and which projects are deliberately left out of scope, see Where GWexpy Sits in the GW Python Ecosystem.

  • Spatial geometry for field data: coordinate frames, detector-aligned rotations, and layered map visualization combining terrain, physical fields, and site markers

  • Mesh-aware field models and interoperability with numerical solver outputs

  • Forecasting and inference utilities built on the matrix containers, such as Fisher analysis

  • A stable, documented public API surface that downstream applications and GUIs can build on

  • Consistent time interpretation (time zones, numeric time scales and epochs) and uniform reader behaviour across supported experiment data formats

  • Richer visual discovery paths across examples and reference content

  • More automation around documentation verification and sample-code validation

  • Potential improvements to theme, search quality, and interactive visual components

Public Tracking Sources#

Scope Note#

This roadmap is a planning aid, not a guarantee of delivery order or release timing. GWexpy is research-oriented software and some priorities may shift as the package evolves.