# CORBITS.jl

CORBITS is the Computed Occurrence of Revolving Bodies for the Investigation of Transiting Systems. CORBITS.jl is a Julia package that makes it easy for researchers to build and call code contained in the CORBITS library written in C by Joshua Brakensiek and Darin Ragozzine.

## Introduction

To start using CORBITS.jl,

```
julia -e 'import Pkg; Pkg.add("CORBITS")
```

Alternatively, you can clone and build the C library. First, you'd clone the repository.

```
git clone https://github.com/jbrakensiek/CORBITS.git
```

Then, you can build the CORBITS library and usage examples by typing `make`

. To only build the CORBITS library, type `make lib`

. If you want to call CORBITS from Julia or other languages, then you need to help them find the library.

## Requirements

If using CORBITS.jl, then the Julia (>=v0.7.0) package manager should take care of things for you.

To use the base of CORBITS (the library and CLI), only a reasonably modern version of g++ is necessary. To fully utilize some of the examples, there are additional requirements.

- Python 2.x with the packages NumPy, SciPy, and matplotlib.
- R with the packages ADGofTest and psych.

## Examples

The following examples of using the CORBITS C library are available.

`kepler-11`

: Reproduces the data making the golden curve in Figure 4 of Lissauer, et. al., 2011. See here.`kepler-90`

: Same as`kepler-11`

, except run on the Kepler 90 dataset.`period-dist`

: Produces a period-ratio distribution of the Kepler Candidates (KOIs) which is geometrically debiased. It utilizes the most recent data from the NASA Exoplanet Archive. Summary histograms using matplotlib can be made with`make period-hist`

.`mhs-dist`

: Same as`period-dist`

except computing the mutual hill spheres instead of period-ratios.- `case-trans': Computes the mutual inclinations of the "phase transitions" of the transiting geometry (see the Brakensiek & Ragozzine for more details).
`solar-system`

: Calculates the transit probabilities of the Solar System from the perspective of a distant external observer.- `koi-table': Generates the LaTeX table in Brakensiek & Ragozzine of observation probabilities of various KOI systems.

To build an example, type `make name-of-example`

. To run it, type `make run-name-of-example`

(or run the binary file).

If you find CORBITS useful, please cite (Brakensiek & Ragozzine (2016) ApJ, 821, 47. doi ).