sphinx run for v2.18.0

rpoleski · Sep 15, 2023 · 537e33c · 537e33c
1 parent 2969709
commit 537e33c
Show file tree

Hide file tree

Showing 41 changed files with 218 additions and 47 deletions.
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: f46a4265c903584400663bee36e1330d
+config: da46b56c84a2d26d9988fc4d22bc954f
 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.17.0 documentation</title>
+    <title>MulensModel.binarylens module &#8212; MulensModel 2.18.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.17.0 documentation</title>
+    <title>MulensModel.binarylensimports module &#8212; MulensModel 2.18.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.17.0 documentation</title>
+    <title>MulensModel.binarylenswithshear module &#8212; MulensModel 2.18.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.17.0 documentation</title>
+    <title>MulensModel.caustics module &#8212; MulensModel 2.18.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.causticspointwithshear.html b/docs/MulensModel.causticspointwithshear.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.causticspointwithshear module &#8212; MulensModel 2.17.0 documentation</title>
+    <title>MulensModel.causticspointwithshear module &#8212; MulensModel 2.18.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.17.0 documentation</title>
+    <title>MulensModel.causticswithshear module &#8212; MulensModel 2.18.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.17.0 documentation</title>
+    <title>MulensModel.coordinates module &#8212; MulensModel 2.18.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.17.0 documentation</title>
+    <title>MulensModel.event module &#8212; MulensModel 2.18.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.fitdata.html b/docs/MulensModel.fitdata.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.fitdata module &#8212; MulensModel 2.17.0 documentation</title>
+    <title>MulensModel.fitdata module &#8212; MulensModel 2.18.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>
@@ -304,11 +304,26 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="MulensModel.fitdata.FitData.get_d_A_d_u_for_PSPL_model">
+<span class="sig-name descname"><span class="pre">get_d_A_d_u_for_PSPL_model</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.fitdata.FitData.get_d_A_d_u_for_PSPL_model" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate dA/du for PSPL point-source–point-lens model.</p>
+<p>No parameters.</p>
+<dl class="simple">
+<dt>Returns :</dt><dd><dl class="simple">
+<dt>dA_du: <em>np.ndarray</em></dt><dd><p>Derivative dA/du.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="MulensModel.fitdata.FitData.get_d_A_d_u_for_point_lens_model">
 <span class="sig-name descname"><span class="pre">get_d_A_d_u_for_point_lens_model</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.fitdata.FitData.get_d_A_d_u_for_point_lens_model" title="Permalink to this definition">¶</a></dt>
-<dd><p>Calculate dA/du for PSPL</p>
-<p>No parameters.</p>
+<dd><p>Calculate dA/du for point-source–point-lens model. For finite source
+models see <code class="xref py py-class docutils literal notranslate"><span class="pre">FSPLDerivs</span></code> or
+py:func:<cite>get_d_A_d_params_for_point_lens_model()</cite></p>
 <dl class="simple">
 <dt>Returns :</dt><dd><dl class="simple">
 <dt>dA_du: <em>np.ndarray</em></dt><dd><p>Derivative dA/du.</p>
@@ -318,6 +333,19 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="MulensModel.fitdata.FitData.get_d_A_d_rho">
+<span class="sig-name descname"><span class="pre">get_d_A_d_rho</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.fitdata.FitData.get_d_A_d_rho" title="Permalink to this definition">¶</a></dt>
+<dd><p>Calculate the derivative of the magnification with respect to rho.</p>
+<dl class="simple">
+<dt>Returns:</dt><dd><dl class="simple">
+<dt>d_A_d_rho: <em>np.ndarray</em></dt><dd><p>derivative</p>
+</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="MulensModel.fitdata.FitData.chi2_gradient">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">chi2_gradient</span></span><a class="headerlink" href="#MulensModel.fitdata.FitData.chi2_gradient" title="Permalink to this definition">¶</a></dt>
@@ -406,6 +434,23 @@
 <p>The model to fit to the data.</p>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.fitdata.FitData.data_magnification">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data_magnification</span></span><a class="headerlink" href="#MulensModel.fitdata.FitData.data_magnification" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns previously calculated magnifications. To calculate the
