Metadata-Version: 2.5
Name: tessapps
Version: 0.1.5
Summary: TESS Aperture Photometry Pollution eStimator
Author-email: Leonidas Liponis <leolip128@proton.me>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: astropy
Requires-Dist: astroquery
Requires-Dist: lightkurve
Requires-Dist: bump-my-version ; extra == "dev"
Requires-Dist: flit ; extra == "dev"
Provides-Extra: dev
Import-Name: tessapps

# TESS Aperture Photometry Pollution eStimator   [![PyPI](https://img.shields.io/pypi/v/tessapps)](https://pypi.org/project/tessapps/)

## Description

A python module that calculates a contamination factor for the target star in a tpf file based on the flux of background stars.

## Prerequisites

Mandatory:

- ```numpy``` (2.4.2): to make all calculations
- ```scipy``` (1.17.1): to integrate the gaussian function
- ```astropy``` (8.0.1): to build data used in this module
- ```astroquery``` (0.4.11): to find stars in the target's region

Optional:

- lightkurve(2.6.0): to fetch tpf files
- ```matplotlib``` (3.10.8): to plot the result

## Running the module

To run this module, here is an example:
```
import tessapps as tapps

tapps.run(tpf_file)
```

Here is a more complete example:
```
import tessapps as tapps
import lightkurve as lk

tpf_file = lk.search_targetpixelfile("HAT-P-1", mission="TESS", sector=84, exptime=120).download()  # example file

tapps.run(tpf_file)
```

## File Organization

## Authors

Leonidas Liponis

## To-Do list

For version 0.2: make a to-do list
