v2.10 - adding Event.get_chi2_per_point() adding bad option and defau…

…lt values of np.nan
rpoleski · Jul 4, 2022 · a73c940 · a73c940
1 parent 574b8a1
commit a73c940
Show file tree

Hide file tree

Showing 43 changed files with 171 additions and 132 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 [**Detailed documentation: https://rpoleski.github.io/MulensModel/**](https://rpoleski.github.io/MulensModel/)
 
-[Latest release: 2.8.1](https://github.com/rpoleski/MulensModel/releases/latest) and we're working on further developing the code.
+[Latest release: 2.10.0](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 can then be input into an arbitrary likelihood function to find the best-fit parameters.
 
@@ -56,5 +56,5 @@ If you want to contribute to MulensModel, then please see [this file](CONTRIBUTI
 [![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)
 
-file revised May 2022
+file revised Jul 2022
 
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f17fd91997faabb41c807048f9587a9a
+config: 10611ab27303c73170fa158b00ccea64
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/MulensModel.binarylens.html b/docs/MulensModel.binarylens.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>MulensModel.binarylens module &#8212; MulensModel 2.8.2 documentation</title>
+    <title>MulensModel.binarylens module &#8212; MulensModel 2.10.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.binarylensimports.html b/docs/MulensModel.binarylensimports.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>MulensModel.binarylensimports module &#8212; MulensModel 2.8.2 documentation</title>
+    <title>MulensModel.binarylensimports module &#8212; MulensModel 2.10.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.binarylenswithshear.html b/docs/MulensModel.binarylenswithshear.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>MulensModel.binarylenswithshear module &#8212; MulensModel 2.8.2 documentation</title>
+    <title>MulensModel.binarylenswithshear module &#8212; MulensModel 2.10.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.caustics.html b/docs/MulensModel.caustics.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>MulensModel.caustics module &#8212; MulensModel 2.8.2 documentation</title>
+    <title>MulensModel.caustics module &#8212; MulensModel 2.10.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.causticswithshear.html b/docs/MulensModel.causticswithshear.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>MulensModel.causticswithshear module &#8212; MulensModel 2.8.2 documentation</title>
+    <title>MulensModel.causticswithshear module &#8212; MulensModel 2.10.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.coordinates.html b/docs/MulensModel.coordinates.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>MulensModel.coordinates module &#8212; MulensModel 2.8.2 documentation</title>
+    <title>MulensModel.coordinates module &#8212; MulensModel 2.10.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.event.html b/docs/MulensModel.event.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>MulensModel.event module &#8212; MulensModel 2.8.2 documentation</title>
+    <title>MulensModel.event module &#8212; MulensModel 2.10.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -108,7 +108,7 @@
 <em>None</em> (see <a class="reference internal" href="#MulensModel.event.Event.plot_data" title="MulensModel.event.Event.plot_data"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_data()</span></code></a>).</p>
 </dd>
 <dt>show_bad: <em>bool</em></dt><dd><p>Whether or not to show data points marked as “bad” (see
-<code class="xref py py-attr docutils literal notranslate"><span class="pre">bad</span></code>). Default is
+<a class="reference internal" href="MulensModel.mulensdata.html#MulensModel.mulensdata.MulensData.bad" title="MulensModel.mulensdata.MulensData.bad"><code class="xref py py-attr docutils literal notranslate"><span class="pre">bad</span></code></a>). Default is
 <em>None</em> (see <a class="reference internal" href="#MulensModel.event.Event.plot_data" title="MulensModel.event.Event.plot_data"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_data()</span></code></a>).</p>
 </dd>
 <dt>legend: <em>bool</em></dt><dd><p>Whether or not to show a legend for the datasets.</p>
@@ -277,11 +277,17 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="MulensModel.event.Event.get_chi2_per_point">
-<span class="sig-name descname"><span class="pre">get_chi2_per_point</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fit_blending</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.event.Event.get_chi2_per_point" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">get_chi2_per_point</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fit_blending</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bad</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.event.Event.get_chi2_per_point" title="Permalink to this definition">¶</a></dt>
 <dd><p>Calculates chi^2 for each data point of the current model by
 fitting for source and blending fluxes.</p>
 <dl>
 <dt>Parameters :</dt><dd><p>fit_blending: DEPRECATED. use <code class="xref py py-attr docutils literal notranslate"><span class="pre">fix_blending</span></code> instead.</p>
+<dl class="simple">
+<dt>bad: <em>bool</em></dt><dd><p>Should chi2 be also caclulated for points marked as bad in
+MulensData? If <cite>False</cite> (default), then bad epochs have chi2 of
+<cite>np.nan</cite>.</p>
+</dd>
+</dl>
 </dd>
 <dt>Returns :</dt><dd><dl class="simple">
 <dt>chi2: <em>list</em> of <em>np.ndarray</em></dt><dd><p>Chi^2 contribution from each data point,