Skip to content

Commit

Permalink
re-run sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
rpoleski committed Sep 14, 2017
1 parent 13f937f commit bf62c7f
Show file tree
Hide file tree
Showing 32 changed files with 1,050 additions and 825 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
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: b041181764f80ab95c3a030909266050
config: 433f0ed64a0a9691df4e46868bbc8a26
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/.doctrees/MulensModel.doctree
Binary file not shown.
Binary file modified docs/.doctrees/MulensModel.mulensobjects.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/.doctrees/modules.doctree
Binary file not shown.
135 changes: 68 additions & 67 deletions docs/MulensModel.html

Large diffs are not rendered by default.

55 changes: 28 additions & 27 deletions docs/MulensModel.mulensobjects.html
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>MulensModel.mulensobjects package &#8212; MulensModel 1.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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="MulensModel 1.0 documentation" href="index.html" />

<link rel="stylesheet" href="_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head>
<body>
<body role="document">


<div class="document">
Expand Down Expand Up @@ -62,14 +63,14 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<p>(<a class="reference internal" href="#MulensModel.mulensobjects.lens.Lens.total_mass" title="MulensModel.mulensobjects.lens.Lens.total_mass"><code class="xref py py-obj docutils literal"><span class="pre">total_mass</span></code></a>, <a class="reference internal" href="#MulensModel.mulensobjects.lens.Lens.epsilon" title="MulensModel.mulensobjects.lens.Lens.epsilon"><code class="xref py py-obj docutils literal"><span class="pre">epsilon</span></code></a>, <a class="reference internal" href="#MulensModel.mulensobjects.lens.Lens.distance" title="MulensModel.mulensobjects.lens.Lens.distance"><code class="xref py py-obj docutils literal"><span class="pre">distance</span></code></a>) - Missing s/Not Implemented?</p>
<p>(<a class="reference internal" href="#MulensModel.mulensobjects.lens.Lens.mass_1" title="MulensModel.mulensobjects.lens.Lens.mass_1"><code class="xref py py-obj docutils literal"><span class="pre">mass_1</span></code></a>, <a class="reference internal" href="#MulensModel.mulensobjects.lens.Lens.mass_2" title="MulensModel.mulensobjects.lens.Lens.mass_2"><code class="xref py py-obj docutils literal"><span class="pre">mass_2</span></code></a>, <a class="reference internal" href="#MulensModel.mulensobjects.lens.Lens.a_proj" title="MulensModel.mulensobjects.lens.Lens.a_proj"><code class="xref py py-obj docutils literal"><span class="pre">a_proj</span></code></a>, <a class="reference internal" href="#MulensModel.mulensobjects.lens.Lens.distance" title="MulensModel.mulensobjects.lens.Lens.distance"><code class="xref py py-obj docutils literal"><span class="pre">distance</span></code></a>) - Not Implemented</p>
</div></blockquote>
<p>Note that s, q, and epsilon may be single values, lists, or numpy arrays.</p>
<p>Note that s, q, and epsilon may be single values, lists, or numpy ndarrays.</p>
<p>If units are not specified for a given mass, it is assumed the value
given is in Solar Masses.</p>
<p>If units are not specified for distance, and the value given is
&lt;50, it is assumed the value is given in kpc. Otherwise, pc are
assumed.</p>
<dl class="docutils">
<dt>TO DO:</dt>
<dt>To be done:</dt>
<dd><ul class="first last simple">
<li>__repr__ function needs work</li>
<li>a_proj, couples with source distance in mulensmodel to determine s.</li>
Expand All @@ -85,7 +86,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<code class="descname">epsilon</code><a class="headerlink" href="#MulensModel.mulensobjects.lens.Lens.epsilon" title="Permalink to this definition"></a></dt>
<dd><p>[<em>float, list, numpy.ndarray</em>]</p>
<p>An array of mass fractions for each lens components:
m_i/total_mass. Stored as a <em>numpy.array</em>.</p>
m_i/total_mass. Stored as a <em>numpy.ndarray</em>.</p>
</dd></dl>

<dl class="attribute">
Expand All @@ -94,7 +95,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd><p>[<em>float, list, numpy.ndarray</em>]</p>
<p>mass ratio for companions relative to the primary</p>
<p>Array of mass ratios defined relative to the primary (m_i/m_1). Size is
number of components -1. Set as a list, numpy.array, or single value.</p>
number of components -1. Set as a list, np.ndarray, or single value.</p>
<p>Note: if <a class="reference internal" href="#MulensModel.mulensobjects.lens.Lens.total_mass" title="MulensModel.mulensobjects.lens.Lens.total_mass"><code class="xref py py-obj docutils literal"><span class="pre">total_mass</span></code></a> is defined before q, it is
assumed this is the mass of the primary. If you want this to
actually be the total mass, define it after defining q.</p>
Expand All @@ -105,7 +106,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<code class="descname">s</code><a class="headerlink" href="#MulensModel.mulensobjects.lens.Lens.s" title="Permalink to this definition"></a></dt>
<dd><p>[<em>float, list, numpy.ndarray</em>]</p>
<p>Separation between the components of the lens as a fraction of
the Einstein ring. A numpy.array or single value.</p>
the Einstein ring. A np.ndarray or single value.</p>
<p>Definitions for more than 2 lens bodies TBD</p>
</dd></dl>

