Blending ToolKit
Project description
BlendingToolKit
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.
Documentation can be found at https://lsstdesc.org/BlendingToolKit/index.html
Workflow
Color code for this flowchart:
- Classes in black should be used as is by the user.
- Classes in red may be reimplemented by the experienced user; we recommend for new users to use the default implementations until they are familiar with them.
- In blue is the code for instantiating the classes within the code (optional arguments not included).
- In green are the revelant methods for the classes; please note that the
__call__
method is executed when calling the object (egsampling_function(catalog)
) and the__next__
method is executed when usingnext
(egnext(generator)
).
Running BlendingToolKit
- BlendingToolKit (btk) requires an input catalog that contains information required to simulate galaxies and blends. This repository includes sample input catalogs with a small number of galaxies that can be used to draw blend images with btk. See tutorials to learn how to run btk with these catalogs.
- CatSim Catalog corresponding to one square degree of sky and processed WeakLensingDeblending catalogs can be downloaded from here.
- Cosmo DC2 catalog requires pre-processing in order to be used as input catalog to btk. Refer to this notebook on how to convert the DC2 catalog into a CatSim-like catalog that can be analyzed with btk.
Installation
BTK is pip installable, with the following command:
pip install blending_toolkit
Although you might run into problems installing galsim
. In case of any issues, please see the more detailed installation instructions here.
For required packages, see pyproject.toml under the [tool.poetry.dependencies]
block. For developers, you will also need the packages under the [tool.poetry.dev-dependencies]
block.
Contributing
See CONTRIBUTING.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for blending_toolkit-0.9.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1200393d10a26c96b410dfe879d7ace35b145540580a6a0c553db29dc2496c28 |
|
MD5 | b30e4322f6b193f9cf8c9e3c62c4049b |
|
BLAKE2b-256 | 2466f3d360894dbb25c5ae5e5bd33b229fffc907c0a0fcd60fa520755db4eb1c |