Command-Line Interface (CLI, Experimental)๏ƒ

Overview๏ƒ

Status: Experimental

The GWexpy CLI is currently a minimal placeholder interface and should be treated as an experimental, prototype-stage feature. At present, GWexpy is intended to be used primarily through the Python API for interactive analysis and scripting.

Current Status๏ƒ

The GWexpy CLI is in early development / prototype stage. The implemented behavior is currently limited to version display and a small informational help message. Advanced analysis workflows are not yet exposed as stable GWexpy subcommands, and the interface should not yet be treated as a finalized public workflow surface.

Available Commands๏ƒ

gwexpy --version๏ƒ

Display the installed GWexpy version:

gwexpy --version

Output:

gwexpy 0.1.0

gwexpy --help๏ƒ

Show general help information:

gwexpy --help

Using GWpy CLI๏ƒ

If you need GWpyโ€™s command-line tools, refer to the GWpy Documentation directly. GWexpy does not currently provide a documented compatibility layer that forwards the full GWpy CLI surface.

Note: For complex analysis pipelines, gravitational wave parameter estimation, and custom data processing, the Python API is recommended. See the Getting Started guide for API examples.

Future Development๏ƒ

Future GWexpy releases will add specialized subcommands for:

  • Data ingestion and validation

  • Noise characterization

  • Time-frequency analysis

  • Event localization

For planned features and timeline, see the public Roadmap.

Troubleshooting๏ƒ

If the gwexpy command is not found after installation, ensure that gwexpy was installed in the correct environment:

pip install -e .

Verify the installation:

python -c "import gwexpy; print(gwexpy.__version__)"