mulensmodel

Microlensing Modelling package

https://github.com/rpoleski/mulensmodel

Science Score: 64.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
✓
Academic publication links
Links to: arxiv.org
✓
Committers with academic emails
3 of 15 committers (20.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.4%) to scientific vocabulary

Keywords from Contributors

mesh interpretability sequences generic projection interactive optim hacking network-simulation

Last synced: 6 months ago · JSON representation ·

Repository

Microlensing Modelling package

Basic Info

Host: GitHub
Owner: rpoleski
License: other
Language: Python
Default Branch: master
Homepage: https://rpoleski.github.io/MulensModel/
Size: 47.5 MB

Statistics

Stars: 62
Watchers: 8
Forks: 17
Open Issues: 36
Releases: 53

Created over 9 years ago · Last pushed 6 months ago

Metadata Files

Readme Contributing License Citation Authors

MulensModel

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

Detailed documentation: https://rpoleski.github.io/MulensModel/

Latest release: 3.4.0 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 (and its gradient in some cases) can then be input into an arbitrary likelihood function to find the best-fit parameters.

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

Currently, MulensModel supports: * Lens Systems: point lens or binary lens. Shear and convergence allowed for both point and binary lenses. * Source Stars: single source, binary source, or even larger number of sources. * Effects: finite source (1-parameter), parallax (satellite & annual), binary lens orbital motion (2-parameter or keplerian circular - new), xallarap effect (with one or two luminous sources), different parametrizations of microlensing models.

Need more? Open an issue, start a discussion, or send us an e-mail.

Acknowledgements

Are you using MulensModel for scientific research? Please give us credit by citing the paper published in "Astronomy and Computing" and ASCL reference. For arXiv version please see link. You should also cite relevant papers for algorithms used. In a typical run that uses binary lenses these will be Bozza (2010) and Skowron & Gould (2012). HERE is a list of papers to cite for various algorithms used in MulensModel. We also thank other people who helped in MulensModel development - please see list in AUTHORS.md file.

Examples and tutorials

We have more than a dozen of examples - starting from very simple ones (like plotting a model) to very advanced (like fitting a binary lens model with finite source effect). Please see: * a list of examples and tutorials, * description of all microlensing parameters used in MulensModel, * methods used to calculate magnification in MulensModel, and * high-level fitting example.

The full documentation of API is at https://rpoleski.github.io/MulensModel/.

How to install?

The easiest way is to run: pip install MulensModel which will download all files and also install all dependencies (using the PyPI website).

If the above method doesn't work or you would like to see other possibilities, then please see the install file.

Contributing

If you want to contribute to MulensModel, then please see this file.

PyPI - Downloads

file revised Jul 2025

Owner

Name: Radek Poleski
Login: rpoleski
Kind: user
Company: University of Warsaw

Website: https://www.facebook.com/RadekPoleski/
Repositories: 1
Profile: https://github.com/rpoleski

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: MulensModel
message: >-
  If you use this software please cite the paper indicated
  below and papers that describe specific algorithms used.
type: software
authors:
  - given-names: Radek
    family-names: Poleski
    orcid: 'https://orcid.org/0000-0002-9245-6368'
    affiliation: >-
      Astronomical Observatory, University of Warsaw
      (Poland)
  - given-names: Jennifer
    family-names: Yee
    affiliation: Center for Astrophysics ∣ Harvard & Smithsonian
    orcid: 'https://orcid.org/0000-0001-9481-7123'
identifiers:
  - type: url
    value: 'https://github.com/rpoleski/MulensModel'
    description: main code repository
  - type: url
    value: 'https://pypi.org/project/MulensModel/'
    description: PyPI link
  - type: url
    value: >-
      https://ui.adsabs.harvard.edu/abs/2019A%26C....26...35P/abstract
    description: ADS/NASA record of the paper with software description
  - type: doi
    value: 10.1016/j.ascom.2018.11.001
    description: Peer-reviewed description of the software
repository-code: 'https://github.com/rpoleski/MulensModel'
url: 'https://rpoleski.github.io/MulensModel/'
abstract: 'MulensModel is package for modeling microlensing events. '
keywords:
  - microlensing
  - gravity
  - gravitational microlensing
  - planet
license: MIT

GitHub Events

Total

Create event: 11
Commit comment event: 9
Release event: 5
Issues event: 20
Watch event: 7
Delete event: 11
Issue comment event: 103
Push event: 93
Pull request event: 35
Fork event: 2

Last Year

Create event: 11
Commit comment event: 9
Release event: 5
Issues event: 20
Watch event: 7
Delete event: 11
Issue comment event: 103
Push event: 93
Pull request event: 35
Fork event: 2