Expand All @@ -122,7 +123,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dt id="MulensModel.mulensobjects.lens.Lens.mass">
<code class="descname">mass</code><a class="headerlink" href="#MulensModel.mulensobjects.lens.Lens.mass" title="Permalink to this definition"></a></dt>
<dd><p><em>astropy.Quantity</em></p>
<p>The mass of a point lens &gt; total mass. An astropy.Quantity
<p>The mass of a point lens &#8211;&gt; total mass. An astropy.Quantity
with mass units. May be set as a float (in which case solMass
is assumed).</p>
</dd></dl>
Expand All @@ -132,7 +133,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<code class="descname">mass_1</code><a class="headerlink" href="#MulensModel.mulensobjects.lens.Lens.mass_1" title="Permalink to this definition"></a></dt>
<dd><p><em>astropy.Quantity</em></p>
<p>The mass of the primary. Defined as total_mass *
epsilon[0]. An astropy.Quantity with mass units. If set as a
epsilon[0]. An <em>astropy.Quantity</em> with mass units. If set as a
<em>float</em>, units are assumed to be solMass.</p>
</dd></dl>

Expand All @@ -141,7 +142,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<code class="descname">mass_2</code><a class="headerlink" href="#MulensModel.mulensobjects.lens.Lens.mass_2" title="Permalink to this definition"></a></dt>
<dd><p><em>astropy.Quantity</em></p>
<p>The mass of the secondary. Defined as total_mass *
epsilon[1]. An astropy.Quantity with mass units. If set as a
epsilon[1]. An <em>astropy.Quantity</em> with mass units. If set as a
<em>float</em>, units are assumed to be solMass.</p>
<p>Note that if total_mass is defined before mass_2, and there is
no epsilon corresponding to mass_2, mass_2 is added to the
Expand All @@ -153,7 +154,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<code class="descname">mass_3</code><a class="headerlink" href="#MulensModel.mulensobjects.lens.Lens.mass_3" title="Permalink to this definition"></a></dt>
<dd><p><em>astropy.Quantity</em></p>
<p>The mass of the tertiary. Defined as total_mass * epsilon[2].
An astropy.Quantity with mass units. If set as a
An <em>astropy.Quantity</em> with mass units. If set as a
<em>float</em>, units are assumed to be solMass.</p>
<p>Note that if total_mass is defined before mass_3, and there is
no epsilon corresponding to mass_3, mass_3 is added to the total_mass.</p>
Expand Down Expand Up @@ -190,7 +191,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<code class="descname">a_proj</code><a class="headerlink" href="#MulensModel.mulensobjects.lens.Lens.a_proj" title="Permalink to this definition"></a></dt>
<dd><p><em>astropy.Quantity</em></p>
<p>Projected separation between the components of the lens in
AU. An astropy.Quantity with distance units. If set as float
AU. An <em>astropy.Quantity</em> with distance units. If set as <em>float</em>
(without units), AU is assumed.</p>
</dd></dl>

Expand Down Expand Up @@ -237,7 +238,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<code class="descname">mu_rel</code><a class="headerlink" href="#MulensModel.mulensobjects.mulenssystem.MulensSystem.mu_rel" title="Permalink to this definition"></a></dt>
<dd><p><em>astropy.Quantity</em></p>
<p>Relative proper motion between the source and lens
stars. If set as a float, units are assumed to be mas/yr.</p>
stars. If set as a <em>float</em>, units are assumed to be mas/yr.</p>
</dd></dl>

