Metadata-Version: 2.1
Name: slide-lsst
Version: 0.1.1
Summary: Image subtraction package for LSST using DECam templates
Author-email: Yize Dong <yize.dong@outlook.com>
Maintainer-email: Yize Dong <yize.dong@outlook.com>
License: MIT
Project-URL: Homepage, https://github.com/yizedong/SLIDE
Project-URL: Documentation, https://github.com/yizedong/SLIDE#readme
Project-URL: Repository, https://github.com/yizedong/SLIDE
Project-URL: Bug Tracker, https://github.com/yizedong/SLIDE/issues
Keywords: astronomy,lsst,decam,image-subtraction,transient-detection
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.20.0
Requires-Dist: scipy >=1.7.0
Requires-Dist: matplotlib >=3.3.0
Requires-Dist: astropy >=5.0.0
Requires-Dist: photutils >=1.4.0
Requires-Dist: reproject >=0.8.0
Requires-Dist: sep >=1.1.0
Requires-Dist: requests >=2.25.0
Requires-Dist: pyvo >=1.3.0
Requires-Dist: astroquery >=0.4.6
Requires-Dist: psutil >=5.8.0
Provides-Extra: dev
Requires-Dist: pytest >=6.0 ; extra == 'dev'
Requires-Dist: pytest-cov >=2.0 ; extra == 'dev'
Requires-Dist: black >=21.0 ; extra == 'dev'
Requires-Dist: flake8 >=3.8 ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx >=4.0 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme >=1.0 ; extra == 'docs'

# SLIDE: Subtracting LSST Images with DECam Exposures

> **WARNING: SLIDE is designed for use on the Rubin Science Platform (RSP). It will not work on local installations!**

SLIDE performs image subtraction on LSST data using DECam templates. It is designed to run directly on the Rubin Science Platform (RSP). SLIDE can automatically retrieve templates from DES DR2 or DECaLS DR9. Users may also supply custom DECam templates. An example of image subtraction made by SLIDE is shown below.

![Example Image Subtraction](example_data/SN_det.png)

We thank Griffin Hosseinzadeh for providing the PyZOGY image subtraction example: https://github.com/griffin-h/image_subtraction

## Citation

If you use this package in your research, please cite:

Dong et al. (2025), "Enabling Early Transient Discovery in LSST via Difference Imaging with DECam", [arXiv:2507.22156](https://arxiv.org/abs/2507.22156)

## Installation

**Note**: On RSP, you will need to activate the LSST environment first.

```bash
# Activate LSST environment on RSP
conda activate lsst-scipipe-10.0.0
setup lsst_distrib
```

### Prerequisites

Most dependencies of this package has been installed on RSP. If you miss any packages, you can install them as following:

```bash
pip install --user reproject
```

### PyZOGY

This package depends on PyZOGY for image subtraction (https://github.com/dguevel/PyZOGY/tree/master):

```bash
python -m pip install git+https://github.com/dguevel/PyZOGY.git
```

### Install SLIDE (you will need to install SLIDE on RSP)

#### Option 1: Install from GitHub

```bash
git clone https://github.com/yizedong/SLIDE.git
cd SLIDE
pip install --user -e .
```

#### Option 2: Install from PyPI

```bash
pip install --user slide-lsst
```

## Documentation

For detailed usage examples, see the [`example.ipynb`](https://github.com/yizedong/SLIDE/blob/main/example.ipynb) notebook included in the package.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the LICENSE file for details.
