muLAn: MICROlensing Analysis software
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
muLAn add option of no source plotted, and option to plot source at t0 Oct 5, 2018
.gitignore
.travis.yml
LICENSE
NOTICE.txt
README.md
setup.cfg
setup.py

README.md

muLAn: gravitational MICROlensing Analysis Software

Goals

muLAn is an easy-to-use and flexile software to model gravitational microlensing events

Getting Started

Dependencies

This package depends in particular on the following packages:

  • Cython (version 27.1 works, troubles with version 28)
  • pyAstronomy (version >= 0.10.1, link)
  • GetDist (version >= 0.2.6)

Installation

Install one of the available relesases (recommended), or install the current development version of muLAn package from source:

git clone https://github.com/muLAn-project/muLAn.git

To install muLAn in your user python environment:

pip install --user muLAn/

We however recommend to use an Anaconda user environment:

conda create -n muLAn-0.8 python=2.7
source activate muLAn-0.8
pip install muLAn/

Loading

The python script has to be executed in the directory of the microlensing event to be analyzed:

from muLAn import mulan

muLAn basic commands

  • Launch muLAn (based on setup.ini options, see documentation):
mulan.run()
  • Clean stop (waiting for all current sub-processes to finish):
mulan.stop()
  • Collect all Markov chains and re-order them with best fit first (necessary after unexpected stop, e.g. wall time exceeded):
mulan.sortmodels()

Examples

See the documentation section.

License

This software is licensed under the MIT license. See the LICENSE file for details.