API examples and data requirements¶
The reference contains executable docstring examples for the composable spectral methods, brightness adjustment, QA metrics and packaged resources. All spectra in those examples are invented teaching data. Numerical success is not ecological validation or independent sensor calibration.
Run the checked offline examples from an installed checkout:
python examples/first_example.py
python examples/scientific_workflows_offline.py
python examples/spectral_library_methods.py
The first two need the normal package dependencies; the third also needs the
analytics extra. They create their own tiny inputs or temporary files. They
require neither NEON downloads nor the production polygon library.
For producer orchestration, filenames alone are not sufficient input fixtures.
NEON and drone workflows need real supported rasters, companion metadata,
geometry and spectral support. Their source docstring examples use variables
such as source_dir supplied by the caller, and are marked doctest: +SKIP.
These calls are signature-checked, not claimed as executed scientific runs.
- NEON workflow and orchestrator contracts.
- Drone workflow and local producer contract.
- Remote drone production requires an authorized backend and a manifest defining the expected population.
- Bulk workflow starts from completed immutable products and writes outputs outside the source tree.
- Scientific API maturity distinguishes reusable numerical methods from source-specific research.
Executable docstring checks and source-signature checks run with:
pytest -q tests/test_api_reference.py
See the function glossary to select the entry point for your task.