API Reference¶
Evolving API Surface
SCUBAS API signatures and internals can change between releases as modeling and dataset workflows are refined.
SCUBAS Developer API Guide
Structured reference for cable modeling, conductivity workflows, data containers, field-conversion models, and supporting utilities.
The SCUBAS API reference is organized by module domain:
- Cable system and nodal analysis
- Conductivity profiles and Earth/ocean structure
- Datasets and profile containers
- Ocean/electric-field transfer modeling
- Plotting helpers
- Shared utilities
Package Module Class Method / Function
Read this first
Start with the module summary page, then use the auto-generated mkdocstrings
section for signatures, parameters, and return types.
API Sections¶
Cables
End-to-end transmission-line and nodal analysis objects.
Open Cables API
Open Cables API
Conductivity + Datasets
Earth/ocean profile generation and reusable site containers.
Conductivity | Datasets
Conductivity | Datasets
Models + Utilities
Magnetic-to-electric conversion, FFT helpers, and geometry tools.
Models | Utilities
Models | Utilities
Plotting + Sources
Visualization helpers and current-source field generation.
Plotting | Current Sources
Plotting | Current Sources
Use the pages in this section for narrative summaries plus auto-generated API details.