Metadata-Version: 2.1
Name: blending-toolkit
Version: 1.0.0b1
Summary: Blending ToolKit
Home-page: https://lsstdesc.org/BlendingToolKit/index.html
License: MIT
Keywords: cosmology,galaxies,blending,lsst,simulation
Author: Ismael Mendoza
Author-email: imendoza@umich.edu
Requires-Python: >=3.8.1,<3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: astropy (>=5.1)
Requires-Dist: galcheat (>=1.0.0,<2.0.0)
Requires-Dist: galsim (>=2.4.9)
Requires-Dist: matplotlib (>=3.7.1)
Requires-Dist: numpy (>=1.22)
Requires-Dist: pre-commit (>=3.3.3,<4.0.0)
Requires-Dist: scikit-image (>=0.20.0)
Requires-Dist: scipy (>=1.9.1)
Requires-Dist: sep (>=1.2.1)
Requires-Dist: tqdm (>=4.65.0)
Project-URL: Bug Tracker, https://github.com/python-poetry/poetry/issues
Project-URL: Repository, https://github.com/LSSTDESC/BlendingToolKit
Description-Content-Type: text/markdown

# BlendingToolKit

![tests](https://github.com/LSSTDESC/BlendingToolKit/workflows/tests/badge.svg)
![tests](https://github.com/LSSTDESC/BlendingToolKit/workflows/docs/badge.svg)
[![notebooks](https://github.com/LSSTDESC/BlendingToolKit/actions/workflows/notebooks.yml/badge.svg?branch=main)](https://github.com/LSSTDESC/BlendingToolKit/actions/workflows/notebooks.yml)
[![codecov](https://codecov.io/gh/LSSTDESC/BlendingToolKit/branch/main/graph/badge.svg)](https://codecov.io/gh/LSSTDESC/BlendingToolKit)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![PyPI][pypi-badge]][pypi]

[pypi-badge]: <https://img.shields.io/pypi/pyversions/blending-toolkit?color=yellow&logo=pypi>
[pypi]: <https://pypi.org/project/blending-toolkit/>

## Summary

Framework for fast generation and analysis of galaxy blends catalogs. This toolkit is a convenient way of
producing multi-band postage stamp images of blend scenes and evaluate the performance of deblending algorithms.

Documentation can be found at <https://lsstdesc.org/BlendingToolKit/index.html>.

To get started with BTK check at our quickstart notebook at: `notebooks/00-quickstart.ipynb`

## Workflow

<img src="docs/source/images/diagram.png" alt="btk workflow" width="550"/>

- In red are the BTK objects that can be customized in various ways by BTK users.

## Installation

BTK is pip installable, with the following command:

```bash
pip install blending_toolkit
```

In case of any issues and for details of required packages, please see the more detailed installation instructions [here](https://lsstdesc.org/BlendingToolKit/install.html).

## Contributing

See our contributing guidelines at [CONTRIBUTING.md](https://github.com/LSSTDESC/BlendingToolKit/blob/main/CONTRIBUTING.md)

