Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.8 KB

README.md

File metadata and controls

53 lines (41 loc) · 1.8 KB

portrait

Observation metrics for periodic events

github license documentation

A Python package to compute and visualize observation metrics for periodic events.

In Astronomy, portrait is useful to answer the following questions:

  • How much of an orbit with period $P$ has been observed given certain observation times? (tutorial)
  • What period $P$ matches with this list of events? (tutorial)
  • How a certain target must be observed to cover all orbits with periods lower than $P$ days?

Documentation at portrait.readthedocs.io

Example

Given the range of periods you want to cover, here is how to compute the amout of phase covered by your observation times

from portrait import coverage

time = ... # your observation times
periods = np.linspace(0.1, 10, 2000)

covered = coverage(times)(periods) 

And plotting it with matplotlib

import matplotlib.pyplot as plt

plt.subplot(111, xlabel="periods", ylabel="coverage")
plt.plot(periods, covered, c="0.5")

image

Installation

pip install portrait