+magnifications (e.g., if something changed in the model), use
+<a class="reference internal" href="#MulensModel.fitdata.FitData.get_data_magnification" title="MulensModel.fitdata.FitData.get_data_magnification"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_data_magnification()</span></code></a>.</p>
+<dl class="simple">
+<dt>Returns :</dt><dd><dl class="simple">
+<dt>data_magnification: <em>np.ndarray</em></dt><dd><p>The model magnification evaluated for each datapoint. If there
+is more than one source, the magnification of each source is
+reported separately.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="MulensModel.fitdata.FitData.gamma">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">gamma</span></span><a class="headerlink" href="#MulensModel.fitdata.FitData.gamma" title="Permalink to this definition">¶</a></dt>
@@ -415,6 +460,30 @@
 <a class="reference internal" href="MulensModel.model.html#MulensModel.model.Model.get_limb_coeff_gamma" title="MulensModel.model.Model.get_limb_coeff_gamma"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_limb_coeff_gamma()</span></code></a>.</p>
 </dd></dl>
 
+<dl class="py class">
+<dt class="sig sig-object py" id="MulensModel.fitdata.FitData.FSPL_Derivatives">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">FSPL_Derivatives</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fit</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.fitdata.FitData.FSPL_Derivatives" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<p>Calculates derivatives of an FSPL model for each datapoint.</p>
+<dl class="simple">
+<dt>Arguments :</dt><dd><p>fit: py:class:<cite>FitData</cite> object</p>
+</dd>
+</dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="MulensModel.fitdata.FitData.FSPL_Derivatives.get_gradient">
+<span class="sig-name descname"><span class="pre">get_gradient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.fitdata.FitData.FSPL_Derivatives.get_gradient" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the gradient of the magnification with respect to the
+FSPL parameters.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="MulensModel.fitdata.FitData.FSPL_Derivatives.get_d_A_d_rho">
+<span class="sig-name descname"><span class="pre">get_d_A_d_rho</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.fitdata.FitData.FSPL_Derivatives.get_d_A_d_rho" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return the derivative of the magnification with respect to rho.</p>
+</dd></dl>
+
+</dd></dl>
+
 </dd></dl>
 
 </section>

diff --git a/docs/MulensModel.horizons.html b/docs/MulensModel.horizons.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.horizons module &#8212; MulensModel 2.17.0 documentation</title>
+    <title>MulensModel.horizons module &#8212; MulensModel 2.18.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.html b/docs/MulensModel.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 package &#8212; MulensModel 2.17.0 documentation</title>
+    <title>MulensModel package &#8212; MulensModel 2.18.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.limbdarkeningcoeffs.html b/docs/MulensModel.limbdarkeningcoeffs.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.limbdarkeningcoeffs module &#8212; MulensModel 2.17.0 documentation</title>
+    <title>MulensModel.limbdarkeningcoeffs module &#8212; MulensModel 2.18.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.magnificationcurve.html b/docs/MulensModel.magnificationcurve.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.magnificationcurve module &#8212; MulensModel 2.17.0 documentation</title>
+    <title>MulensModel.magnificationcurve module &#8212; MulensModel 2.18.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>
@@ -234,6 +234,14 @@
 </dl>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.magnificationcurve.MagnificationCurve.methods_for_epochs">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">methods_for_epochs</span></span><a class="headerlink" href="#MulensModel.magnificationcurve.MagnificationCurve.methods_for_epochs" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>list</em></p>
+<p>for each epochs, decide which methods should be used to
+calculate magnification, but don’t run the calculations</p>
+</dd></dl>
+
 </dd></dl>
 
 </section>