Metadata-Version: 2.1
Name: tpfi
Version: 1.2.2
Summary: Plot identification charts for Kepler, K2 and TESS.
Home-page: https://github.com/keyuxing/tpfi
License: MIT
Author: Keyu Xing
Author-email: kyxing@mail.bnu.edu.cn
Requires-Python: >=3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: lightkurve (>=2.3)
Project-URL: Repository, https://github.com/keyuxing/tpfi
Description-Content-Type: text/markdown

# tpfi
[![PyPI version](https://badge.fury.io/py/tpfi.svg)](https://badge.fury.io/py/tpfi)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

`tpfi` is an easy-to-use visualization tool for astronomers to identify and analyze 
stars in the Kepler, K2, and TESS missions. The main focus of this project is on 
two functions: `plot_identification` and `plot_season`. These functions create 
plots to help visualize target stars and their surrounding environments.

---

**Plot identification charts for Kepler, K2 and TESS.**

![alt text](https://raw.githubusercontent.com/keyuxing/tpfi/main/examples/kepler.png)

![alt text](https://raw.githubusercontent.com/keyuxing/tpfi/main/examples/k2.png)

![alt text](https://raw.githubusercontent.com/keyuxing/tpfi/main/examples/tess.png)

The `plot_identification` function creates identification charts, which are useful 
for determining if a target is contaminated by nearby stars. In each chart, the 
right panel overlays the Gaia DR3 catalog onto the TESS Target Pixel Files (TPF) 
with the target marked by a cross symbol. The circle size represents the relative 
brightness of the stars according to Gaia G magnitude. The left panel displays the 
same sky coverage but taken from the 
[DSS2 Red survey](https://skyview.gsfc.nasa.gov/current/cgi/moreinfo.pl?survey=DSS2%20Red).

This function is revised based on 
[_tpfplotter_](https://github.com/jlillo/tpfplotter). 

---

**Plot season charts for Kepler targets.**

![alt text](https://raw.githubusercontent.com/keyuxing/tpfi/main/examples/season.png)

The `plot_season` function creates a plot of the TPF for each season of the Kepler 
mission for a given target star. Note that this function is only applicable for 
Kepler targets.

## Installation

You can install this package using `pip`:
```shell
pip install tpfi
```

## How to use

See the [example notebook](https://raw.githubusercontent.com/keyuxing/tpfi/main/examples/tutorial.ipynb) for more details.

## Contributing

If you would like to contribute to this project, feel free to submit a pull request 
or open an issue on GitHub. Any suggestion, improvement, or bug report is welcomed.

## License

This project is licensed under the MIT License - see the 
[LICENSE](https://raw.githubusercontent.com/keyuxing/tpfi/main/LICENSE) file for details.
