Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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

Metadata

Release files for portrait 0.0.5b0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for portrait 0.0.5b0
File Size Uploaded
portrait-0.0.5b0.tar.gz 168.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for portrait 0.0.5b0
File Interpreter ABI Platform
portrait-0.0.5b0-py3-none-any.whl Python 3 none any Details

Total release size: 173.8 kB

Release files / portrait-0.0.5b0.tar.gz

Download URL portrait-0.0.5b0.tar.gz
Size 168.8 kB
Tags Source
SHA-256 checksum
How to use checksums
511372f93179ba013cb6eab20f2d71baa6e8a9191a78381d048b3c56fdcca47e
BLAKE2b-256 checksum
How to use checksums
f5b239d6db866fe022df38c304e7eb89ce3fe8cdfaa094400929ccd2aec0ec70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / portrait-0.0.5b0-py3-none-any.whl

Download URL portrait-0.0.5b0-py3-none-any.whl
Size 5.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7c75d15fe46efcdbf393baea01c0973be5d84423df73a74e6386c913d47c904d
BLAKE2b-256 checksum
How to use checksums
a24225f7acb391cb1d81bd938bb5942d2940eb33d8b53e9505a09246b71adddb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page