Skip to main content

A specialized binning scheme for eclipsing binary star light curves

Project description

Binning Eclipsing Binary Star Light Curves

Build Status License: MIT Python Versions PyPI Version Coverage

Binned Light Curve

Overview

This Python package provides a specialized binning scheme designed to more effectively capture the features of eclipsing binary star light curves. Unlike traditional uniform binning (middle panel), which can dilute the crucial details of eclipses, this non-uniform binning method (right panel) prioritizes the accurate representation of eclipse events.

Key Features

  • Eclipse-Focused Binning: The binning algorithm identifies the eclipse phases and allocates up to half of the total bins to these critical periods. The remaining bins are distributed across the out-of-eclipse regions.

  • Optimized Data Distribution: Using the pandas qcut function, the package ensures that each bin within the eclipse and out-of-eclipse segments contains approximately the same number of data points, maintaining the integrity of the light curve's structure.

  • Enhanced Accuracy: By concentrating bins around the brief, narrow eclipse phases, the method improves the resolution of these events, which are essential for deriving accurate parameters of the binary system.

Why Use This Binning Scheme?

Eclipses in binary star systems contain vital information about the system's properties, such as the relative sizes, masses, and orbital parameters of the stars. Standard uniform binning can obscure these details, especially when the eclipse duration is short relative to the orbital period. This package mitigates that issue by adaptively placing more bins where they matter most—during the eclipses—thereby preserving the fidelity of the light curve and improving the subsequent analysis.

How it Works

Getting Started

To start using the package, install it via pip:

pip install eclipsebin

Usage

import eclipsebin as ebin

# Example usage
binner = EclipsingBinaryBinner(phases, fluxes, fluxerrs, nbins=200, fraction_in_eclipse=0.2)
bin_centers, bin_means, bin_stds = binner.bin_light_curve(plot=True)

Refer to the documentation for more detailed usage instructions and examples.

Contributing

Contributions are welcome! Please refer to the Contributing Guide for guidelines on how to help improve this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eclipsebin-0.1.2.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eclipsebin-0.1.2-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file eclipsebin-0.1.2.tar.gz.

File metadata

  • Download URL: eclipsebin-0.1.2.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for eclipsebin-0.1.2.tar.gz
Algorithm Hash digest
SHA256 e8a284f36a3421a8817b8ead520b9cb81b1a64051b185042944e5948e4ec144d
MD5 a6e07425b72bbd45400ef09ccab67989
BLAKE2b-256 9335d243f53ed2f684503d04f79cb5f9ac52907c2879942cc3a020327d6bf0d7

See more details on using hashes here.

File details

Details for the file eclipsebin-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: eclipsebin-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for eclipsebin-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 27310560dee74403e62e70208e51b1260c57f8ed281a43d8b30c1ff39c1ed456
MD5 3e992c25b7fd7d8ce0d56ce6a1f77adb
BLAKE2b-256 f1e22d91e4f44e83136d30a97f4d03b3468b15bd838e7eb3b5c39bb57fbb6389

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page