sphinx run

rpoleski · Jul 25, 2023 · 7e86188 · 7e86188
1 parent dc2e047
commit 7e86188
Show file tree

Hide file tree

Showing 41 changed files with 138 additions and 42 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: a0178952ae488d1e628925742e3e7ad4
+config: f46a4265c903584400663bee36e1330d
 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.15.0 documentation</title>
+    <title>MulensModel.binarylens module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.binarylensimports module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.binarylenswithshear module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.caustics module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.causticspointwithshear module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.causticswithshear module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.coordinates module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.event module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.fitdata module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.horizons module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel package &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.limbdarkeningcoeffs module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.magnificationcurve module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.model module &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.modelparameters module &#8212; MulensModel 2.17.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>
@@ -278,6 +278,76 @@
 It is best to fix it at the begin of calculations.</p>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.xi_period">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">xi_period</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.xi_period" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>float</em></p>
+<p>Orbital period of the source system (xallarap) in days.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.xi_semimajor_axis">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">xi_semimajor_axis</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.xi_semimajor_axis" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>float</em></p>
+<p>Semi-major axis of the source orbit (xallarap) in the theta_E units.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.xi_Omega_node">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">xi_Omega_node</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.xi_Omega_node" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>float</em></p>
+<p>The longitude of the ascending node of the xallarap orbit, i.e.,
+the angle from relative lens-source proper motion direction
+to the ascending node direction.
+The units are degrees.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.xi_inclination">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">xi_inclination</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.xi_inclination" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>float</em></p>
+<p>The inclination of the xallarap orbit, i.e.,
+the angle between source-orbit plane and the sky plane.
+The units are degrees.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.xi_argument_of_latitude_reference">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">xi_argument_of_latitude_reference</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.xi_argument_of_latitude_reference" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>float</em></p>
+<p>The argument of latitude for the xallarap orbit at <a class="reference internal" href="#MulensModel.modelparameters.ModelParameters.t_0_xi" title="MulensModel.modelparameters.ModelParameters.t_0_xi"><code class="xref py py-attr docutils literal notranslate"><span class="pre">t_0_xi</span></code></a>.
+The argument of latitude is a sum of the true anomaly and
+the argument of periapsis. In standard notation: u = nu + omega.
+This parameter is internally used to calculate perihelion passage
+(T_0 in standard notation).
+The units are degrees.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.xi_eccentricity">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">xi_eccentricity</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.xi_eccentricity" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>float</em></p>
+<p>The eccentricity of the xallarap orbit. Has to be in [0, 1) range.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.xi_omega_periapsis">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">xi_omega_periapsis</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.xi_omega_periapsis" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>float</em></p>
+<p>The argument of periapsis of the xallrap orbit, i.e., the angle
+between the ascending node and periapsis measured in
+the direction of motion.
+The units are degrees.</p>
+</dd></dl>
+
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.t_0_xi">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">t_0_xi</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.t_0_xi" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>float</em></p>
+<p>Reference epoch for xallarap orbit.
+If not provided, then it defaults to <a class="reference internal" href="#MulensModel.modelparameters.ModelParameters.t_0" title="MulensModel.modelparameters.ModelParameters.t_0"><code class="xref py py-attr docutils literal notranslate"><span class="pre">t_0</span></code></a>.</p>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.t_0_1">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">t_0_1</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.t_0_1" title="Permalink to this definition">¶</a></dt>
@@ -439,14 +509,15 @@
 <dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.n_lenses">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n_lenses</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.n_lenses" title="Permalink to this definition">¶</a></dt>
 <dd><p><em>int</em></p>
-<p>number of objects in the lens system</p>
+<p>Number of objects in the lens system.</p>
 </dd></dl>
 
 <dl class="py property">
 <dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.n_sources">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">n_sources</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.n_sources" title="Permalink to this definition">¶</a></dt>
 <dd><p><em>int</em></p>
-<p>number of luminous sources; it’s possible to be 1 for xallarap model</p>
+<p>Number of luminous sources.
+It can be be 1 for a xallarap model.</p>
 </dd></dl>
 
 <dl class="py property">
@@ -464,6 +535,13 @@
 model with non-zero shear</p>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.is_xallarap">
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_xallarap</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.is_xallarap" title="Permalink to this definition">¶</a></dt>
+<dd><p><em>bool</em></p>
+<p>Whether the parameters include the xallarap or not.</p>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="MulensModel.modelparameters.ModelParameters.source_1_parameters">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source_1_parameters</span></span><a class="headerlink" href="#MulensModel.modelparameters.ModelParameters.source_1_parameters" title="Permalink to this definition">¶</a></dt>

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.15.0 documentation</title>
+    <title>MulensModel.mulensdata module &#8212; MulensModel 2.17.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.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.15.0 documentation</title>
+    <title>MulensModel.mulensobjects package &#8212; MulensModel 2.17.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.15.0 documentation</title>
+    <title>MulensModel.mulensobjects.lens module &#8212; MulensModel 2.17.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>