Skip to main content

TESS Aperture Photometry Pollution eStimator PyPI

Note: this module is not yet fully developed. For commercial use, please wait for v1.0.0. It is expected to be in development for at least another month.

Description

A python module that calculates a contamination factor in the aperture region of a tpf based on the relative flux of the background stars and the target.

HAT-P-1 example

Full documentation is available here. Below is some useful information, taken from the documentation.

Installation

Prerequisites

  • numpy (>=1.21.2): to make all calculations
  • scipy (>=1.7.2): to integrate the gaussian function
  • astropy (>=5.0): to build data used in this module
  • astroquery (>=0.4.6): to find stars in the target's region
  • matplotlib (>=3.5): to plot the result (shows aperture mask with a caption at the bottom)
  • lightkurve (>=2.0): to fetch and load tpf files

Python >=3.10 is required. More information about dependencies can be found here.

Install with pip install tessapps.

Running the module

Running from a notebook

A tpf is needed to run this module. If no tpf is supplied, the default is a file with HAT-P-1 (the example picture above). Here is the minimal example:

import tessapps

tessapps.run()

>>> [0.57675, 0.00191]

The first number is the contamination factor, and the second is its error. Here is a more realistic example:

import tessapps as tapps
from tessapps.search_parameters_to_tpf import find_tpf

tpf = find_tpf(TIC=346338552, mission="TESS", sector=84, exptime=120)  # HAT-P-1
contamination, error = tapps.run(tpf, result=True)

>>> The background contributes (57.675 ± 0.191)% of the total flux in the aperture region.

More information about usage in here.

Running from a terminal

Alternatively, from a terminal you can run this module as:

tapps --tpf star_tpf
python3 -m tessapps --tpf star_tpf

Authors

Leonidas Liponis

PyPI page: https://pypi.org/project/tessapps/

Codeberg page: https://codeberg.org/leolip128/tessapps

Email (for contact): lliponis (at) physics.auth.gr

AI Disclosure

No LLMs were used in the making of this project. All code was generated and verified by humans, so it will only contain human-made mistakes. All commits made by bots will be refused, and commits made by humans will be checked: published code should be fully understandable by the authors.

To-Do list

  • add description
  • redo the examples since they reference the flux instead of the contamination factor
  • add the scoring function
  • add more stuff in this to-do list

Metadata

Release files for tessapps 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tessapps 0.3.2
File Size Uploaded Provenance Actions
tessapps-0.3.2.tar.gz 10.6 kB Without provenance Details for tessapps-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tessapps 0.3.2
File Interpreter ABI Platform Actions
tessapps-0.3.2-py3-none-any.whl Python 3 none any Details for tessapps-0.3.2-py3-none-any.whl

Total release size: 22.3 kB

Release files / tessapps-0.3.2.tar.gz

Download URL tessapps-0.3.2.tar.gz
Size 10.6 kB
Tags Source
SHA-256 checksum
How to use checksums
a322028a9b1f6be6a707883d15701b457f51d6bd51405a40284c887616e45e60
BLAKE2b-256 checksum
How to use checksums
6c87b63d52677549138d2e948844f1266f4079f7ae29c918e4882dc6eadfc4a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.5

Release files / tessapps-0.3.2-py3-none-any.whl

Download URL tessapps-0.3.2-py3-none-any.whl
Size 11.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ce3b623f963ca9e76305e2d279b79b01a4a9c9c9503d0f7f06206e2e7962e159
BLAKE2b-256 checksum
How to use checksums
1c597ff84bbf94b8972b22a5e374944f7189777c270ad8176c66c032c95aa46e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.32.5

Security for tessapps 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page