xcavation 0.1.0

SphereX Data Retrieval and Photometry Toolkit

🪏 Xcavation 🪏

Xcavation is a Python package designed for efficient retrieval, photometric extraction, and visualization of SPHEREx survey data. Streamlined API for querying SPHEREx QR2 data products via IRSA, performing either aperture or PSF photometry, accounting for proper motion. Multi-threading is supported to significantly accelerate polar regions.

It is recommended that a user uses Google Colab, as it has high-speed internet for free. Here is an example.

🛠️ Installation 🛠️

pip Installation

1. Download Python: Visit here to install Python
2. Download pip: Visit here to install pip
3. Run Install Command: Run the command in terminal:

   pip install xcavation
   

⚙️ Using Xcavation ⚙️

How to Use genspec

1. After Xcavation is installed, verify the installation by running the following command: from xcavation.genspec import *. If you encounter any issues during installation, please reach out to Hunter Brooks for assistance.
2. Assign the relavent variables as described below.
3. Execute the command: genspec(ra, dec, style). These are the minimum required parameters for Xcavation to run. You can include optional variables if needed.

Relavent Variables For genspec

• Required Variables:

  • ra: Right Accension in Degrees: float:

    • example: 131.123

  • dec: Declination in Degrees: float:

    • example: -12.31254

  • style: Aperature or PSF Photometry: string:

    • example: aperture or psf

• Optional Variables:

  • pmra: Proper Motion in Right Accension (in arcsec/year): float
    • example: -0.981, default=None
  • pmdec: Proper Motion in Declination (in arcsec/year): float
    • example: 0.123, default=None
  • mjd: Modified Julian Date of inputed R.A. and Decl. from Above: float
    • example: 57170, default=None
  • verification: Plots Q.A. and Spectrum if True: boolean
    • example: True, default=False
  • threads: Number of Threads for Multi-Threading: list
    • example: 2, default=8

📞 Support & Development Team 📞

• Mr. Hunter Brooks
  • Email: [e-mail]

📖 Acknowledgments 📖

1. If you intend to publish any calculations done by fossyl, please reference Brooks et al. (in prep.).

2. Please reference the relavent SPHEREx publication.