sphinx run

rpoleski · Jan 11, 2022 · d66663a · d66663a
1 parent 4bff2ed
commit d66663a
Show file tree

Hide file tree

Showing 36 changed files with 76 additions and 36 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: 998ba4f852f47484aa7fc51c582ff388
+config: 1e01d6fa7a42361abf7e78bfaaad2dbe
 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
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.binarylens module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.binarylens module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.caustics.html b/docs/MulensModel.caustics.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.caustics module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.caustics module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.coordinates.html b/docs/MulensModel.coordinates.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.coordinates module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.coordinates module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.event.html b/docs/MulensModel.event.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.event module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.event module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -90,6 +90,44 @@
 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>
+<dl class="py method">
+<dt id="MulensModel.event.Event.plot">
+<code class="sig-name descname">plot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">t_range</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">residuals</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">show_errorbars</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">show_bad</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">legend</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">trajectory</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">title</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">subtract_2450000</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">subtract_2460000</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">data_ref</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.event.Event.plot" title="Permalink to this definition">¶</a></dt>
+<dd><p>Basic plotting. Default is to plot the light curve with the residuals.
+If the model has 2 or more lenses, also plot the source trajectory with
+caustics. For more detailed control over the plotting, see
+<a class="reference internal" href="#MulensModel.event.Event.plot_model" title="MulensModel.event.Event.plot_model"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_model()</span></code></a>, <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>, and
+<a class="reference internal" href="#MulensModel.event.Event.plot_trajectory" title="MulensModel.event.Event.plot_trajectory"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_trajectory()</span></code></a>.</p>
+<dl class="simple">
+<dt>Keywords:</dt><dd><dl class="simple">
+<dt>t_range: <em>list</em>, <em>tuple</em></dt><dd><p>Time range over which to show the light curve plot.</p>
+</dd>
+<dt>residuals: <em>bool</em></dt><dd><p>Whether or not to plot the residuals with the light curve.</p>
+</dd>
+<dt>show_errorbars: <em>bool</em></dt><dd><p>Whether or not to show the errorbars on the data. 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>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
+<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>
+</dd>
+<dt>trajectory: <em>bool</em></dt><dd><p>Whether or not to plot the source trajectory. Defaults to
+<em>False</em> for single lens events and <em>True</em> for binary lenses.</p>
+</dd>
+<dt>title: <em>str</em></dt><dd><p>Title for the plot. Same title is used for trajectory plot, if
+applicable.</p>
+</dd>
+<dt>subtract_2450000, subtract_2460000: <em>bool</em></dt><dd><p>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>data_ref:  <em>int</em> or <em>MulensData</em></dt><dd><p>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>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt id="MulensModel.event.Event.plot_model">
 <code class="sig-name descname">plot_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data_ref</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.event.Event.plot_model" title="Permalink to this definition">¶</a></dt>
@@ -399,7 +437,7 @@
 
 <dl class="py method">
 <dt id="MulensModel.event.Event.blend_fluxes">
-<code class="sig-name descname">blend_fluxes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.event.Event.blend_fluxes" title="Permalink to this definition">¶</a></dt>
+<em class="property">property </em><code class="sig-name descname">blend_fluxes</code><a class="headerlink" href="#MulensModel.event.Event.blend_fluxes" title="Permalink to this definition">¶</a></dt>
 <dd><p><em>list</em></p>
 <p>An array giving the fitted blend flux for each dataset.</p>
 </dd></dl>

diff --git a/docs/MulensModel.fitdata.html b/docs/MulensModel.fitdata.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.fitdata module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.fitdata module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.horizons.html b/docs/MulensModel.horizons.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.horizons module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.horizons module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.html b/docs/MulensModel.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel package &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel package &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.limbdarkeningcoeffs.html b/docs/MulensModel.limbdarkeningcoeffs.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.limbdarkeningcoeffs module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.limbdarkeningcoeffs module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.magnificationcurve.html b/docs/MulensModel.magnificationcurve.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.magnificationcurve module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.magnificationcurve module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.model.html b/docs/MulensModel.model.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.model module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.model module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.modelparameters.html b/docs/MulensModel.modelparameters.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.modelparameters module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.modelparameters module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.mulensdata.html b/docs/MulensModel.mulensdata.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.mulensdata module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.mulensdata module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.mulensobjects.html b/docs/MulensModel.mulensobjects.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.mulensobjects package &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.mulensobjects package &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.mulensobjects.lens.html b/docs/MulensModel.mulensobjects.lens.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.mulensobjects.lens module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.mulensobjects.lens module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.mulensobjects.mulenssystem.html b/docs/MulensModel.mulensobjects.mulenssystem.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.mulensobjects.mulenssystem module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.mulensobjects.mulenssystem module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.mulensobjects.source.html b/docs/MulensModel.mulensobjects.source.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.mulensobjects.source module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.mulensobjects.source module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.pointlens.html b/docs/MulensModel.pointlens.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.pointlens module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.pointlens module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.satelliteskycoord.html b/docs/MulensModel.satelliteskycoord.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.satelliteskycoord module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.satelliteskycoord module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.trajectory.html b/docs/MulensModel.trajectory.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.trajectory module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.trajectory module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.uniformcausticsampling.html b/docs/MulensModel.uniformcausticsampling.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.uniformcausticsampling module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.uniformcausticsampling module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.utils.html b/docs/MulensModel.utils.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.utils module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.utils module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/MulensModel.version.html b/docs/MulensModel.version.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>MulensModel.version module &#8212; MulensModel 2.1.15 documentation</title>
+    <title>MulensModel.version module &#8212; MulensModel 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '2.1.15',
+    VERSION: '2.3.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',