Skip to content

Commit

Permalink
sphinx run
Browse files Browse the repository at this point in the history
  • Loading branch information
@rpoleski
rpoleski committed May 4, 2019
1 parent e98a982 commit d394fcf
Show file tree
Hide file tree
Showing 36 changed files with 172 additions and 76 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: 235c63ded278d0c44584c011804d00c9
config: f918b07c0ab7d8d40a6ab374c81e63ed
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/MulensModel.binarylens.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel.binarylens module &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel.binarylens module &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/MulensModel.caustics.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel.caustics module &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel.caustics module &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/MulensModel.coordinates.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel.coordinates module &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel.coordinates module &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down
42 changes: 30 additions & 12 deletions docs/MulensModel.event.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel.event module &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel.event module &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -36,18 +36,28 @@
<dt id="MulensModel.event.Event">
<em class="property">class </em><code class="descclassname">MulensModel.event.</code><code class="descname">Event</code><span class="sig-paren">(</span><em>datasets=None</em>, <em>model=None</em>, <em>coords=None</em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.event.Event" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Allows a model to be fit to datasets.</p>
<p>Combines a microlensing model with data. Allows calculating chi^2 and
making a number of plots.</p>
<dl class="docutils">
<dt>Arguments :</dt>
<dd><dl class="first last docutils">
<dt><a class="reference internal" href="#MulensModel.event.Event.datasets" title="MulensModel.event.Event.datasets"><code class="xref py py-obj docutils literal notranslate"><span class="pre">datasets</span></code></a> (required):</dt>
<dd>a <a class="reference internal" href="MulensModel.mulensdata.html#MulensModel.mulensdata.MulensData" title="MulensModel.mulensdata.MulensData"><code class="xref py py-class docutils literal notranslate"><span class="pre">MulensData</span></code></a> object or
<em>list</em> of <a class="reference internal" href="MulensModel.mulensdata.html#MulensModel.mulensdata.MulensData" title="MulensModel.mulensdata.MulensData"><code class="xref py py-class docutils literal notranslate"><span class="pre">MulensData</span></code></a> objects.</dd>
<dt><a class="reference internal" href="#MulensModel.event.Event.model" title="MulensModel.event.Event.model"><code class="xref py py-obj docutils literal notranslate"><span class="pre">model</span></code></a> (required):</dt>
<dd>a <a class="reference internal" href="MulensModel.model.html#MulensModel.model.Model" title="MulensModel.model.Model"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a> object</dd>
<dt><a class="reference internal" href="#MulensModel.event.Event.coords" title="MulensModel.event.Event.coords"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coords</span></code></a> (optional):</dt>
<dd>the coordinates of the event (RA, Dec)</dd>
<dd><p class="first">datasets: <a class="reference internal" href="MulensModel.mulensdata.html#MulensModel.mulensdata.MulensData" title="MulensModel.mulensdata.MulensData"><code class="xref py py-class docutils literal notranslate"><span class="pre">MulensData</span></code></a> or
<em>list</em> of <a class="reference internal" href="MulensModel.mulensdata.html#MulensModel.mulensdata.MulensData" title="MulensModel.mulensdata.MulensData"><code class="xref py py-class docutils literal notranslate"><span class="pre">MulensData</span></code></a> objects</p>
<blockquote>
<div>Datasets that will be linked to the event. These datasets will
be used for chi^2 calculation, plotting etc.</div></blockquote>
<dl class="docutils">
<dt>model: <a class="reference internal" href="MulensModel.model.html#MulensModel.model.Model" title="MulensModel.model.Model"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a></dt>
<dd>Microlensing model that will be linked to the event. In order to
get chi^2 for different sets of model parameters you should
keep a single <a class="reference internal" href="MulensModel.model.html#MulensModel.model.Model" title="MulensModel.model.Model"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a> instance and
change parameters for this model (i.e., do not provide separate
<a class="reference internal" href="MulensModel.model.html#MulensModel.model.Model" title="MulensModel.model.Model"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a> instances).</dd>
</dl>
<p>coords: <em>str</em>, <a class="reference internal" href="MulensModel.coordinates.html#MulensModel.coordinates.Coordinates" title="MulensModel.coordinates.Coordinates"><code class="xref py py-class docutils literal notranslate"><span class="pre">Coordinates</span></code></a>,
or <a class="reference external" href="http://docs.astropy.org/en/stable/api/astropy.coordinates.SkyCoord.html">astropy.SkyCoord</a></p>
<blockquote class="last">
<div>Coordinates of the event. If <em>str</em>, then needs format accepted by
<a class="reference external" href="http://docs.astropy.org/en/stable/api/astropy.coordinates.SkyCoord.html">astropy.SkyCoord</a> e.g., <code class="docutils literal notranslate"><span class="pre">'18:00:00</span> <span class="pre">-30:00:00'</span></code>.</div></blockquote>
</dd>
<dt>Attributes :</dt>
<dd><dl class="first last docutils">
Expand Down Expand Up @@ -111,8 +121,8 @@
<dt>Parameters :</dt>
<dd><dl class="first last docutils">
<dt>fit_blending: <em>boolean</em>, optional</dt>
<dd>If True, then the blend flux is a free parameter. If
False, the blend flux is fixed at zero. Default is
<dd>If <em>True</em>, then the blend flux is a free parameter. If
<em>False</em>, the blend flux is fixed at zero. Default is
the same as <a class="reference internal" href="MulensModel.fit.html#MulensModel.fit.Fit.fit_fluxes" title="MulensModel.fit.Fit.fit_fluxes"><code class="xref py py-func docutils literal notranslate"><span class="pre">MulensModel.fit.Fit.fit_fluxes()</span></code></a>.</dd>
</dl>
</dd>
Expand Down Expand Up @@ -238,6 +248,14 @@
See <a class="reference internal" href="MulensModel.model.html#MulensModel.model.Model.plot_residuals" title="MulensModel.model.Model.plot_residuals"><code class="xref py py-func docutils literal notranslate"><span class="pre">MulensModel.model.Model.plot_residuals()</span></code></a> for details.</p>
</dd></dl>

<dl class="method">
<dt id="MulensModel.event.Event.plot_source_for_datasets">
<code class="descname">plot_source_for_datasets</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.event.Event.plot_source_for_datasets" title="Permalink to this definition"></a></dt>
<dd><p>Plot source positions for all linked datasets.
See <a class="reference internal" href="MulensModel.model.html#MulensModel.model.Model.plot_source_for_datasets" title="MulensModel.model.Model.plot_source_for_datasets"><code class="xref py py-func docutils literal notranslate"><span class="pre">MulensModel.model.Model.plot_source_for_datasets()</span></code></a> for
details.</p>
</dd></dl>

<dl class="method">
<dt id="MulensModel.event.Event.clean_data">
<code class="descname">clean_data</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#MulensModel.event.Event.clean_data" title="Permalink to this definition"></a></dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/MulensModel.fit.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel.fit module &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel.fit module &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/MulensModel.horizons.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel.horizons module &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel.horizons module &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/MulensModel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel package &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel package &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/MulensModel.limbdarkeningcoeffs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel.limbdarkeningcoeffs module &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel.limbdarkeningcoeffs module &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down
10 changes: 5 additions & 5 deletions docs/MulensModel.magnificationcurve.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>MulensModel.magnificationcurve module &#8212; MulensModel 1.9.8 documentation</title>
<title>MulensModel.magnificationcurve module &#8212; MulensModel 1.10.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" src="_static/documentation_options.js"></script>
Expand Down Expand Up @@ -149,7 +149,7 @@
pre-computed tables. The relative interpolation
errors are smaller than 10^-4.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">finite_source_LD_Yoo04</span></code>:</dt>
<dd>Uses the <a class="reference external" href="http://adsabs.harvard.edu/abs/1994ApJ...421L..71G">Gould 1994 ApJ, 421L, 71</a> prescription for
<dd>Uses the <a class="reference external" href="http://adsabs.harvard.edu/abs/2004ApJ...603..139Y">Yoo et al. 2004 ApJ, 603, 139</a> prescription for
a circular source <em>including limb-darkening</em>. This method
interpolates pre-computed tables. The relative interpolation
errors are smaller than 10^-4.</dd>
Expand All @@ -158,7 +158,7 @@
<em>uniform</em> (and circular) source. This method calculates
the underlying functions directly.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">finite_source_LD_Yoo04_direct</span></code>:</dt>
<dd>Uses the <a class="reference external" href="http://adsabs.harvard.edu/abs/1994ApJ...421L..71G">Gould 1994 ApJ, 421L, 71</a> prescription for
<dd>Uses the <a class="reference external" href="http://adsabs.harvard.edu/abs/2004ApJ...603..139Y">Yoo et al. 2004 ApJ, 603, 139</a> prescription for
a circular source <em>including limb-darkening</em>. This method
calculates 2D integral directly (hence can be slow).</dd>
<dt><code class="docutils literal notranslate"><span class="pre">finite_source_uniform_Lee09</span></code>:</dt>
Expand Down Expand Up @@ -198,11 +198,11 @@
<a class="reference internal" href="MulensModel.binarylens.html#MulensModel.binarylens.BinaryLens.hexadecapole_magnification" title="MulensModel.binarylens.BinaryLens.hexadecapole_magnification"><code class="xref py py-func docutils literal notranslate"><span class="pre">hexadecapole_magnification()</span></code></a></dd>
<dt><code class="docutils literal notranslate"><span class="pre">VBBL</span></code>:</dt>
<dd>Uses VBBinaryLensing (a Stokes theorem/contour
integration code) by Valerio Bozza. See
integration code) by Valerio Bozza (<a class="reference external" href="http://adsabs.harvard.edu/abs/2010MNRAS.408.2188B">Bozza 2010 MNRAS, 408, 2188</a>). See
<a class="reference internal" href="MulensModel.binarylens.html#MulensModel.binarylens.BinaryLens.vbbl_magnification" title="MulensModel.binarylens.BinaryLens.vbbl_magnification"><code class="xref py py-func docutils literal notranslate"><span class="pre">vbbl_magnification()</span></code></a></dd>
<dt><code class="docutils literal notranslate"><span class="pre">Adaptive_Contouring</span></code>:</dt>
<dd>Uses AdaptiveContouring (a Stokes theorem/contour
integration code) by Martin Dominik. See
integration code) by Martin Dominik (<a class="reference external" href="http://adsabs.harvard.edu/abs/2007MNRAS.377.1679D">Dominik 2007 MNRAS, 377, 1679</a>). See
<a class="reference internal" href="MulensModel.binarylens.html#MulensModel.binarylens.BinaryLens.adaptive_contouring_magnification" title="MulensModel.binarylens.BinaryLens.adaptive_contouring_magnification"><code class="xref py py-func docutils literal notranslate"><span class="pre">adaptive_contouring_magnification()</span></code></a></dd>
<dt><code class="docutils literal notranslate"><span class="pre">point_source_point_lens</span></code>:</dt>
<dd>Uses point-source _point_-_lens_ approximation; useful when you
Expand Down
Loading

0 comments on commit d394fcf

Please sign in to comment.