mulensmodel 3.6.1__tar.gz

mulensmodel-3.6.1/AUTHORS.md

@@ -0,0 +1,37 @@
+MulensModel is developed as an open-source code with contributions from many individuals. These contributions are of various kinds and we would like to thank and give credit to all those people.
+
+Main contributors:
+* [Radek Poleski](https://github.com/rpoleski)
+* [Yee Jennifer](https://github.com/jenniferyee)
+
+People who have written parts of the code:
+* [Lawrence Peirson](https://github.com/alpv95) - point and binary lens models with shear and convergence
+* [Keto D. Zhang](https://github.com/ketozhang) - PyPI installation, Extensions etc.
+* [Mateusz Mroz](https://github.com/mjmroz) - many additions to example 16 including interactive plots
+* [Raphael A. P. Oliveira](https://github.com/rapoliveira) - small updates in various places
+* [Hariharan Srinivasulu](https://github.com/meethari) - for helping with development of FitData class
+* [Justyna Wojtczak](https://github.com/justi) - github actions
+* [Amber Malpas](https://github.com/AmberLee2427) - publshing on PyPI
+* [Zosia Budzik](https://github.com/SophieBudzik) - Keplerian unit tests
+
+The code would not be in the state it is without modules that are imported by MulensModel. Special thanks to:
+* [Valerio Bozza](https://github.com/valboz) - for VBBL
+* [Jan Skowron](https://github.com/jskowron) - for Skowron & Gould root solver
+* Andrew Gould - for Skowron & Gould root solver
+* Martin Dominik - for AdaptiveContouring
+* [Dan Foreman-Mackey](https://github.com/dfm) - for [EMCEE](https://github.com/dfm/emcee) and [corner](https://github.com/dfm/corner.py)
+* [AstroPy Team](https://github.com/astropy) - for [AstroPy](https://github.com/astropy/astropy)
+* [Johannes Buchner](https://github.com/JohannesBuchner) - for [PyMultiNest](https://github.com/JohannesBuchner/PyMultiNest)
+
+We also thank those who have not directly contributed to the code, but their suggestions and comments helped in code development. We thus thank (random order):
+* [Kasia Kruszynska](https://github.com/KKruszynska)
+* David Specht
+* [Demitri Muna](https://github.com/demitri) - for giving excellent suggestions just before the code was born
+* Zoey Samples
+* [Jan Skowron](https://github.com/jskowron) - for spotting bugs and letting us know about them
+* [Jason Eastman](https://github.com/jdeast)
+* Samson Johnson - for requesting improvements in FSPL calculations
+* Adrian Hernandez
+* [Przemek Mroz](https://github.com/przemekmroz)
+* [Geoff Bryden](https://github.com/gryden) - for early discussions about the code
+

mulensmodel-3.6.1/LICENSE

@@ -0,0 +1,201 @@
+This file gives license information for MulensModel package (MIT license) and 
+two packages that are distributed together with MulensModel: VBBL (LGPL v3.0 
+license) and AdaptiveContouring.
+
+
+##############################################################################
+
+MulensModel:
+
+MIT License
+
+Copyright (c) 2016-2023 Radoslaw (Radek) Poleski and Jennifer Yee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+##############################################################################
+
+VBBinaryLensing 3.5.0
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

mulensmodel-3.6.1/MANIFEST.in

@@ -0,0 +1,5 @@
+graft source/VBBL
+graft source/AdaptiveContouring
+graft source/MulensModel
+graft data
+include requirements.txt

mulensmodel-3.6.1/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: mulensmodel
+Version: 3.6.1
+Summary: package for modeling gravitational microlensing events
+Home-page: https://github.com/rpoleski/MulensModel
+Author: Radek Poleski & Jennifer Yee
+Author-email: radek.poleski@gmail.com
+License: MIT
+Project-URL: documentation, https://github.com/rpoleski/MulensModel
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+License-File: LICENSE
+License-File: AUTHORS.md
+Requires-Dist: numpy
+Requires-Dist: scipy>=0.18.0
+Requires-Dist: astropy>=1.2.0
+Requires-Dist: matplotlib
+Requires-Dist: sympy
+Requires-Dist: py-cpuinfo
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+package for modeling gravitational microlensing events

mulensmodel-3.6.1/README.md

@@ -0,0 +1,64 @@
+# MulensModel
+
+<dl>MulensModel is package for modeling microlensing (or &mu;-lensing) events. </dl>
+
+<!-- ![example workflow](https://github.com/alpv95/MulensModel/actions/workflows/tests.yml/badge.svg) -->
+
+[**Detailed documentation: https://rpoleski.github.io/MulensModel/**](https://rpoleski.github.io/MulensModel/)
+
+[Latest release: 3.5.7](https://github.com/rpoleski/MulensModel/releases/latest) 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](http://microlensing-source.org/) and [Microlensing Mini Course](https://rges-pit.org/outreach_mini_landing/).
+
+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](https://github.com/rpoleski/MulensModel/issues), start [a discussion](https://github.com/rpoleski/MulensModel/discussions), or send us an e-mail. 
+
+![MulensModel logo](documents/logo/logoMM_crop_4_372x260.png)
+
+## Acknowledgements
+
+Are you using MulensModel for scientific research? Please give us credit by citing the [paper published in "Astronomy and Computing"](https://ui.adsabs.harvard.edu/abs/2019A%26C....26...35P/abstract) and [ASCL reference](http://ascl.net/1803.006). For arXiv version please see [link](https://arxiv.org/abs/1803.01003). You should also cite relevant papers for algorithms used. In a typical run that uses binary lenses these will be [Bozza (2010)](https://ui.adsabs.harvard.edu/abs/2010MNRAS.408.2188B/abstract) and [Skowron & Gould (2012)](https://ui.adsabs.harvard.edu/abs/2012arXiv1203.1034S/abstract). [HERE](documents/papers_to_cite.md) 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](AUTHORS.md).
+
+
+## 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**](documents/examples_list.md),
+* [**description of all microlensing parameters used in MulensModel**](documents/parameter_names.pdf),
+* [**methods used to calculate magnification in MulensModel**](documents/magnification_methods.pdf), and
+* [**high-level fitting example**](examples/example_16).
+
+The full documentation of API is at [https://rpoleski.github.io/MulensModel/](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](https://pypi.org/project/MulensModel/)).
+
+If the above method doesn't work or you would like to see other possibilities, then please see [the install file](documents/install.md).
+
+## Contributing
+
+If you want to contribute to MulensModel, then please see [this file](CONTRIBUTING.md).
+
+---
+[![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/) 
+[![PyPI version shields.io](https://img.shields.io/pypi/v/MulensModel.svg)](https://pypi.python.org/pypi/MulensModel/) 
+[![GitHub stars](https://badgen.net/github/stars/rpoleski/MulensModel)](https://GitHub.com/rpoleski/MulensModel/stargazers/) 
+[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/) 
+[![Poleski & Yee 2019](https://img.shields.io/badge/ADS-Poleski%20%26%20Yee%202019-brightgreen.svg)](https://ui.adsabs.harvard.edu/abs/2019A%26C....26...35P/abstract)
+[![astro-ph/1803.01003](https://img.shields.io/badge/astro--ph-1803.01003-brightgreen.svg)](https://arxiv.org/abs/1803.01003)
+[![EMAC](https://img.shields.io/badge/EMAC-2207--125-blue)](https://emac.gsfc.nasa.gov?cid=2207-125)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/MulensModel)
+![example workflow](https://github.com/rpoleski/MulensModel/actions/workflows/python-app.yml/badge.svg)
+
+file revised Oct 2025