Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 8 DOI reference(s) in README -
✓Academic publication links
Links to: arxiv.org, zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.8%) to scientific vocabulary
Keywords
Repository
Bayesian mass-radius relation for small planets.
Basic Info
Statistics
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 1
- Releases: 2
Topics
Metadata Files
README.md
Spright
Spright (/sprat/; Parviainen, Luque, and Palle, 2023) is a fast Bayesian radius-density-mass relation for small planets. The package allows one to predict planetary masses, densities, and RV semi-amplitudes given the planet's radius or planetary radii given the planet's mass.
The package offers an easy-to-use command line script for people not overly interested in coding and a nearly-as-easy-to-use set of Python classes for those who prefer to code. The command line script can directly create publication-quality plots, and the classes offer a full access to the predicted numerical distributions.
The package contains two relations: one for small planets orbiting M dwarfs (inferred from a updated SPTM catalogue by R. Luque) and another for planets orbiting FGK stars (inferred from a filtered TepCAT catalogue).
Installation
pip install spright
Usage
From the command line
spright --predict mass --radius 1.8 0.1 --plot-distribution
Python code
from spright import RMRelation
rmr = RMRelation()
mds = rmr.predict_mass(radius=(1.8, 0.1))
mds.plot()
RV semi-amplitude prediction
The radial velocity semi-amplitude can be predicted given the planet's radius, orbital period, orbital eccentricity (optional), and the host star mass.
from spright import RMRelation
rmr = RMRelation()
mds = rmr.predict_rv_semi_amplitude(radius=(1.8, 0.1), period=2.2, mstar=(0.5, 0.05), eccentricity=0.01)
mds.plot()
Here the RMRelation.predict_rv_semi_amplitude method can also be given the planet's orbital eccentricity (ecc),
and all the parameters (radius, period, mstar, and eccentricity) can either be floats, ufloats, or two-value tuples where the second value gives
the parameter uncertainty.
Calculation of a new radius-density-mass relation
from spright import RMEstimator
rme = RMEstimator(names=names, radii=radii, masses=masses)
rme.optimize()
rme.sample()
rme.compute_maps()
rme.save('map_name.fits')
© 2023 Hannu Parviainen
Owner
- Name: Hannu Parviainen
- Login: hpparvi
- Kind: user
- Location: La Laguna, Tenerife, Spain
- Company: Instituto de Astrofísica de Canarias (IAC)
- Repositories: 42
- Profile: https://github.com/hpparvi
Ramón y Cajal Fellow studying exoplanets in the Instituto de Astrofísica de Canarias.
GitHub Events
Total
- Watch event: 1
- Push event: 1
- Fork event: 2
- Create event: 1
Last Year
- Watch event: 1
- Push event: 1
- Fork event: 2
- Create event: 1
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Hannu Parviainen | h****i@g****m | 147 |
| Hannu Parviainen | h****u@i****s | 18 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 9 months ago
All Time
- Total issues: 1
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 1
- Total pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 0.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- hpparvi (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 237 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 15
- Total maintainers: 1
pypi.org: spright
Bayesian radius-density-mass relation for small planets.
- Documentation: https://spright.readthedocs.io/
- License: GNU General Public License v3 (GPLv3)
-
Latest release: 25.6.3
published 10 months ago