sphinx run

rpoleski · Feb 16, 2023 · de8fb1e · de8fb1e
1 parent 5746878
commit de8fb1e
Show file tree

Hide file tree

Showing 41 changed files with 50 additions and 39 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: 95b516f41cb1b37f3c4e7b2d88e3b863
+config: a0178952ae488d1e628925742e3e7ad4
 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.14.0 documentation</title>
+    <title>MulensModel.binarylens module &#8212; MulensModel 2.15.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.14.0 documentation</title>
+    <title>MulensModel.binarylensimports module &#8212; MulensModel 2.15.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.14.0 documentation</title>
+    <title>MulensModel.binarylenswithshear module &#8212; MulensModel 2.15.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.14.0 documentation</title>
+    <title>MulensModel.caustics module &#8212; MulensModel 2.15.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.14.0 documentation</title>
+    <title>MulensModel.causticspointwithshear module &#8212; MulensModel 2.15.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.14.0 documentation</title>
+    <title>MulensModel.causticswithshear module &#8212; MulensModel 2.15.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.14.0 documentation</title>
+    <title>MulensModel.coordinates module &#8212; MulensModel 2.15.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>
@@ -52,6 +52,7 @@
 <p>If the unit keyword is not specified, defaults to
 unit=(u.hourangle, u.deg) where u is defined by “import
 astropy.units as u”.</p>
+<p>You can print an instance of this class.</p>
 <dl class="py property">
 <dt class="sig sig-object py" id="MulensModel.coordinates.Coordinates.galactic_l">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">galactic_l</span></span><a class="headerlink" href="#MulensModel.coordinates.Coordinates.galactic_l" title="Permalink to this definition">¶</a></dt>

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.14.0 documentation</title>
+    <title>MulensModel.event module &#8212; MulensModel 2.15.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>
@@ -90,6 +90,8 @@
 If dataset is in magnitude space and model results
 in negative flux, then we calculate chi^2 in flux space but only for the
 epochs with negative model flux.</p>
+<p>You can print an instance of this class. Information on model and datasets
+will be provided.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="MulensModel.event.Event.plot">
 <span class="sig-name descname"><span class="pre">plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t_range</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">residuals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_errorbars</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">show_bad</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">legend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trajectory</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">title</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">subtract_2450000</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subtract_2460000</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_ref</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.plot" title="Permalink to this definition">¶</a></dt>

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.14.0 documentation</title>
+    <title>MulensModel.fitdata module &#8212; MulensModel 2.15.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.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.14.0 documentation</title>
+    <title>MulensModel.horizons module &#8212; MulensModel 2.15.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.14.0 documentation</title>
+    <title>MulensModel package &#8212; MulensModel 2.15.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.14.0 documentation</title>
+    <title>MulensModel.limbdarkeningcoeffs module &#8212; MulensModel 2.15.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>
@@ -45,6 +45,7 @@
 <p>gamma = (2 * u) / (3 - u)</p>
 <p>u = 3 * gamma / (2 + gamma)</p>
 <p>Note that the gamma convention has fixed total flux.</p>
+<p>You can print an instance of this class.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="MulensModel.limbdarkeningcoeffs.LimbDarkeningCoeffs.set_limb_coeff_gamma">
 <span class="sig-name descname"><span class="pre">set_limb_coeff_gamma</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bandpass</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gamma</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.limbdarkeningcoeffs.LimbDarkeningCoeffs.set_limb_coeff_gamma" title="Permalink to this definition">¶</a></dt>

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.14.0 documentation</title>
+    <title>MulensModel.magnificationcurve module &#8212; MulensModel 2.15.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.model.html b/docs/MulensModel.model.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.model module &#8212; MulensModel 2.14.0 documentation</title>
+    <title>MulensModel.model module &#8212; MulensModel 2.15.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>
@@ -83,6 +83,9 @@
 <span class="nb">print</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
 </pre></div>
 </div>
+<p>This will provide information on parameter values, coordinates,
+methods used for magnification calculations, and
+limb-darkening coefficients.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="MulensModel.model.Model.plot_magnification">
 <span class="sig-name descname"><span class="pre">plot_magnification</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">times</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">t_range</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">t_start</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">t_stop</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">dt</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">n_epochs</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">subtract_2450000</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subtract_2460000</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">satellite_skycoord</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">gamma</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">source_flux_ratio</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">flux_ratio_constraint</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="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.model.Model.plot_magnification" title="Permalink to this definition">¶</a></dt>

diff --git a/docs/MulensModel.modelparameters.html b/docs/MulensModel.modelparameters.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.modelparameters module &#8212; MulensModel 2.14.0 documentation</title>
+    <title>MulensModel.modelparameters module &#8212; MulensModel 2.15.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.mulensdata.html b/docs/MulensModel.mulensdata.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.mulensdata module &#8212; MulensModel 2.14.0 documentation</title>
+    <title>MulensModel.mulensdata module &#8212; MulensModel 2.15.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>
@@ -126,6 +126,10 @@
 </dl>
 </dd>
 </dl>
+<p>You can print an instance of this class, which always provides label and
+information on the total number of epochs and the number of bad epochs.
+If applicable, additional information is provided: bandpass,
+ephemerides file, color used for plotting, and errorbar scaling.</p>
 <dl class="py property">
 <dt class="sig sig-object py" id="MulensModel.mulensdata.MulensData.plot_properties">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">plot_properties</span></span><a class="headerlink" href="#MulensModel.mulensdata.MulensData.plot_properties" title="Permalink to this definition">¶</a></dt>

diff --git a/docs/MulensModel.mulensobjects.html b/docs/MulensModel.mulensobjects.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.mulensobjects package &#8212; MulensModel 2.14.0 documentation</title>
+    <title>MulensModel.mulensobjects package &#8212; MulensModel 2.15.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.mulensobjects.lens.html b/docs/MulensModel.mulensobjects.lens.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.mulensobjects.lens module &#8212; MulensModel 2.14.0 documentation</title>
+    <title>MulensModel.mulensobjects.lens module &#8212; MulensModel 2.15.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>