<dl class="attribute">
Expand Down Expand Up @@ -284,10 +285,10 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
specified. If the lens has more than one body, alpha must also
be specified.</p>
<dl class="docutils">
<dt>Parameters <span class="classifier-delimiter">:</span> <span class="classifier"></span></dt>
<dd><dl class="first last docutils">
<dt>u_0 <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd>Impact parameter between the source and the lens (as a
<dt>Parameters</dt>
<span class="classifier-delimiter">:</span> <span class="classifier"></span><dd><dl class="first last docutils">
<dt>u_0</dt>
<span class="classifier-delimiter">:</span> <span class="classifier"><em>float</em></span><dd>Impact parameter between the source and the lens (as a
fraction of the Einstein ring)</dd>
<dt>alpha :</dt>
<dd>see <a class="reference internal" href="MulensModel.html#MulensModel.modelparameters.ModelParameters.alpha" title="MulensModel.modelparameters.ModelParameters.alpha"><code class="xref py py-obj docutils literal"><span class="pre">MulensModel.modelparameters.ModelParameters.alpha</span></code></a></dd>
Expand Down Expand Up @@ -319,8 +320,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dl class="docutils">
<dt>Attributes :</dt>
<dd><dl class="first last docutils">
<dt>limb_darkening <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="MulensModel.html#MulensModel.limbdarkeningcoeffs.LimbDarkeningCoeffs" title="MulensModel.limbdarkeningcoeffs.LimbDarkeningCoeffs"><code class="xref py py-class docutils literal"><span class="pre">LimbDarkeningCoeffs</span></code></a></span></dt>
<dd>Limb darkening coefficients of the source.</dd>
<dt>limb_darkening</dt>
<span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="MulensModel.html#MulensModel.limbdarkeningcoeffs.LimbDarkeningCoeffs" title="MulensModel.limbdarkeningcoeffs.LimbDarkeningCoeffs"><code class="xref py py-class docutils literal"><span class="pre">LimbDarkeningCoeffs</span></code></a></span><dd>Limb darkening coefficients of the source.</dd>
</dl>
</dd>
</dl>
Expand Down Expand Up @@ -385,7 +386,7 @@ <h3>Related Topics</h3>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/MulensModel.mulensobjects.rst.txt"
<li><a href="_sources/MulensModel.mulensobjects.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
Expand All @@ -407,11 +408,11 @@ <h3>Quick search</h3>
&copy;2017, Radek Poleski, Jennifer Yee.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>

|
<a href="_sources/MulensModel.mulensobjects.rst.txt"
<a href="_sources/MulensModel.mulensobjects.txt"
rel="nofollow">Page source</a>
</div>

Expand Down
22 changes: 11 additions & 11 deletions docs/_static/alabaster.css
Original file line number Diff line number Diff line change
Expand Up @@ -272,10 +272,15 @@ div.admonition {
}

div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
background-color: #FBFBFB;
background-color: ;
border-bottom: 1px solid #fafafa;
}

dd div.admonition {
margin-left: -60px;
padding-left: 60px;
}

div.admonition p.admonition-title {
font-family: 'Garamond', 'Georgia', serif;
font-weight: normal;
Expand Down Expand Up @@ -438,16 +443,6 @@ table.field-list p {
margin-bottom: 0.8em;
}

/* Cloned from
* https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
*/
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}

table.footnote td.label {
width: .1px;
padding: 0.3em 0 0.3em 0.5em;
Expand Down Expand Up @@ -493,6 +488,11 @@ dl pre, blockquote pre, li pre {
padding-left: 30px;
}

dl dl pre {
margin-left: -90px;
padding-left: 90px;
}

tt, code {
background-color: #ecf0f3;
color: #222;
Expand Down
73 changes: 19 additions & 54 deletions docs/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -122,8 +122,6 @@ ul.keywordmatches li.goodmatch a {

table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}

table.contentstable p.biglink {
Expand Down Expand Up @@ -151,14 +149,9 @@ table.indextable td {
vertical-align: top;
}

table.indextable ul {
table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}

table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}

table.indextable tr.pcap {
Expand Down Expand Up @@ -190,13 +183,6 @@ div.genindex-jumpbox {
padding: 0.4em;
}

/* -- domain module index --------------------------------------------------- */

table.modindextable td {
padding: 2px;
border-collapse: collapse;
}

/* -- general body styles --------------------------------------------------- */

div.body p, div.body dd, div.body li, div.body blockquote {
Expand Down Expand Up @@ -231,6 +217,10 @@ div.body td {
text-align: left;
}

.field-list ul {
padding-left: 1em;
}

.first {
margin-top: 0 !important;
}
Expand Down Expand Up @@ -347,6 +337,10 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}

table.field-list td, table.field-list th {
border: 0 !important;
}

table.footnote td, table.footnote th {
border: 0 !important;
}
Expand Down Expand Up @@ -383,27 +377,6 @@ div.figure p.caption span.caption-number {
div.figure p.caption span.caption-text {
}

/* -- field list styles ----------------------------------------------------- */

table.field-list td, table.field-list th {
border: 0 !important;
}

.field-list ul {
margin: 0;
padding-left: 1em;
}

.field-list p {
margin: 0;
}

.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}

/* -- other body styles ----------------------------------------------------- */

Expand Down Expand Up @@ -454,6 +427,15 @@ dl.glossary dt {
font-size: 1.1em;
}

.field-list ul {
margin: 0;
padding-left: 1em;
}

.field-list p {
margin: 0;
}

.optional {
font-size: 1.3em;
}
Expand Down Expand Up @@ -512,13 +494,6 @@ pre {
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}

span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
}

td.linenos pre {
padding: 5px 0px;
border: 0;
Expand Down Expand Up @@ -610,16 +585,6 @@ span.eqno {
float: right;
}

span.eqno a.headerlink {
position: relative;
left: 0px;
z-index: 1;
}

div.math:hover a.headerlink {
visibility: visible;
}

/* -- printout stylesheet --------------------------------------------------- */

@media print {
Expand Down
Binary file modified docs/_static/comment-bright.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/comment-close.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/comment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
Binary file modified docs/_static/down-pressed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/down.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/_static/jquery.js

Large diffs are not rendered by default.

Binary file modified docs/_static/minus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/plus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit bf62c7f

Please sign in to comment.