skyCatalogs: provides API for simulated object catalogs

skyCatalogs provides a uniform API to the catalogs created by its sister package skyCatalogs_creator and to third-party catalogs following certain conventions. These catalogs may be used as inputs to image simulation (originally only for the Rubin Observatory; since also used in simulations for the Roman Observatory) and as truth catalogs.

This documentation covers installation and usage instructions for the package.

The source code of skyCatalogs is hosted at https://github.com/LSSTDESC/skyCatalogs.

Contents:

• Installation Instructions
  • Installation with LSST science pipelines
  • Install without LSST science pipelines
  • Install needed data files
  • Using skyCatalogs
• Reading Catalogs with skyCatalogs
  • Opening a Catalog
• Structure of skyCatalogs Configs
  • Using !include
  • Description of an object type
• Adding Supported Object Types to a Catalog
  • Supported object types
• Galaxy quantities for ops-rehearsals 3 and 4
  • Galaxy main file
  • Galaxy flux file
• Star quantities for ops-rehearsals 3 and 4
  • Star main file
  • Star flux file
• Solar System Object (SSO) quantities for ops-rehearsals 3 and 4
  • SSO main file
  • SSO flux file
• Galaxy quantities for Roman-Rubin joint simulation
  • Galaxy main file
  • Galaxy flux file
  • Galaxy SED file
• Star quantities for Roman-Rubin sims
  • Star main file
  • Star flux file
• SNANA quantities for Roman-Rubin sims
  • SNANA main file
  • SNANA varying quantities
• Quantities for TRILEGAL stars version lsst_sim.simdr2
  • TRILEGAL main file
  • TRILEGAL flux file

Indices and tables

• Index

• Module Index

• Search Page