Metadata-Version: 2.4
Name: folklore-clumps
Version: 0.1.1
Summary: Detection, cross-filter matching and photometry of star-forming clumps in multi-filter photometric data cubes
Author: Andressa Wille
License-Expression: MIT
Project-URL: Homepage, https://github.com/AndressaWille/folklore
Project-URL: Documentation, https://folklore.readthedocs.io
Project-URL: Issues, https://github.com/AndressaWille/folklore/issues
Keywords: astronomy,galaxies,clumps,jellyfish galaxies,JWST,HST,photometry
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: matplotlib>=3.5
Requires-Dist: astropy>=5.0
Requires-Dist: scikit-image
Requires-Dist: networkx
Requires-Dist: shapely>=2.0
Requires-Dist: geopandas
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: myst-nb; extra == "docs"
Dynamic: license-file

<img src="https://raw.githubusercontent.com/AndressaWille/folklore/master/docs/_static/folklore_logo.png" alt="FOLKLORE logo" width="170" align="left">

# FOLKLORE

**Finding Overdensities and Luminous Knots via LOcal contRast Estimation**

<br clear="left">

[![Documentation Status](https://readthedocs.org/projects/folklore/badge/?version=latest)](https://folklore.readthedocs.io/en/latest/)
[![Tests](https://github.com/AndressaWille/folklore/actions/workflows/tests.yml/badge.svg)](https://github.com/AndressaWille/folklore/actions/workflows/tests.yml)

Detection, cross-filter matching and photometry of star-forming clumps in
multi-filter photometric data cubes (JWST, HST, ...).

## Installation

```bash
pip install folklore-clumps
```

or, from source:

```bash
git clone https://github.com/AndressaWille/folklore.git
cd folklore
pip install .
```

The package is imported as `folklore`.

## Documentation

https://folklore.readthedocs.io

A tutorial notebook is in [`docs/tutorials/`](docs/tutorials/folklore_tutorial.ipynb).

## Input data

FITS data cubes with shape `(n_filters, ny, nx)`, a celestial WCS and one
`FILTERn` header keyword per slice — the format produced by
[lightstack](https://github.com/AndressaWille/lightstack).

## Contact

Open an issue or write to andressaw2@gmail.com.
