Metadata-Version: 2.4
Name: alderaan
Version: 0.2.2
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"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinxcontrib-napoleon; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Dynamic: license-file

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

ALDERAAN is a fast and reliable pipeline for processing exoplanet transit photometry. The pipeline is currently capable of handling data from the *Kepler* Space Telescope, but in the near future will be extended to handle data from *K2* and *TESS*.

Detrending and transit fitting are optimized for high-fidelity measurements of [P, t0, Rp/Rs, b, T14] and for inference of dynamical transit timing variations (TTVs). Noise arising from instrumental and astrophysical sources is handled using a combination of Gaussian Processes (GP) regression and autocorrelated frequency analysis. Model sampling is performed using dynamic nested sampling.

For detailed documentation, see [readthedocs.org](https://alderaan.readthedocs.io/en/latest/)

## Installation instructions

ALDERAAN requires a complex set of dependencies in order to run. To create a conda environment capable of running the ALDERAAN pipeline, copy environment.yml from the `alderaan` github repository to your local machine:

```
curl -o ./environment.yml https://raw.githubusercontent.comefs/heads/develop/environment.yml
```

Then run:

```
conda env create -n <ENV_NAME> -f environment.yml
```

If <ENV_NAME> is not specified, the conda environment will be named "alderaan-env".

You can then activate your environment and safely pip install the package:

```
conda activate alderaan-env
```

then

```
pip install alderaan
```


## Running the pipeline

To run the pipeline, navigate into the `alderaan` source directory and run the following commmand:

```
python alderaan/pipelines/alderaan_pipeline.py -m Kepler -t K00148 -c configs/default_config.cfg 
```

The flags -m (mission) -t (target) and -c (config) are required and set the pipeline run conditions.


## Attribution
If you make use of `alderaan` in your work, please cite [Gilbert, Petigura, & Entrican (2025)](https://ui.adsabs.harvard.edu/abs/2025PNAS..12205295G/abstract).

Please also cite the following core dependencies:
* `astropy` [Astropy Collaboration et al. (2022)](https://ui.adsabs.harvard.edu/abs/2022ApJ...935..167A/abstract)
* `batman` [Kreidberg (2015)](https://ui.adsabs.harvard.edu/abs/2015ascl.soft10002K/abstract)
* `celerite` [Foreman-Mackey 2018](https://ui.adsabs.harvard.edu/abs/2018RNAAS...2...31F/abstract)
* `dynesty` [Speagle (2020)](https://ui.adsabs.harvard.edu/abs/2020MNRAS.493.3132S/abstract)
* `numpy` [Harris et al, (2020)](https://ui.adsabs.harvard.edu/abs/2020Natur.585..357H/abstract)
* `PyMC3` [Salvatier, Wiecki, & Fonnesbeck (2016)](https://ui.adsabs.harvard.edu/abs/2016ascl.soft10016S/abstract)
* `scipy` [Virtanen et al. (2020)](https://ui.adsabs.harvard.edu/abs/2016ascl.soft10016S/abstract)
