Getting Started with Dorado

Install

Install dorado by running the command: pip install dorado.

Note

The dorado project on PyPI .

Pip should install all relevent dependencies for dorado into the python environment pip was run from. The dorado team recommends using the latest version of python unless otherwise mentioned for the best compatibility.

Dependencies

Dorado aims to be as lightweight as possible and utilize as little dependencies as it can.

Currently DORADO relies on:

  1. numpy

  2. matplotlib

  3. astropy

  4. CCDPROC >> CCDprocX

  5. scipy

  6. photutils

  7. astroquery

  8. astroalign

  9. tqdm

  10. lightkurve

    Note

    CCDPROC requires the astroscrappy package for install. Currently, astroscrappy requires Visual C++ redistributable for build and function. This install step has a variety of potential issues users can encounter so DORADO instead uses a fork of CCDPROC with astroscrappy removed known as ccdprocx.

Babies first Dorado script

Adding Dorado into your flow is fairly simple and can be broken into 3 main steps; import, initialize, and call.

## import
import dorado

## initialize
# create a target object 'target of interest' toi
toi = 'target_name'
Dorado.mktrgt(toi)
# create a control target object
control = 'control_target_name'
Dorado.mktrgt(control)
# create a series object
Dorado.mkceres('2021-01-01+02', name = 'ceres01', target = toi)

## call
# calibrate the series red filter data
Dorado.dorphot.calibrate('ceres01','R')
# align the series red filter data
Dorado.dorphot.align('ceres01', 'R')
# perform differential photometry on the target in the red filter
# data using the control as a reference
Dorado.dorphot.apPhot('ceres01', 'R', toi, control)

## finish by saving
# save the resulting ceres data
Dorado.savewrk('ceres01')
# record the target results
Dorado.targets[Dorado.target_keys[toi]].record('ceres01')

Next: Dorado Core