minor documentation update

rpoleski · Oct 6, 2020 · 289c06d · 289c06d
1 parent 6587837
commit 289c06d
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 14 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: b49465b160950b771bf129bc23bee1f6
+config: 91416e407b7d5b5c6d2cca68a981432b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
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: '1.17.1',
+    VERSION: '1.17.2',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; MulensModel 1.17.1 documentation</title>
+    <title>Index &#8212; MulensModel 1.17.2 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/index.html b/docs/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Welcome to MulensModel’s documentation! &#8212; MulensModel 1.17.1 documentation</title>
+    <title>Welcome to MulensModel’s documentation! &#8212; MulensModel 1.17.2 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/install.html b/docs/install.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>How to install? &#8212; MulensModel 1.17.1 documentation</title>
+    <title>How to install? &#8212; MulensModel 1.17.2 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>
@@ -51,14 +51,14 @@ <h2>Old installation<a class="headerlink" href="#old-installation" title="Permal
 <li><p>Make sure you have python with <a class="reference external" href="http://www.astropy.org/">astropy package</a> installed.</p></li>
 <li><p>Download source code - either <a class="reference external" href="https://github.com/rpoleski/MulensModel/releases">recent release</a> or the current repository from <a class="reference external" href="https://github.com/rpoleski/MulensModel">MulensModel github page</a> (green button on right).</p></li>
 <li><p>Unpack the archive.</p></li>
-<li><p>Add the path to the unpack directory to the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code>, e.g., if you’ve extracted the archive in your home directory (<code class="docutils literal notranslate"><span class="pre">/home/USER_NAME/</span></code>) in tcsh:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>setenv PYTHONPATH /home/USER_NAME/MulensModel-1.3.0/source\:$PYTHONPATH
+<li><p>Add the path to the unpack directory to the <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code>, e.g., if you’ve extracted the archive in your home directory (<code class="docutils literal notranslate"><span class="pre">/home/USER_NAME/</span></code>) and MulensModel version in 1.17.0 in tcsh (update the path as needed):</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>setenv PYTHONPATH /home/USER_NAME/MulensModel-1.17.0/source\:$PYTHONPATH
 </pre></div>
 </div>
 </li>
 </ol>
 <p>in bash:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>export PYTHONPATH=/home/USER_NAME/MulensModel-1.3.0/source:$PYTHONPATH
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>export PYTHONPATH=/home/USER_NAME/MulensModel-1.17.0/source:$PYTHONPATH
 </pre></div>
 </div>
 <p>In order to have this command invoked every time you open a terminal, please add this command to your startup file (<code class="docutils literal notranslate"><span class="pre">~/.cshrc</span></code>, <code class="docutils literal notranslate"><span class="pre">~/.bashrc</span></code>, <code class="docutils literal notranslate"><span class="pre">~/.profile</span></code>, or similar). If you didn’t have <code class="docutils literal notranslate"><span class="pre">PYTHONPATH</span></code> defined before, then skip the last part of the above commands.</p>

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; MulensModel 1.17.1 documentation</title>
+    <title>Python Module Index &#8212; MulensModel 1.17.2 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/search.html b/docs/search.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; MulensModel 1.17.1 documentation</title>
+    <title>Search &#8212; MulensModel 1.17.2 documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -18,13 +18,13 @@ Old installation
 1. Make sure you have python with `astropy package`_ installed.
 2. Download source code - either `recent release`_ or the current repository from `MulensModel github page`_ (green button on right).
 3. Unpack the archive.
-4. Add the path to the unpack directory to the ``PYTHONPATH``, e.g., if you've extracted the archive in your home directory (``/home/USER_NAME/``) in tcsh::
+4. Add the path to the unpack directory to the ``PYTHONPATH``, e.g., if you've extracted the archive in your home directory (``/home/USER_NAME/``) and MulensModel version in 1.17.0 in tcsh (update the path as needed)::
 
-    setenv PYTHONPATH /home/USER_NAME/MulensModel-1.3.0/source\:$PYTHONPATH
+    setenv PYTHONPATH /home/USER_NAME/MulensModel-1.17.0/source\:$PYTHONPATH
 
 in bash::
 
-    export PYTHONPATH=/home/USER_NAME/MulensModel-1.3.0/source:$PYTHONPATH
+    export PYTHONPATH=/home/USER_NAME/MulensModel-1.17.0/source:$PYTHONPATH
 
 In order to have this command invoked every time you open a terminal, please add this command to your startup file (``~/.cshrc``, ``~/.bashrc``, ``~/.profile``, or similar). If you didn't have ``PYTHONPATH`` defined before, then skip the last part of the above commands.
 

diff --git a/examples/example_16/README.md b/examples/example_16/README.md
@@ -42,6 +42,8 @@ You can specify the methods used for calculating magnification. For example, fit
 python ulens_model_fit.py ob03235_1.yaml
 ```
 
+Note that this YAML file will result in a warning message. The message is caused by the fact that in some cases, flux minus its uncertainty results in negative values which cannot be translated to magnitudes when plotting. The warning is related to only plotting, not fitting. You can ignore this warning.
+
 There are many more features to be added - _please let authors know what specific needs you have_.
 
 Please note that this code is a high-level example for MulensModel, but it uses fitting algorithms that are not part of MulensModel. The latter allows many microlensing calculations including chi^2 for given data and model parameters, but does not have built-in fitting capabilities.