euclidkit

Guide

  • Installation
  • Configuration
  • Archive Environments and IDR Fields
  • Quickstart
  • CLI Reference
  • Segmentation Map Cutouts
  • Spectra Compilation
  • API Overview
euclidkit
  • euclidkit Documentation
  • View page source

euclidkit Documentation

GitHub repository PyPI version

euclidkit is a toolkit for Euclid archival data analysis workflows, including catalog crossmatch, spectra query, Parquet/FITS spectra export, and cutout pipeline helpers.

Contents

Guide

  • Installation
    • Requirements
    • Install from PyPI
    • Development install
    • CLI check
    • License
  • Configuration
    • Credentials file (recommended)
    • User config file
    • Environment override
  • Archive Environments and IDR Fields
    • Supported environments
    • IDR field selection
    • IDR DEEP MER partition selection
    • Examples
  • Quickstart
    • Basic CLI workflow
    • Python API example
  • CLI Reference
    • Top-level commands
    • Environment options
    • crossmatch
    • query-spectra
    • query-zspe
    • compile-spectra
    • dithers-to-parquet
    • query-cutana
    • cutouts
    • query-segmap
    • compile-segmap
    • upload-table
    • select-footprint
  • Segmentation Map Cutouts
    • Workflow
    • Required columns
    • Segmentation tile lookup
    • Cutout output
    • Useful options
    • Python API
  • Spectra Compilation
    • Typical workflow
    • query-spectra matching
    • Default Parquet mode (local Datalabs FITS paths)
    • Arm selection
    • Legacy local FITS mode
    • Datalink mode
    • Dithers Parquet export
    • Notes
  • API Overview
    • Core classes
Next

© Copyright 2026, Yuming Fu.

Built with Sphinx using a theme provided by Read the Docs.