Metadata-Version: 2.4
Name: orbdot
Version: 1.0.0
Summary: A Python package for studying secular evolution of exoplanet orbits using observational data.
Author-email: "Simone R. Hagey" <shagey@phas.ubc.ca>, "Aaron C. Boley" <acboley@phas.ubc.ca>
Maintainer-email: "Simone R. Hagey" <shagey@phas.ubc.ca>
License: MIT License
        
        Copyright (c) 2025 Simone Hagey
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Source, https://github.com/simonehagey/orbdot
Project-URL: Documentation, https://orbdot.readthedocs.io/en/latest/
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: astropy>=5.1.1
Requires-Dist: corner>=2.2.1
Requires-Dist: matplotlib>=3.6.0
Requires-Dist: nestle>=0.2.0
Requires-Dist: numpy>=1.24.0
Requires-Dist: scipy>=1.13.0
Provides-Extra: docs
Requires-Dist: sphinx>=7.1.2; extra == "docs"
Requires-Dist: sphinx_rtd_theme>=2; extra == "docs"
Requires-Dist: docutils>=0.18.1; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-togglebutton; extra == "docs"
Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: numpydoc; extra == "docs"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Dynamic: license-file


.. |OrbDot Logo Light| image:: https://github.com/simonehagey/orbdot/blob/main/docs/source/_static/orbdot_logo.png?raw=true#gh-light-mode-only
   :width: 310px

.. |OrbDot Logo Dark| image:: https://github.com/simonehagey/orbdot/blob/main/docs/source/_static/orbdot_logo_dark.png?raw=true#gh-dark-mode-only
   :width: 310px

.. |JOSS Status| image:: https://joss.theoj.org/papers/a7fb37729237dec9e965d7ee38cfd2ee/status.svg
   :target: https://joss.theoj.org/papers/a7fb37729237dec9e965d7ee38cfd2ee

.. |License Information| image:: https://img.shields.io/badge/license-MIT-blue.svg
   :target: https://github.com/simonehagey/orbdot/blob/main/LICENSE

.. |Documentation Status| image:: https://readthedocs.org/projects/orbdot/badge/?version=latest
   :target: https://orbdot.readthedocs.io/

.. |Test Status| image:: https://github.com/simonehagey/orbdot/actions/workflows/test.yaml/badge.svg
   :target: https://github.com/simonehagey/orbdot/actions/workflows/test.yaml

.. |PyPi Version| image:: https://img.shields.io/pypi/v/orbdot?label=pypi%20package
   :target: https://pypi.org/project/orbdot/1.0.0rc1/

.. |Zenodo Badge| image:: https://zenodo.org/badge/802446381.svg
   :target: https://doi.org/10.5281/zenodo.15346681

|OrbDot Logo Light|
|OrbDot Logo Dark|

:Contact: Simone R. Hagey (shagey@phas.ubc.ca)

|JOSS Status| |License Information| |Zenodo Badge|
|Documentation Status| |Test Status| |PyPi Version|

==================
Welcome to OrbDot!
==================
OrbDot is a Python package for studying the secular (long-term) evolution of exoplanet orbits using observational data. Using nested sampling algorithms, it fits evolutionary models using any combination of transit and eclipse timing, radial velocities, and transit durations.

In addition to model fitting, OrbDot offers tools for interpreting results, generating reports on model comparisons, derived tidal decay parameters, predicted precession rates, implications for planetary companions, and more.

Comprehensive documentation, including examples, is available on `Read the Docs <https://orbdot.readthedocs.io/>`__.

Installation
============
For installation instructions and dependency requirements, see the `installation guide <https://orbdot.readthedocs.io/en/latest/installation.html>`__.

Citing OrbDot
=============
If you use OrbDot in your research, please refer to the `citation instructions <https://orbdot.readthedocs.io/en/latest/citing-orbdot.html>`__.

Contributing to OrbDot
======================
Feedback, bug reports, feature requests, and code contributions are welcome! Please refer to the `contributing guidelines <https://orbdot.readthedocs.io/en/latest/community_guidelines.html>`__ for more information.

-----

TrES-1 b Case Study
===================
In addition to the documentation, there is a complementary `TrES-1 b case study <https://arxiv.org/abs/2508.15075>`__ that showcases the full functionality of OrbDot’s model-fitting and interpretive tools, while providing a deeper dive into the theoretical foundations behind the package. This paper consolidates key equations in one place, making it a valuable reference for researchers looking to apply OrbDot to their own work.


