Skip to main content

microlux: Microlensing using Jax

Test Status Documentation Status License: MIT Ask DeepWiki

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

Metadata

Release files for microlux 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 microlux 0.3.0
File Size Uploaded
microlux-0.3.0.tar.gz 45.1 kB Details

Built distribution (wheel)

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

Total release size: 81.4 kB

Release files / microlux-0.3.0.tar.gz

Download URL microlux-0.3.0.tar.gz
Size 45.1 kB
Tags Source
SHA-256 checksum
How to use checksums
1c98fa8c60ed894371d1e50b7220d99c43981660c1bacb8fb5f92b36a7a626e2
BLAKE2b-256 checksum
How to use checksums
63579b197ffca12f6df72d40fd4a508c8784f46c44519c808cfacdc528dd6c34
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

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

Download URL microlux-0.3.0-py3-none-any.whl
Size 36.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
61e02bb95db7cb2c66fa590fb51c34d885e5e3f883c81f87227f83f0af2bb384
BLAKE2b-256 checksum
How to use checksums
fe4c9020157a3eddd7fd5bc0f72456e0f732b993bc83fba13adb0909d8e9ee8b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.0

2 release files

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