pystrometry

Package to support the analysis of high-precision astrometry timeseries, in particular the determination of Keplerian orbits.

https://github.com/johannes-sahlmann/pystrometry

Science Score: 64.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
    Links to: zenodo.org
  • Committers with academic emails
    3 of 5 committers (60.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Package to support the analysis of high-precision astrometry timeseries, in particular the determination of Keplerian orbits.

Basic Info
  • Host: GitHub
  • Owner: Johannes-Sahlmann
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Size: 2.98 MB
Statistics
  • Stars: 17
  • Watchers: 3
  • Forks: 5
  • Open Issues: 4
  • Releases: 10
Created about 7 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

Build Status Documentation Status PyPI version PyPI - License DOI

pystrometry - Support for high-precision astrometry timeseries analysis

This code collection evolved over the last 10+ years and does therefore not always conform with coding standards and best practices, but it is installable via PyPI: pip install pystrometry.

pystrometry provides a variety of functionalities and has been used in several publications. It is under active development.

Example usages

  • Plotting the orbital motion with default parameters

    from pystrometry.pystrometry import OrbitSystem 
    
    orb = OrbitSystem()  # default parameters
    orb.plot_orbits()    
    

    More customised orbit plotting example from this notebook: 2exoplanetexample_orbit.ipynb

  • Define the system parameters

    from collections import OrderedDict
    attribute_dict = OrderedDict([  ('RA_deg', 164.), 
                                    ('DE_deg', -21.),
                                    ('absolute_plx_mas', 27.), 
                                    ('Tp_day', 57678.4), 
                                    ('omega_deg', -23.),
                                    ('P_day', 687.), 
                                    ('ecc', 0.08), 
                                    ('OMEGA_deg', 114.),
                                    ('i_deg', 31.), 
                                    ('m1_MS', 0.9),
                                    ('m2_MJ', 3.)])
    
    orb = OrbitSystem(attribute_dict)
    orb.plot_orbits() 
    

    Compute the proper motion displacements in RA, Dec for the system:

    t_mjd = np.linspace(50000, 52000)
    delta_ra_star_mas, delta_dec_mas = orb.ppm(t_mjd)
    
  • Compute and plot the astrometric amplitudes of known exoplanets.
    The code is in this notebook: 1exoplanetsignatures.ipynb

Example conda environment creation that allows for running the example notebooks

This requires a conda installation.

Create a dedicated environment (here named astrom) with the necessary dependencies:

conda create --name astrom --yes python=3.7 pandas=1.2.5 pip jupyterlab pyyaml uncertainties

Activate that environment:

conda activate astrom

Install pystrometry from PyPI:

pip install pystrometry

Open jupyter notebook, e.g.

jupyter notebook [path-to-downloaded-file]2_exoplanet_example_orbit.ipynb

Contributing

Please open a new issue or new pull request for bugs, feedback, or new features you would like to see. If there is an issue you would like to work on, please leave a comment and we will be happy to assist. New contributions and contributors are very welcome!

References

Citation

If you find this package useful, please consider citing the Zenodo record using the DOI badge above. Please find additional citation instructions in CITATION.

Owner

  • Name: Johannes Sahlmann
  • Login: Johannes-Sahlmann
  • Kind: user
  • Location: Madrid, Spain

Citation (CITATION)

If you use `pystrometry` for work/research presented in a publication (whether directly,
or as a dependency to another package), we recommend and encourage the following acknowledgment:

  This research made use of pystrometry, an open source Python package for
  astrometry timeseries analysis (Sahlmann 2019).

where (Sahlmann 2019) is a citation of the Zenodo record, e.g.:

@software{johannes_sahlmann_2019_3515526,
  author       = {Johannes Sahlmann},
  title        = {Johannes-Sahlmann/pystrometry: Release for Zenodo},
  month        = oct,
  year         = 2019,
  publisher    = {Zenodo},
  version      = {v0.0dev59},
  doi          = {10.5281/zenodo.3515526},
  url          = {https://doi.org/10.5281/zenodo.3515526}
}

GitHub Events

Total
  • Create event: 4
  • Issues event: 3
  • Release event: 1
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 28
  • Pull request event: 5
Last Year
  • Create event: 4
  • Issues event: 3
  • Release event: 1
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 28
  • Pull request event: 5

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 138
  • Total Committers: 5
  • Avg Commits per committer: 27.6
  • Development Distribution Score (DDS): 0.529
Top Committers
Name Email Commits
Johannes Sahlmann j****n@s****t 65
Johannes Sahlmann j****n@s****u 60
O . O j****r@s****u 9
Nicolas Unger n****r@u****h 3
NBauchet 5****t@u****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 7
  • Total pull requests: 24
  • Average time to close issues: about 3 years
  • Average time to close pull requests: about 1 month
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 0.43
  • Average comments per pull request: 0.42
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: about 22 hours
  • Issue authors: 3
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.2
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Johannes-Sahlmann (3)
  • pllim (2)
  • JanM1989 (1)
  • jlopezmi (1)
Pull Request Authors
  • Johannes-Sahlmann (23)
  • ojustino (2)
  • NBauchet (1)
  • nicochunger (1)
Top Labels
Issue Labels
enhancement (2)
Pull Request Labels
documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 40 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 14
  • Total maintainers: 1
pypi.org: pystrometry

Support for astrometry timeseries analysis

  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 40 Last month
Rankings
Dependent packages count: 9.8%
Stargazers count: 15.2%
Forks count: 15.4%
Average: 18.5%
Dependent repos count: 21.9%
Downloads: 30.2%
Maintainers (1)
Last synced: 7 months ago

Dependencies

setup.py pypi
  • astropy *
  • s.strip *
astropy_helpers/setup.py pypi
.github/workflows/python-package-conda.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v3 composite