Skip to main content

The modular galaxy image simulation toolkit, but in JAX

Project description

JAX-GalSim

JAX port of GalSim, for parallelized, GPU accelerated, and differentiable galaxy image simulations.

Contributor Covenant Python package Documentation Status Ruff pre-commit.ci status CodSpeed Badge

Disclaimer: This project is still in an early development phase, please use the reference GalSim implementation for any scientific applications.

You can find the most up-to-date documentation for the project here.

Objective and Design

The goal of this library is to reimplement GalSim functionalities in pure JAX to allow for automatic differentiation, GPU acceleration, and batched computations.

Guiding Principles

  • Strive to be a drop-in replacement for GalSim, i.e. provide a close match to the GalSim API.
  • Each function/feature will be tested against the reference GalSim implementation.
  • This package will aim to be a subset of GalSim (i.e. only contains functions with a reference GalSim implementation).
  • Implementations should be easy to read and understand.
  • Code should be pip-installable on any machine, no compilation required.
  • Any notable differences between the JAX and reference implementations will be clearly documented.

Notable Differences

  • JAX arrays are immutable. Thus, in-place operations on images are not possible and a new image is returned instead. Also, the RNG classes cannot fill arrays and instead return new arrays.
  • JAX arrays do not support all the kinds of views that numpy arrays support. This means that some operations that work in GalSim may not work in JAX-GalSim (e.g., real views of complex images).
  • JAX-GalSim uses a different random number generator than GalSim. This leads to different results in terms of both the generated random numbers and in terms of which RNGs have stable discarding.

Contributing

Everyone can contribute to this project, please refer to the CONTRIBUTING.md document for details.

In short, to interact with the project you can:

Issues marked with contributions welcome or good first issue are particularly good places to start. These are great ways to learn more about the inner workings of GalSim and how to code in JAX.

Current GalSim API Coverage

See the corresponding documentation page for a list of what is currently implemented.

Project details


Download files

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

Source Distribution

jax_galsim-2026.6.0.tar.gz (412.7 kB view details)

Uploaded Source

Built Distribution

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

jax_galsim-2026.6.0-py3-none-any.whl (187.4 kB view details)

Uploaded Python 3

File details

Details for the file jax_galsim-2026.6.0.tar.gz.

File metadata

  • Download URL: jax_galsim-2026.6.0.tar.gz
  • Upload date:
  • Size: 412.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for jax_galsim-2026.6.0.tar.gz
Algorithm Hash digest
SHA256 40be93ba996527da1869ea20d48ae39836d28ded10dd5a4c0948891aefc34280
MD5 2799679ab130eead798eeb787a21cef0
BLAKE2b-256 9a90ef3200ab651f098b3574b8e3faefccddd71e10a57cc603d3a116407a2fc4

See more details on using hashes here.

Provenance

The following attestation bundles were made for jax_galsim-2026.6.0.tar.gz:

Publisher: release.yml on GalSim-developers/JAX-GalSim

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

File details

Details for the file jax_galsim-2026.6.0-py3-none-any.whl.

File metadata

  • Download URL: jax_galsim-2026.6.0-py3-none-any.whl
  • Upload date:
  • Size: 187.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for jax_galsim-2026.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f73b769b57c837256befb14d13745c4ac385c42778e497c13b3702dcbd695ec
MD5 d44ec99fcc1eb57320c382000d5e9ab2
BLAKE2b-256 361f66419450ba733c0dc2c7f915a9d3a447b34848b0ba652768160837aec60b

See more details on using hashes here.

Provenance

The following attestation bundles were made for jax_galsim-2026.6.0-py3-none-any.whl:

Publisher: release.yml on GalSim-developers/JAX-GalSim

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

Supported by

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