Reference

Note

Page role: Reference index

Stability: Stable

Use this page as the hub for navigating the GWexpy reference. Choose the entry point that matches how you are looking things up: by module, by class name, or by concept/topic.

Audience: Users who already know the feature they need and want exact API, class, or topic details. Prerequisites: Basic familiarity with GWexpy terminology and at least one guide or tutorial path. Use this page for: Jumping into stable lookup-oriented documentation rather than task-oriented learning. Search hints: API index, class index, topics, reference, module lookup, class lookup, theory notes

Note

On this page: Use API Index for subsystem browsing, Class Index for Python class names, and Topics for conventions, theory, and helper material.

Note

Advanced/theory landing: For validation assumptions, conventions, and audit-backed theory notes, start with Reference Topics and then continue to the advanced/theory landing at Validated Algorithms.

Note

Example framing: Goal: find the exact object, module, or topic page behind a name you already know. Inputs: a class name, module family, or concept. Outputs: a stable reference entry point for deeper lookup.

Entry Point	Stability	Use it for
API Index	Stable	Browsing modules and public functions by subsystem
Class Index	Stable	Finding class pages by Python class name
Topics	Stable	Finding theory, conventions, and helper pages by concept

🧩 API Index

Browse module and function reference pages by subsystem.

API Reference

🏗️ Class Index

Find major GWexpy classes in alphabetical order.

Class Index

🧭 Topics

Start from conventions, theory notes, and helper overviews.

Reference Topics