Skip to main content

Blending ToolKit

Project description

BlendingToolKit

tests tests notebooks codecov Code style: black pre-commit PyPI

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.

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

Workflow

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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blending_toolkit-1.0.0a3.tar.gz (42.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

blending_toolkit-1.0.0a3-py3-none-any.whl (45.7 kB view details)

Uploaded Python 3

File details

Details for the file blending_toolkit-1.0.0a3.tar.gz.

File metadata

  • Download URL: blending_toolkit-1.0.0a3.tar.gz
  • Upload date:
  • Size: 42.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.8.10 Linux/5.15.0-1017-azure

File hashes

Hashes for blending_toolkit-1.0.0a3.tar.gz
Algorithm Hash digest
SHA256 c893e5bd39d6cbeb420efec5c615d9cc5dbdf5774da110e6196be64b97ac69e6
MD5 3ca1ea5911e43da35b1652e655ba0fe2
BLAKE2b-256 b30b442889bf22f168ee8af9d5d79afecce0b1e963c6e5833aa363f80955ee62

See more details on using hashes here.

File details

Details for the file blending_toolkit-1.0.0a3-py3-none-any.whl.

File metadata

  • Download URL: blending_toolkit-1.0.0a3-py3-none-any.whl
  • Upload date:
  • Size: 45.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.8.10 Linux/5.15.0-1017-azure

File hashes

Hashes for blending_toolkit-1.0.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 6581b35b86acbde850fb636704d029295a226e9b62212e8806fda0ce3ed242e6
MD5 9dd47ddc1b60e7a85a99e87df98a36bc
BLAKE2b-256 cab1076abb15ce83910325dd81c365170361d0a9f1f2f0b89e7a1711adfe893e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page