Skip to main content

Documentation Status Build Status codecov PyPI - Version pypi-platforms License: GPL3 Project Status: Active – The project has reached a stable, usable state and is being actively developed. ruff-badge

jorbit logo

jorbit is a python/JAX package for simulating and fitting orbits of objects within the solar system. Built primarily in JAX, jorbit can compute exact derivatives even for models that involve complex numerical integrators, like IAS15, and acceleration functions, like Parameterized Post-Newtonian gravitation. It has several high-level convenience wrappers for dealing with standard massless minor planets, but also can enable more complex simulations through user-provided acceleration functions.

For more information, check out the documentation!

Installation

Exact installation instructions may depend on your hardware/environment, so see the installation page for more information. In general, you can install jorbit with pip:

Be aware! The first time you import jorbit, it will automatically download and cache (via the astropy caching mechanisms) about ~1 GB of files required to run its simulations, including the JPL DE400 ephemeris files. Other jorbit functions may also need to download/cache additional files, so be sure to have a good internet connection and enough disk space available.

python -m pip install -U jorbit

jorbit was built with uv, so if you want to replicate the exact development environment, use the uv.lock file. Check out the uv docs for more information.

Example Usage

Many more examples can be found in the docs, but here are two simple examples to get you started:

To create an ephemeris for a minor planet:

from astropy.time import Time
from jorbit import Particle

p = Particle.from_horizons(name="274301", time=Time("2025-01-01"))
ephem = p.ephemeris(
    times=Time(["2025-01-01", "2025-01-02", "2025-01-03"]),
    observer="Kitt Peak"
)

To identify all known minor planets nearby a certain position at a certain time:

import astropy.units as u
from astropy.coordinates import SkyCoord
from astropy.time import Time

from jorbit.mpchecker import mpchecker

mpchecker(
    coordinate=SkyCoord(ra=0 * u.deg, dec=0 * u.deg),
    time=Time("2025-01-01"),
    radius=10 * u.arcmin,
    extra_precision=True,
    observer="Palomar",
)

Contributing

If you have any trouble with the code, feel free to open an issue! We welcome open-source contributions, so if you have a feature request or bug fix, please open a pull request. For more information, see the contributing guide.

Attribution

jorbit is made freely available under the GPL License. If you use this code in your research, please cite the accompanying paper:

@ARTICLE{2025PSJ.....6..252C,
       author = {{Cassese}, Ben and {Rice}, Malena and {Lu}, Tiger},
        title = "{A High-precision, Differentiable Code for Solar System Ephemerides}",
      journal = {\psj},
     keywords = {Astronomy software, Solar system, Orbit determination, Bayesian statistics, 1855, 1528, 1175, 1900, Earth and Planetary Astrophysics, Instrumentation and Methods for Astrophysics},
         year = 2025,
        month = nov,
       volume = {6},
       number = {11},
          eid = {252},
        pages = {252},
          doi = {10.3847/PSJ/ae0a36},
archivePrefix = {arXiv},
       eprint = {2509.19549},
 primaryClass = {astro-ph.EP},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2025PSJ.....6..252C},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

Metadata

Release files for jorbit 1.7.0

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

Source distribution (sdist)

Source distribution for jorbit 1.7.0
File Size Uploaded
jorbit-1.7.0.tar.gz 36.4 MB Details

Built distribution (wheel)

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

Total release size: 36.6 MB

Release files / jorbit-1.7.0.tar.gz

Download URL jorbit-1.7.0.tar.gz
Size 36.4 MB
Tags Source
SHA-256 checksum
How to use checksums
3af00d025a556c3cce3a387d68e1430c794027450afda15c16ec718faa42c9cd
BLAKE2b-256 checksum
How to use checksums
09b528ba806749a62add885f35467ef7419810ab33a24600923fa3d44ba2b291
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / jorbit-1.7.0-py3-none-any.whl

Download URL jorbit-1.7.0-py3-none-any.whl
Size 212.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f488a554897630802dcb06f6242ee5675ac97b83a5ee812be3cebf0bc55982da
BLAKE2b-256 checksum
How to use checksums
45ea58339a023fe7f505f77a2aacf786676a43de7d2ca7147c5e633fc05e8281
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

1.7.0 This release

2 release files

1.6.5

2 release files

1.6.4

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.1

2 release files

1.3.0

1 release file

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.2.0

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.0.1

2 release files

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