Microlensing Modelling package
Clone or download

README.md

MulensModel

MulensModel is package for modeling microlensing (or μ-lensing) events.

Latest release: 1.5.3 and we're working on further developing the code.

MulensModel can generate a microlensing light curve for a given set of microlensing parameters, fit that light curve to some data, and return a chi2 value. That chi2 can then be input into an arbitrary likelihood function to find the best fit parameters.

Are you interested in Microlensing Data Analysis Challenge? For more details on using MulensModel in data challenge, see this document.

A few useful resources:

Documentation includes description of input and output of every function.

If you want to learn more about microlensing, please visit Microlensing Source website.

Currently, MulensModel supports:

  • Lens Systems: point lens or binary lens.
  • Source Stars: single source or binary source.
  • Effects: finite source (1-parameter), parallax (satellite & annual), binary lens orbital motion, different parametrizations of microlensing models.

Need more? Open an issue or send us an e-mail.

Are you using MulensModel for scientific research? Please give us credit by citing the paper and ASCL reference.

How to install?

Download the source code and run:

python setup.py install

MulensModel requires some standard packages plus astropy package. To make sure that you have everything that's needed, just run:

pip install -r requirements.txt

If you have any problems, please contact the authors and we will try to help.


astropy

file revised Sep 2018