Skip to main content

A JAX-based package for microlensing binary lens

Project description

microlux: Microlensing using Jax

Test Status Documentation Status License: MIT

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.2.0.tar.gz (38.5 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.2.0-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for microlux-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e805b717a67ed6ae61d932274c5aa00db10884173eefd26f2ddc2b90dd179d68
MD5 d4bbdf86b4a724442de07c58aa77f9fa
BLAKE2b-256 ba64564daeb02e1547afe45686fb42f8ffc696f168bf90543d75615864568fa0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for microlux-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2615439d6af8bd54d86953ed8f24bc93722cbe267ab2fbca994f19de4ece6ef9
MD5 897715a879cf532cc0ed22b1c395549a
BLAKE2b-256 171ff3aaff5b83bef72d3e895c7c22a98231b3cee22f7e32c7bb4ab2d740556d

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