[](https://codecov.io/gh/LSSTDESC/BlendingToolKit)
[](https://github.com/psf/black)
[](https://github.com/pre-commit/pre-commit)
[](https://www.python.org/downloads/release/python-370/)
# 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
<img src="docs/source/images/current_flowchart.png" alt="btk workflow" width="450"/>
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 (eg `sampling_function(catalog)`) and the `__next__` method is executed when using `next` (eg `next(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](https://github.com/LSSTDESC/BlendingToolKit/tree/main/notebooks) 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](https://stanford.app.box.com/s/s1nzjlinejpqandudjyykjejyxtgylbk).
- [Cosmo DC2](https://arxiv.org/abs/1907.06530) catalog requires pre-processing in order to be used as input catalog to btk. Refer to this [notebook](https://github.com/LSSTDESC/WeakLensingDeblending/blob/cosmoDC2_ingestion/notebooks/wld_ingestion_cosmoDC2.ipynb) 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](https://lsstdesc.org/BlendingToolKit/install.html).
For required packages, see [pyproject.toml](https://github.com/LSSTDESC/BlendingToolKit/blob/main/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](https://github.com/LSSTDESC/BlendingToolKit/blob/main/CONTRIBUTING.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/LSSTDESC/BlendingToolKit",
"name": "blending-toolkit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1,<4.0.0",
"maintainer_email": "",
"keywords": "cosmology,galaxies,blending,lsst,simulation",
"author": "Ismael Mendoza",
"author_email": "imendoza@umich.edu",
"download_url": "https://files.pythonhosted.org/packages/df/df/6894243aaf75825e67f26b7d9cdf4bbb0c2fc948ef6e8494ea45c4c7f93e/blending_toolkit-0.9.3.tar.gz",
"platform": "",
"description": "\n\n[](https://codecov.io/gh/LSSTDESC/BlendingToolKit)\n[](https://github.com/psf/black)\n[](https://github.com/pre-commit/pre-commit)\n[](https://www.python.org/downloads/release/python-370/)\n\n# BlendingToolKit\nFramework for fast generation and analysis of galaxy blends catalogs. This toolkit is a convenient way of\nproducing multi-band postage stamp images of blend scenes.\n\nDocumentation can be found at https://lsstdesc.org/BlendingToolKit/index.html\n\n## Workflow\n<img src=\"docs/source/images/current_flowchart.png\" alt=\"btk workflow\" width=\"450\"/>\n\nColor code for this flowchart:\n- Classes in black should be used as is by the user.\n- 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.\n- In blue is the code for instantiating the classes within the code (optional arguments not included).\n- In green are the revelant methods for the classes; please note that the `__call__` method is executed when calling the object (eg `sampling_function(catalog)`) and the `__next__` method is executed when using `next` (eg `next(generator)`).\n\n## Running BlendingToolKit\n- BlendingToolKit (btk) requires an input catalog that contains information required to simulate galaxies and blends.\nThis repository includes sample input catalogs with a small number of galaxies that can be used to draw blend images with btk. See [tutorials](https://github.com/LSSTDESC/BlendingToolKit/tree/main/notebooks) to learn how to run btk with these catalogs.\n- CatSim Catalog corresponding to one square degree of sky and processed WeakLensingDeblending catalogs can be downloaded from [here](https://stanford.app.box.com/s/s1nzjlinejpqandudjyykjejyxtgylbk).\n- [Cosmo DC2](https://arxiv.org/abs/1907.06530) catalog requires pre-processing in order to be used as input catalog to btk. Refer to this [notebook](https://github.com/LSSTDESC/WeakLensingDeblending/blob/cosmoDC2_ingestion/notebooks/wld_ingestion_cosmoDC2.ipynb) on how to convert the DC2 catalog into a CatSim-like catalog that can be analyzed with btk.\n\n## Installation\nBTK is pip installable, with the following command:\n\n```\npip install blending_toolkit\n```\n\nAlthough you might run into problems installing `galsim`. In case of any issues, please see the more detailed installation instructions [here](https://lsstdesc.org/BlendingToolKit/install.html).\n\nFor required packages, see [pyproject.toml](https://github.com/LSSTDESC/BlendingToolKit/blob/main/pyproject.toml) under the `[tool.poetry.dependencies]` block. For developers, you will also need the packages under the `[tool.poetry.dev-dependencies]` block.\n\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/LSSTDESC/BlendingToolKit/blob/main/CONTRIBUTING.md)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Blending ToolKit",
"version": "0.9.3",
"project_urls": {
"Bug Tracker": "https://github.com/LSSTDESC/BlendingToolKit/issues",
"Documentation": "https://lsstdesc.org/BlendingToolKit/index.html",
"Homepage": "https://github.com/LSSTDESC/BlendingToolKit",
"Repository": "https://github.com/LSSTDESC/BlendingToolKit"
},
"split_keywords": [
"cosmology",
"galaxies",
"blending",
"lsst",
"simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2466f3d360894dbb25c5ae5e5bd33b229fffc907c0a0fcd60fa520755db4eb1c",
"md5": "b30e4322f6b193f9cf8c9e3c62c4049b",
"sha256": "1200393d10a26c96b410dfe879d7ace35b145540580a6a0c553db29dc2496c28"
},
"downloads": -1,
"filename": "blending_toolkit-0.9.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b30e4322f6b193f9cf8c9e3c62c4049b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1,<4.0.0",
"size": 55941,
"upload_time": "2021-07-21T22:58:11",
"upload_time_iso_8601": "2021-07-21T22:58:11.372005Z",
"url": "https://files.pythonhosted.org/packages/24/66/f3d360894dbb25c5ae5e5bd33b229fffc907c0a0fcd60fa520755db4eb1c/blending_toolkit-0.9.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dfdf6894243aaf75825e67f26b7d9cdf4bbb0c2fc948ef6e8494ea45c4c7f93e",
"md5": "944cddda562be0d8a916b749e113f881",
"sha256": "d12d78393d21dd118c341b2d54bb2e95e31f3694d656394de2a7cf12c928e394"
},
"downloads": -1,
"filename": "blending_toolkit-0.9.3.tar.gz",
"has_sig": false,
"md5_digest": "944cddda562be0d8a916b749e113f881",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1,<4.0.0",
"size": 48468,
"upload_time": "2021-07-21T22:58:12",
"upload_time_iso_8601": "2021-07-21T22:58:12.974154Z",
"url": "https://files.pythonhosted.org/packages/df/df/6894243aaf75825e67f26b7d9cdf4bbb0c2fc948ef6e8494ea45c4c7f93e/blending_toolkit-0.9.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-07-21 22:58:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LSSTDESC",
"github_project": "BlendingToolKit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "blending-toolkit"
}
JSON
