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

  5. photutils

  6. astroalign

  7. astroquery

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 utilities
from dorado.clippy import Clippy
from dorado.zellars import Zellars

## initialize
# make an instance of clippy
clip = Clippy()
# create a target object
target = Zellars('target_name')
# create a control target object
# create a series object
ceres = clip.mkceres('2021-01-01+02', target = target)

## call
# calibrate the series red filter data
ceres.calibrate('R')
# align the series red filter data
ceres.align('R', clip, cache = True)
# perform differential photometry on the target in the red filter
# data using the control as a reference
ceres.dorphotc('R', target, control, shape = 21)

## finish by saving
# save the resulting data
clip.savewrk(ceres)
# record the results
target.record(clip, ceres)

Next: Clippy