Metadata-Version: 2.4
Name: lk_stat_package
Version: 0.1.4
Summary: A Cython-based package for computing the Laffler-Kinman statistic.
Author: Princy Ranaivomanana
Author-email: rtprincy@gmail.com
Platform: manylinux2014_x86_64
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Cython
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: cython
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: platform
Dynamic: requires-dist
Dynamic: summary

This package computes the Laffler-Kinman statistic $\Theta$ for time-series data, incorporating the uncertainties of the flux/magnitude measurements.

## Installation

To install the package, run the following command:


pip install lk-stat-package




## Usage

### Importing the Package

Use the following line of code to import the package:


from lk_stat_package import lk_stat


### Computing the Laffler-Kinman Statistic

To compute the Laffler-Kinman statistic, use the `lk_stat` function as shown below:


theta = lk_stat(periods, magnitude, magnitude_err, time)


**Parameters:**
- periods: Array of trial periods.
- mag: Array of observed magnitudes.
- magerr: Array of magnitude uncertainties.
- Time: Array of observation times.

**Returns:**
- theta: The Laffler-Kinman statistic for each trial period.

Feel free to contact the author for any questions or contributions!


