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.1.0.tar.gz (36.4 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.1.0-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for microlux-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ad683fc5959d40e1bf9c3d0fc9b4f5f4486bc347093a2b4450d2bcdbdf600988
MD5 18246c0f10692295f66c4704afbbc0a2
BLAKE2b-256 4f812d193febc41f524a74e8e70b21dc24d732af349856133422a2052989fe7f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for microlux-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4b3ee28ebe8f4d225869dbda0f2f00a3222614618157ed5021df4dc75e1f938
MD5 3a8cf7c9cecbc21899248f10830a3ac8
BLAKE2b-256 2c99a73472e743e25591f9f5697cf8d3106932c7e944f7c5d90d469c756c0bce

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