microlux: Microlensing using Jax

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

pip install microlux

or you can install this package from source for development.

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 .

@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},
}