Skip to content

Internal Documentation

These pages document the retained build pipeline, design notes, and release planning material that still lives in this repository.

They are useful for maintainers, but they are not part of the stable public package contract.

Not part of the public API contract

The public contract is limited to the installable package, public CLI, and prepared-runtime standard documented in the main docs. The internal pages below can change more freely.

Internal Pages

  • Internal Build Pipeline describes the retained SIAC-oriented source assembly workflow
  • Mapping Design records the original retrieval-based mapping design and benchmark goals
  • Release Design records the release-standardization plan that shaped the package surface

Current Repository Package Layout

  • src/spectral_library/mapping/ public mapping runtime, prepared-runtime build, and retrieval engine
  • src/spectral_library/distribution/ runtime download helpers
  • src/spectral_library/sources/ source manifests, fetchers, fetch batching, and catalog assembly
  • src/spectral_library/normalization/ normalization, coverage filtering, quality plots, and SIAC package export

The older flat root modules for those areas are now compatibility shims over the refactored package layout, so maintainers should use the package paths above when navigating the codebase.

Public Docs

If you are using the package rather than maintaining the repository, start with: