sphinx run

rpoleski · Oct 9, 2022 · fc0a941 · fc0a941
1 parent 2aff631
commit fc0a941
Show file tree

Hide file tree

Showing 41 changed files with 77 additions and 40 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: 10611ab27303c73170fa158b00ccea64
+config: 4866789757834547f9b404b5b1504f8b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/modules.doctree b/docs/.doctrees/modules.doctree
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.10.0 documentation</title>
+    <title>MulensModel.binarylens module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.binarylensimports module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.binarylenswithshear module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.caustics module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.causticswithshear module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.coordinates module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.event module &#8212; MulensModel 2.11.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>
@@ -137,6 +137,11 @@
 <dt>Keywords :</dt><dd><dl class="simple">
 <dt>data_ref: <em>int</em> or <em>MulensData</em></dt><dd><p>If data_ref is not specified, uses <a class="reference internal" href="#MulensModel.event.Event.data_ref" title="MulensModel.event.Event.data_ref"><code class="xref py py-obj docutils literal notranslate"><span class="pre">data_ref</span></code></a>.</p>
 </dd>
+<dt><code class="docutils literal notranslate"><span class="pre">**kwargs</span></code>:</dt><dd><p>Keywords passed to
+<a class="reference internal" href="MulensModel.model.html#MulensModel.model.Model.plot_lc" title="MulensModel.model.Model.plot_lc"><code class="xref py py-func docutils literal notranslate"><span class="pre">MulensModel.model.Model.plot_lc()</span></code></a>.
+You can use them to set time range plotted, fluxes,
+limb-darkening etc.</p>
+</dd>
 </dl>
 </dd>
 </dl>

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.10.0 documentation</title>
+    <title>MulensModel.fitdata module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.horizons module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel package &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.limbdarkeningcoeffs module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.magnificationcurve module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.model module &#8212; MulensModel 2.11.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.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.10.0 documentation</title>
+    <title>MulensModel.modelparameters module &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.mulensdata module &#8212; MulensModel 2.11.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>
@@ -107,7 +107,7 @@
 The type and size of marker are specified using different
 keywords: (‘fmt’, ‘markersize’) for errorbar() and
 (‘marker’, ‘size’) for scatter(). You can use either convention
-in <code class="xref py py-attr docutils literal notranslate"><span class="pre">plot_properties</span></code> and they will be translated
+in <a class="reference internal" href="#MulensModel.mulensdata.MulensData.plot_properties" title="MulensModel.mulensdata.MulensData.plot_properties"><code class="xref py py-attr docutils literal notranslate"><span class="pre">plot_properties</span></code></a> and they will be translated
 to appropriate keywords. If there are similar problems with
 other keywords, then they won’t be translated unless you
 contact code authors.</p>
@@ -126,11 +126,25 @@
 </dl>
 </dd>
 </dl>
+<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>
+<dd><p><em>dict</em></p>
+<p>Settings that specify how the photometry should be plotted.</p>
+<p>The keys in this <em>dict</em> could be either special keys introduced here
+(i.e., <code class="docutils literal notranslate"><span class="pre">show_bad</span></code> and <code class="docutils literal notranslate"><span class="pre">show_errorbars</span></code>) or keys accepted by
+matplotlib.pyplot plotting functions. The latter could be for example
+<code class="docutils literal notranslate"><span class="pre">color</span></code>, <code class="docutils literal notranslate"><span class="pre">marker</span></code>, <code class="docutils literal notranslate"><span class="pre">label</span></code>, <code class="docutils literal notranslate"><span class="pre">alpha</span></code>, <code class="docutils literal notranslate"><span class="pre">zorder</span></code>,
+<code class="docutils literal notranslate"><span class="pre">markersize</span></code>, or <code class="docutils literal notranslate"><span class="pre">visible</span></code>.</p>
+<p>See <a class="reference internal" href="#MulensModel.mulensdata.MulensData" title="MulensModel.mulensdata.MulensData"><code class="xref py py-class docutils literal notranslate"><span class="pre">MulensData</span></code></a>
+for more information.</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="MulensModel.mulensdata.MulensData.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">phot_fmt</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_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">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">model</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">plot_residuals</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="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.mulensdata.MulensData.plot" title="Permalink to this definition">¶</a></dt>
 <dd><p>Plot the data.</p>
-<p>Uses <code class="xref py py-attr docutils literal notranslate"><span class="pre">plot_properties</span></code> for label, color, etc.
+<p>Uses <a class="reference internal" href="#MulensModel.mulensdata.MulensData.plot_properties" title="MulensModel.mulensdata.MulensData.plot_properties"><code class="xref py py-attr docutils literal notranslate"><span class="pre">plot_properties</span></code></a> for label, color, etc.
 This settings can be changed by setting <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code>.</p>
 <p>You can plot in either flux or magnitude space.</p>
 <dl class="simple">
@@ -321,6 +335,19 @@
 <p>File with satellite ephemeris.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="MulensModel.mulensdata.MulensData.copy">
+<span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.mulensdata.MulensData.copy" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns a copy of given instance with settings copied</p>
+<dl class="simple">
+<dt>Returns :</dt><dd><dl class="simple">
+<dt>mulens_data: <a class="reference internal" href="#MulensModel.mulensdata.MulensData" title="MulensModel.mulensdata.MulensData"><code class="xref py py-class docutils literal notranslate"><span class="pre">MulensData</span></code></a></dt><dd><p>Copy of self.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 </section>

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.10.0 documentation</title>
+    <title>MulensModel.mulensobjects package &#8212; MulensModel 2.11.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.10.0 documentation</title>
+    <title>MulensModel.mulensobjects.lens module &#8212; MulensModel 2.11.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.mulenssystem.html b/docs/MulensModel.mulensobjects.mulenssystem.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.mulenssystem module &#8212; MulensModel 2.10.0 documentation</title>
+    <title>MulensModel.mulensobjects.mulenssystem module &#8212; MulensModel 2.11.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.source.html b/docs/MulensModel.mulensobjects.source.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.source module &#8212; MulensModel 2.10.0 documentation</title>
+    <title>MulensModel.mulensobjects.source module &#8212; MulensModel 2.11.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.pointlens.html b/docs/MulensModel.pointlens.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.pointlens module &#8212; MulensModel 2.10.0 documentation</title>
+    <title>MulensModel.pointlens module &#8212; MulensModel 2.11.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>