API Reference

Contents

API Reference#

This section documents the public Python API of BYOST. Pages are generated automatically from function and module docstrings in the source code, following common scientific-Python documentation practice (Sphinx autodoc with NumPy-style docstrings where provided).

Modules#

Module

Description

BYOST.build

Build PCA/GPR building blocks from input spectra and conditions

BYOST.template

Retrieve and reconstruct spectral templates

BYOST.merge_spec

Merge blue- and red-side spectra

BYOST.visualize

Plot building blocks, GPR surfaces, and templates

Most users import from the top-level package:

import BYOST
from BYOST import make_buildingblock, get_template, plot_template

See the Quick Guide for workflow examples.

Contents