portrait
Observation metrics for periodic events (e.g. transit search completeness)
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.4%) to scientific vocabulary
Keywords
Repository
Observation metrics for periodic events (e.g. transit search completeness)
Basic Info
- Host: GitHub
- Owner: lgrcia
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://portrait.readthedocs.io
- Size: 652 KB
Statistics
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 3
Topics
Metadata Files
README.md
portrait
Observation metrics for periodic events
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 ```python from portrait import coverage
time = ... # your observation times periods = np.linspace(0.1, 10, 2000)
covered = coverage(times)(periods)
And plotting it with `matplotlib`
python
import matplotlib.pyplot as plt
plt.subplot(111, xlabel="periods", ylabel="coverage") plt.plot(periods, covered, c="0.5") ```
Installation
bash
pip install portrait
Owner
- Name: Lionel J. Garcia
- Login: lgrcia
- Kind: user
- Website: lgrcia.github.io
- Repositories: 4
- Profile: https://github.com/lgrcia
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: portrait
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Lionel
family-names: Garcia
orcid: 'https://orcid.org/0000-0002-4296-2246'
repository-code: 'https://github.com/lgrcia/portrait'
url: 'https://portrait.readthedocs.io'
abstract: >-
A Python package to compute and visualize observations
phase coverage
keywords:
- astronomy
- exoplanets
- observations
license: MIT
GitHub Events
Total
Last Year
Packages
- Total packages: 1
-
Total downloads:
- pypi 33 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
- Total maintainers: 1
pypi.org: portrait
Compute and visualize observations phase coverage
- Documentation: https://portrait.readthedocs.io/
- License: mit
-
Latest release: 0.0.5b0
published almost 2 years ago
Rankings
Maintainers (1)
Dependencies
- numpy >=1.23.5
- actions/checkout v4 composite
- actions/download-artifact v4 composite
- actions/setup-python v5 composite
- actions/upload-artifact v4 composite
- pypa/gh-action-pypi-publish v1.8.14 composite