RTModel 3.1

RTModel is a tool for microlensing event interpretation.

RTModel

RTModel is a package for modeling and interpretation of microlensing events. It uses photometric and/or astrometric time series collected from ground and/or space telescopes to propose one or more possible models among the following:

• Single-lens-single-source microlensing (i.e. Paczynski)
• Single-lens-binary-source microlensing (with or without xallarap)
• Binary-lens-single-source microlensing (including planetary microlensing, parallax and orbital motion)

All models include the finite-size of the source(s).

The modeling strategy is based on a grid search in the parameter space for single-lens models, whereas a template library for binary-lens models is used including all possible geometries of the source trajectory with respect to the caustics. In addition to this global search, planets are searched where maximal deviations from a Paczynski model occurs.

The library is in the form of a standard Python package that launches specific subprocesses for different tasks. Model fitting is executed in parallel exploiting available processors in the machine. The full modeling may take from one to three hours depending on the event and on the machine speed. The results of modeling are given in the form of a text assessment file; in addition, final models are made available with their parameters and covariance matrices.

RTModel also includes a subpackage RTModel.plotmodel that allows an immediate visualization of models and the possibility to review each individual fitting process as an animated gif.

A second subpackage RTModel.templates helps the user in the visualization and customization of the template library.

Attribution

RTModel has been created by Valerio Bozza (University of Salerno) as a product of many years of direct experience on microlensing modeling (see RTModel webpage).

Any scientific use of RTModel should be acknowledged by citing the paper V.Bozza, A&A 688 (2024) 83, describing all the algorithms behind the code.

We are grateful to Greg Olmschenk, who revised the package installation in order to make it as cross-platform as possible. We also thank all the users who are providing suggestions, reporting bugs or failures: Etienne Bachelet, David Bennett, Jonathan Brashear, Laura Salmeri, Stela Ishitani Silva, Yiannis Tsapras, Sigfried Vanaverbeke, Keto Zhang.

Installation

The easiest way to install RTModel is through pip.

First clone this repository.

Then go to the repository directory and type

pip install .

In alternative, you may directly install it from PyPI without cloning this repository:

pip install RTModel

Currently, RTModel works on Linux, Windows and MacOS, requiring Python >= 3.7. A C++ compiler compatible with C++17 standard is needed for installation. RTModel uses VBMicrolensing for all calculations. You are encouraged to cite the relevant papers listed in that repository as well.

Documentation

Full documentation for the use of RTModel is available.

In the directory events we provide some microlensing data on which you may practise with RTModel.

A Jupyter notebook for quick start-up is also available in the jupyter folder.

License

RTModel is freely available to the community under the GNU Lesser General Public License Version 3 included in this repository.