Skip to main content
Ctrl+K

firefly_client documentation

  • Usage
  • Development
  • API
  • GitHub
  • PyPI
  • Usage
  • Development
  • API
  • GitHub
  • PyPI

Section Navigation

  • Getting Started
  • Initializing a FireflyClient instance
  • Displaying FITS Images
  • Displaying 3-Color FITS Images
  • Displaying HiPS Images
  • Visualizing Regions on Images
  • Displaying Tables and Catalogs
  • Visualizing tables as Charts
  • Advanced: Callbacks and Extensions
  • Demo Notebooks
    • Reference Guide to Firefly Python Client API
    • Show a 3 color image
    • Show HiPS Image
    • Basic API Usage
    • Show a file containing multiple tables
    • Overlay a footprint on image
    • Add region data to image
    • Extensions and Callback
    • Extensions and Callback via Terminal
    • Plot interface: firefly_client.plot module
    • Load files as a table of data products
    • Load multiple MOCs
  • Using firefly_client

Using firefly_client#

  • Getting Started
    • Prerequisites
    • Connect to Firefly and open the viewer
    • Display a FITS image
    • Display a catalog table
  • Initializing a FireflyClient instance
    • Pick a Firefly server URL
    • Imports
    • Initialize FireflyClient
    • Other helpful methods
  • Displaying FITS Images
    • Setup
    • Show FITS Image in Firefly
    • Modify the displayed image(s)
    • Advanced Usage (Low-level, Unstable API)
  • Displaying 3-Color FITS Images
    • Setup
    • Show 3-color image
  • Displaying HiPS Images
    • Setup
    • Show HiPS image
    • Modify displayed HiPS
    • Overlay MOC (sky coverage map)
  • Visualizing Regions on Images
    • Setup
    • Create a region layer
    • Add region data to an existing layer
    • Remove a region command
    • Delete an entire region layer
  • Displaying Tables and Catalogs
    • Setup
    • Display a Table
    • Modify the displayed table
    • Tweaking the table display parameters
  • Visualizing tables as Charts
    • Setup
    • Quick scatter plot
    • Quick histogram
    • Configurable plots
    • Spectra
  • Advanced: Callbacks and Extensions
    • Setup
    • Define and register a callback
    • Add an extension to trigger the callback
    • Trigger the callback (manual step)
    • Remove the callback
  • Demo Notebooks
    • Reference Guide
    • Science Use-cases
    • Other Examples

previous

firefly_client - Python API to Firefly visualization

next

Getting Started

This Page

  • Show Source

© Copyright 2026, Caltech/IPAC Firefly Developers.

Last updated on Jan 15, 2026.

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.16.1.