https://github.com/CoastEgo/microlux

Implementation of automatic differentiation in VBozza's BinaryLensing
https://github.com/CoastEgo/microlux

astronomy gravitational-lensing jax microlensing

Last synced: 29 days ago
JSON representation

Implementation of automatic differentiation in VBozza's BinaryLensing

• Host: GitHub
• URL: https://github.com/CoastEgo/microlux
• Owner: CoastEgo
• License: mit
• Created: 2023-02-10T06:10:04.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2026-03-09T07:27:05.000Z (3 months ago)
• Last Synced: 2026-04-02T15:41:43.839Z (2 months ago)
• Topics: astronomy, gravitational-lensing, jax, microlensing
• Language: Jupyter Notebook
• Homepage: https://coastego.github.io/microlux/
• Size: 4.76 MB
• Stars: 13
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-JAXtronomy - microlux - A differentiable microlensing model using adaptive contour integration method <img src="https://img.shields.io/github/stars/CoastEgo/microlux?style=social" align="center"> (Exoplanets)

README

          
## microlux: Microlensing using Jax

[![Test Status](https://github.com/coastego/microlux/actions/workflows/run_test.yml/badge.svg)](https://github.com/CoastEgo/microlux/actions/workflows/run_test.yml)

[![Documentation Status](https://github.com/coastego/microlux/actions/workflows/build_docs.yml/badge.svg)](https://coastego.github.io/microlux/)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/CoastEgo/microlux)

---

`microlux` is a Jax-based package that can calculate the binary lensing light curve and its derivatives both efficiently and accurately.  We use the modified adaptive contour integratoin in `VBBinaryLensing` to maximize the performance. 

With the access to the gradient, we can use more advanced algorithms for microlensing modeling, such as Hamiltonian Monte Carlo (HMC) in `numpyro`.

## Installation

``` bash

pip install microlux

```

or you can install this package from source for development. 

``` bash 

git clone https://github.com/CoastEgo/microlux.git

cd microlux

pip install -e .

```

## Documentation

The documentation is available at here. See this for more details.

  

## Citation

`microlux` is open-source software licensed under the MIT license. If you use this package for your research, please cite our paper:

- A differentiable binary microlensing model using adaptive contour integration method: in arXiv and in AJ .

``` bibtex

@article{ren2025microlux,

       author = {{Ren}, Haibin and {Zhu}, Wei},

        title = "{A Differentiable Binary Microlensing Model Using Adaptive Contour Integration Method}",

      journal = {The Astronomical Journal},

         year = 2025,

       volume = {169},

       number = {3},

          eid = {170},

        pages = {170},

          doi = {10.3847/1538-3881/adb1b2},

       adsurl = {https://ui.adsabs.harvard.edu/abs/2025AJ....169..170R},

}

```