Metadata-Version: 2.4
Name: alderaan
Version: 0.2.0
Summary: A python package for fast and robust exoplanet transit lightcurve modeling
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aesara-theano-fallback==0.1.0
Requires-Dist: arviz==0.12.1
Requires-Dist: astropy==5.3.2
Requires-Dist: celerite2==0.2.1
Requires-Dist: corner==2.2.2
Requires-Dist: cython==3.0.10
Requires-Dist: dynesty==2.1.3
Requires-Dist: exoplanet==0.5.3
Requires-Dist: exoplanet-core==0.1.2
Requires-Dist: h5py==3.9.0
Requires-Dist: ldtk==1.7.0
Requires-Dist: lightkurve==2.1.1
Requires-Dist: matplotlib==3.7.2
Requires-Dist: numba==0.55.1
Requires-Dist: numpy==1.21.6
Requires-Dist: pandas==1.5.3
Requires-Dist: pymc3==3.11.5
Requires-Dist: pymc3-ext==0.1.1
Requires-Dist: rebound==4.4.2
Requires-Dist: scipy==1.7.3
Requires-Dist: xarray==2022.9.0
Provides-Extra: dev
Requires-Dist: black==25.1.0; extra == "dev"
Requires-Dist: pylint==3.3.4; extra == "dev"
Requires-Dist: line_profiler; extra == "dev"
Requires-Dist: ipywidgets==8.1.3; extra == "dev"
Requires-Dist: notebook==6.4.13; extra == "dev"
Dynamic: license-file

# ALDERAAN
**ALDERAAN** is a pipeline for **A**utomated **L**ightcurve **D**etrending, **E**xoplanet **R**ecovery, and **A**nalysis of **A**utocorrelated **N**oise.

The pipeline is currently capable of processing photometric lightcurve data from the *Kepler* Space Telescope, but in the future will be extended to handle data from *K2* and *TESS*.

Detrending and transit fitting are optimized for high-fidelity measurements of transit parameters {$P, t_0, R_p/R_s, b, T_{14}$} and dynamical transit timing variations (TTVs). Autocorrelated noise arising from both instrumental and astrophysical sources is handled using a combination of Gaussian Processes (GP) regression, Fourier analysis, and narrow bandstop filters. Sampling is performed either Dynamic Nested Sampling.

The core scientific dependencies for this software are  ``astropy``, ``batman``, ``celerite``, ``dynesty``, ``numpy``, ``PyMC3``, and ``scipy``.


# Installation instructions

ALDERAAN requires a complex set of dependencies in order to run. To create a conda environment capable of running the ALDERAAN pipeline, follow the instructions below.

```
$ git clone https://github.com/gjgilbert/alderaan <LOCAL_DIR>
$ conda env create -n <ENV_NAME> -f <LOCAL_DIR>/environment.yml

if <ENV_NAME> is not specified, the conda environment will be named "alderaan"
```

# Running the pipeline

To test running the pipeline, navigate into <LOCAL_DIR> and run the following commmand

```
$ python tests/test_transit_model.py
```

The test is hard-coded to use data from K00148. All the necessary data is in the directory /tests/testdata and /tests/catalogs. `test_transit_model.py` will autmoatically pull from these directories.
