Skip to main content

A JAX-based package for microlensing binary lens

Project description

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

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

microlux-0.3.0.tar.gz (45.1 kB view details)

Uploaded Source

Built Distribution

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

microlux-0.3.0-py3-none-any.whl (36.3 kB view details)

Uploaded Python 3

File details

Details for the file microlux-0.3.0.tar.gz.

File metadata

  • Download URL: microlux-0.3.0.tar.gz
  • Upload date:
  • Size: 45.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for microlux-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1c98fa8c60ed894371d1e50b7220d99c43981660c1bacb8fb5f92b36a7a626e2
MD5 ab815107d0d163001cfb97ac09a9d3e0
BLAKE2b-256 63579b197ffca12f6df72d40fd4a508c8784f46c44519c808cfacdc528dd6c34

See more details on using hashes here.

File details

Details for the file microlux-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: microlux-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 36.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for microlux-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61e02bb95db7cb2c66fa590fb51c34d885e5e3f883c81f87227f83f0af2bb384
MD5 b86fa2ca8a93c7c37549e38818f3100c
BLAKE2b-256 fe4c9020157a3eddd7fd5bc0f72456e0f732b993bc83fba13adb0909d8e9ee8b

See more details on using hashes here.

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