Skip to main content

GRaTeR-JAX

Run Tests

DOI

GRaTeR-JAX is a machine learning JAX-based implementation of the Generalized Radial Transporter (GRaTeR) framework (Augereau+ 1999), designed for modeling scattered light observations of debris disks. This repository provides tools for forward modeling, optimization, and parameter estimation of debris disk images using JAX's accelerated computations.

Features

  • JAX-Based Optimization: Leverages JAX for fast, GPU/TPU-accelerated disk modeling.
  • Scattered Light Debris Disk Modeling: Implements physical models of circumstellar debris disks.
  • Differentiable Framework: Enables gradient-based optimization and probabilistic inference.
  • Integration with Webbpsf: Supports JWST PSF convolutions for forward modeling. (Experimental)

Installation

To install GRaTeR-JAX and its dependencies, create a new Conda environment with Python and run:

pip install grater-jax

Make sure you have JAX installed with the correct backend for your hardware:

pip install --upgrade "jax[cpu]"  # or "jax[cuda]" for GPU

Highly recommended to install this on a fresh environment, just to be safe.

Usage

Refer to the documentation at grater-jax.readthedocs.io.

Check out GRaTeR Image Generator to visualize how each of the parameters affect the disk model!

Repository Structure

GRaTeR-JAX/
│── grater-jax/       # Package root for grater-jax
   │── disk_model/    # Code for disk modeling
   │── optimization/  # Tools for statistical optimization and analysis
|── docs/             # Documentation and tutorial notebooks
|—— tests/            # Automated tests
│── pyproject.toml    # Installation file
│── README.md

Contributing

We welcome contributions! To contribute:

  1. Fork the repository.
  2. Create a feature branch:
    git checkout -b feature-branch
    
  3. Commit your changes and push to your fork.
  4. Open a pull request.

Acknowledgments

Developed by the UCSB Exoplanet Polarimetry Lab. This work is inspired by previous implementations of GRaTeR and advances in JAX-based differentiable modeling.


Metadata

Release files for grater-jax 0.3.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 grater-jax 0.3.0
File Size Uploaded Provenance Actions
grater_jax-0.3.0.tar.gz 66.3 kB With provenance Details for grater_jax-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for grater-jax 0.3.0
File Interpreter ABI Platform Actions
grater_jax-0.3.0-py3-none-any.whl Python 3 none any Details for grater_jax-0.3.0-py3-none-any.whl

Total release size: 127.6 kB

Release files / grater_jax-0.3.0.tar.gz

Download URL grater_jax-0.3.0.tar.gz
Size 66.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f45e3e63ebca332a8b858859833967dc87aac33497df05c5276091d9a89134fd
BLAKE2b-256 checksum
How to use checksums
bcc7dc53f0a7e131a8d77cdfa3ad8ac7e6a9d9b1d922be5d4c0672660f6dfb08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 13, 2026.

Transparency log

Release files / grater_jax-0.3.0-py3-none-any.whl

Download URL grater_jax-0.3.0-py3-none-any.whl
Size 61.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3bfff07c1e1a0db6e5a1be67a6972649fadbd1a0159c543d5e2d0105f7e5e77b
BLAKE2b-256 checksum
How to use checksums
2e15337838c23ecc9270144d5062ae4a2e079a3bc8a476f5ba840948ef5110c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 13, 2026.

Transparency log

Security for grater-jax 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for grater_jax-0.3.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 13, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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