Skip to main content

orbix

A JAX library of functions for exoplanet simulations: differentiable Keplerian orbit propagation and Kepler-equation solvers, plus solar-system geometry (observatory position, keepout) for the Habitable Worlds Observatory direct imaging simulation suite. Scene composition (planet catalogs, EXOSIMS integration, zodiacal photometry) lives in other libraries; see below.

Install

pip install orbix

Quickstart

import jax.numpy as jnp
from orbix.orbit import KeplerianOrbit
from orbix.kepler.shortcuts.grid import get_grid_solver

orbit = KeplerianOrbit(
    a_AU=1.0, e=0.0167, W_rad=0.0, i_rad=0.0, w_rad=0.0, M0_rad=0.0, t0_d=0.0,
)
trig_solver = get_grid_solver(level="scalar", E=False, trig=True)
t_jd = jnp.linspace(2451545.0, 2451545.0 + 365.25, 5)
r_AU, phase_angle_rad, dist_AU = orbit.propagate(trig_solver, t_jd, Ms_kg=1.989e30)
print(r_AU.shape)  # (1, 3, 5): (K orbits, xyz, T times)

get_grid_solver builds a cached grid-interpolation Kepler solver with the contract trig_solver(M, e) -> (sinE, cosE); KeplerianOrbit.propagate uses it to convert orbital elements and times into position vectors, phase angle, and star-planet distance.

Scope

orbix provides Keplerian orbit geometry and Kepler-equation solvers; scene composition lives in skyscapes.

Citation

If you use orbix, please cite it as described in CITATION.cff.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orbix-1.0.0.tar.gz (97.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orbix-1.0.0-py3-none-any.whl (80.5 kB view details)

Uploaded Python 3

File details

Details for the file orbix-1.0.0.tar.gz.

File metadata

  • Download URL: orbix-1.0.0.tar.gz
  • Upload date:
  • Size: 97.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for orbix-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ae41371b7242ec01f238bb0f1dbcc7e98410f35aa8164a0e26dc474b2f64781e
MD5 f75872fb4ca7deb921d5978af79059ca
BLAKE2b-256 5aefb7dfea0aec153a098de8f64976e2c6db71aaa1a487236c4807e90bdd120b

See more details on using hashes here.

Provenance

The following attestation bundles were made for orbix-1.0.0.tar.gz:

Publisher: publish-to-pypi.yml on CoreySpohn/orbix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file orbix-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: orbix-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 80.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for orbix-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d40ef2dcba227cb23eaeed1fc21769c67104765abd1e8e2a8998217e7f201038
MD5 e3523ee0100774c98ebbf06a8f976f08
BLAKE2b-256 13b621f73bf88af343ff2de57d7db551c397bf2006e3c5d3bd035fecf463df41

See more details on using hashes here.

Provenance

The following attestation bundles were made for orbix-1.0.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on CoreySpohn/orbix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 files

0.9.0

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

0.0.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page