Development#

This section documents contribution workflows, documentation rules, testing, public API policy, and release practices.

Documentation build

Build the docs locally: environment, sphinx-gallery execution, incremental builds, and the output layout.

Documentation Build
Docstring style

The numpydoc conventions every public function, class, and module follows — with templates to copy from.

Docstring Style
Continuous integration

What runs on every push and pull request: test matrix, linting, docs build, and release automation.

Continuous Integration
Coverage improvement TODO

Prioritized work to expose existing tests, cover scientific contracts, and raise coverage without fragile percentage chasing.

Coverage improvement TODO
API policy

What counts as public API, deprecation rules, and the stability promises across the v2 line.

API Policy
Extending pyCSAMT

Inherit from PyCSAMTObject, CoreObject, or MTBase to get repr, serialization, MT math, and EDI interop in your own classes.

Extending pyCSAMT