Committers

Last synced: 10 months ago

All Time

Total Commits: 3,686
Total Committers: 15
Avg Commits per committer: 245.733
Development Distribution Score (DDS): 0.367

Past Year

Commits: 385
Committers: 9
Avg Commits per committer: 42.778
Development Distribution Score (DDS): 0.561

Top Committers

Name	Email	Commits
Radek Poleski	r**i@g**m	2,333
jenniferyee	j**e@g**m	840
Jennifer Yee	j**e@S**e	134
Raphael A. P. Oliveira	r**o@g**m	125
alpv95	5**a@g**m	73
Jennifer Yee	j**e@S**l	66
Keto D. Zhang	k**z@i**u	44
mjmroz	m**z@g**m	24
Justyna	j**4@g**m	14
Mateusz Mroz	m**z@b**l	12
SophieBudzik	s**k@g**m	8
Mateusz Mroz	m**z@g**l	7
meethari	s**i@g**m	4
dependabot[bot]	4****]	1
Raphael A. P. Oliveira	r**a@u**r	1

Committer Domains (Top 20 + Academic)

usp.br: 1 grus.astrouw.edu.pl: 1 bl401.astrouw.edu.pl: 1 ipac.caltech.edu: 1 si381826.home: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 101
Total pull requests: 87
Average time to close issues: 6 months
Average time to close pull requests: 20 days
Total issue authors: 23
Total pull request authors: 12
Average comments per issue: 4.03
Average comments per pull request: 2.91
Merged pull requests: 69
Bot issues: 0
Bot pull requests: 1

Past Year

Issues: 15
Pull requests: 48
Average time to close issues: 3 months
Average time to close pull requests: 8 days
Issue authors: 6
Pull request authors: 8
Average comments per issue: 3.4
Average comments per pull request: 1.79
Merged pull requests: 35
Bot issues: 0
Bot pull requests: 1

View more stats

Top Authors

Issue Authors

rpoleski (51)
jenniferyee (22)
ketozhang (5)
samsonajohnson (2)
rapoliveira (2)
NumaKarolinski (2)
JasonZHM (1)
KKruszynska (1)
pmehta08 (1)
ernewton (1)
josepsn (1)
lisadang27 (1)
twins111197 (1)
eddiemorris135 (1)
wyrzykow (1)

Pull Request Authors

rapoliveira (31)
mjmroz (24)
ketozhang (16)
SophieBudzik (14)
justi (6)
jenniferyee (3)
rpoleski (3)
alpv95 (2)
dependabot[bot] (2)
AmberLee2427 (1)
pmehta08 (1)
meethari (1)

Top Labels

Issue Labels

enhancement (20) quick_fix (17) help wanted (16) bug (14) question (6) version3 (4) wontfix (2)

Pull Request Labels

dependencies (2) bug (1)

Packages

Total packages: 1
Total downloads:
- pypi 930 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 35
Total maintainers: 1

pypi.org: mulensmodel

package for modeling gravitational microlensing events

Homepage: https://github.com/rpoleski/MulensModel
Documentation: https://mulensmodel.readthedocs.io/
License: other
Latest release: 3.4.0
published 7 months ago

Versions: 35
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 930 Last month

Rankings

Forks count: 9.6%

Stargazers count: 9.6%

Dependent packages count: 10.1%

Average: 13.2%

Downloads: 15.2%

Dependent repos count: 21.6%

Maintainers (1)

rpoleski

Last synced: 6 months ago

Dependencies

examples/example_16/requirements.txt pypi

MulensModel >=2.0.0
corner *
emcee *
matplotlib *
numpy *
pymultinest *
scipy >=0.18.0
yaml *

requirements.txt pypi

astropy >=1.2.0
matplotlib *
numpy *
py-cpuinfo *
scipy >=0.18.0
sympy *

.github/workflows/publish.yml actions

actions/checkout v3 composite
actions/download-artifact v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
pypa/cibuildwheel v2.11.2 composite
pypa/gh-action-pypi-publish release/v1 composite

.github/workflows/python-app.yml actions

actions/checkout v3 composite
actions/setup-python v3 composite
codecov/codecov-action v3 composite

pyproject.toml pypi

setup.py pypi

mulensmodel

Science Score: 64.0%

Keywords from Contributors

Repository

Basic Info

Statistics

Metadata Files

README.md

MulensModel

Acknowledgements

Examples and tutorials

How to install?

Contributing

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: mulensmodel

Rankings

Maintainers (1)

Dependencies