Rebuild documentation.

dsavoiu · Jun 22, 2016 · 6c954d5 · 6c954d5
1 parent 360d52f
commit 6c954d5
Show file tree

Hide file tree

Showing 14 changed files with 70 additions and 34 deletions.
diff --git a/doc/html/.buildinfo b/doc/html/.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: 739535deb71eaf77dd0aaa07793036b0
+config: 4390d080e95ddaf8b2809b7b9fe99f01
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc/html/examples.html b/doc/html/examples.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Fit examples, utilities, tips and tricks &mdash; kafe 1.0.1 documentation</title>
+  <title>Fit examples, utilities, tips and tricks &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -32,7 +32,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="index.html"/>
+    <link rel="top" title="kafe 1.1.0 documentation" href="index.html"/>
         <link rel="next" title="kafe reference" href="module_doc.html"/>
         <link rel="prev" title="Installing kafe" href="installation.html"/> 
 
@@ -905,7 +905,7 @@ <h2>Example 10 - plotting with <em>kafe</em>: properties of a Gauss curve<a clas
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/genindex.html b/doc/html/genindex.html
@@ -9,7 +9,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; kafe 1.0.1 documentation</title>
+  <title>Index &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -31,7 +31,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="index.html"/> 
+    <link rel="top" title="kafe 1.1.0 documentation" href="index.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -209,19 +209,27 @@ <h2 id="C">C</h2>
   </dt>
 
 
+  <dt><a href="module_doc.html#kafe.fit.Chi22CL">Chi22CL() (in module kafe.fit)</a>
+  </dt>
+
+
+  <dt><a href="module_doc.html#kafe.fit.CL2Chi2">CL2Chi2() (in module kafe.fit)</a>
+  </dt>
+
+
   <dt><a href="module_doc.html#kafe.plot.Plot.compute_plot_range">compute_plot_range() (kafe.plot.Plot method)</a>
   </dt>
 
 
   <dt><a href="module_doc.html#module-config">config (module)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="module_doc.html#kafe.fit.Fit.constrain_parameters">constrain_parameters() (kafe.fit.Fit method)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="module_doc.html#kafe.fit.Fit.contours">contours (kafe.fit.Fit attribute)</a>
   </dt>
@@ -1304,7 +1312,7 @@ <h2 id="Z">Z</h2>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/index.html b/doc/html/index.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Welcome to kafe, the Karlsruhe Fit Environment &mdash; kafe 1.0.1 documentation</title>
+  <title>Welcome to kafe, the Karlsruhe Fit Environment &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -32,7 +32,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="#"/>
+    <link rel="top" title="kafe 1.1.0 documentation" href="#"/>
         <link rel="next" title="Installing kafe" href="installation.html"/> 
 
 
@@ -371,7 +371,7 @@ <h2>Example<a class="headerlink" href="#example" title="Permalink to this headli
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/index_latex.html b/doc/html/index_latex.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Welcome to kafe, the Karlsruhe Fit Environment &mdash; kafe 1.0.1 documentation</title>
+  <title>Welcome to kafe, the Karlsruhe Fit Environment &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -32,7 +32,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="index.html"/> 
+    <link rel="top" title="kafe 1.1.0 documentation" href="index.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -160,7 +160,7 @@ <h1>Welcome to <em>kafe</em>, the Karlsruhe Fit Environment<a class="headerlink"
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/installation.html b/doc/html/installation.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Installing kafe &mdash; kafe 1.0.1 documentation</title>
+  <title>Installing kafe &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -32,7 +32,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="index.html"/>
+    <link rel="top" title="kafe 1.1.0 documentation" href="index.html"/>
         <link rel="next" title="Fit examples, utilities, tips and tricks" href="examples.html"/>
         <link rel="prev" title="Welcome to kafe, the Karlsruhe Fit Environment" href="index.html"/> 
 
@@ -404,7 +404,7 @@ <h3>Using <em>kafe</em> with ROOT under Windows<a class="headerlink" href="#usin
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/module_doc.html b/doc/html/module_doc.html
@@ -10,7 +10,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>kafe reference &mdash; kafe 1.0.1 documentation</title>
+  <title>kafe reference &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -32,7 +32,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="index.html"/>
+    <link rel="top" title="kafe 1.1.0 documentation" href="index.html"/>
         <link rel="prev" title="Fit examples, utilities, tips and tricks" href="examples.html"/> 
 
 
@@ -890,7 +890,19 @@ <h2>Main modules: <a class="reference internal" href="#module-kafe.dataset" titl
 </div>
 <div class="section" id="module-kafe.fit">
 <span id="fit-fit-of-model-functions-to-a-dataset-kafe-fit"></span><h3><code class="docutils literal"><span class="pre">Fit</span></code>: Fit of model functions to a <code class="docutils literal"><span class="pre">Dataset</span></code> (<a class="reference internal" href="#module-kafe.fit" title="kafe.fit"><code class="xref py py-mod docutils literal"><span class="pre">kafe.fit</span></code></a>)<a class="headerlink" href="#module-kafe.fit" title="Permalink to this headline">¶</a></h3>
-<span class="target" id="module-fit"></span><dl class="class">
+<span class="target" id="module-fit"></span><dl class="function">
+<dt id="kafe.fit.CL2Chi2">
+<code class="descclassname">kafe.fit.</code><code class="descname">CL2Chi2</code><span class="sig-paren">(</span><em>CL</em><span class="sig-paren">)</span><a class="headerlink" href="#kafe.fit.CL2Chi2" title="Permalink to this definition">¶</a></dt>
+<dd><p>Helper function to calculate DeltaChi2 from confidence level CL</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="kafe.fit.Chi22CL">
+<code class="descclassname">kafe.fit.</code><code class="descname">Chi22CL</code><span class="sig-paren">(</span><em>dc2</em><span class="sig-paren">)</span><a class="headerlink" href="#kafe.fit.Chi22CL" title="Permalink to this definition">¶</a></dt>
+<dd><p>Helper function to calculate confidence level CL from DeltaChi2</p>
+</dd></dl>
+
+<dl class="class">
 <dt id="kafe.fit.Fit">
 <em class="property">class </em><code class="descclassname">kafe.fit.</code><code class="descname">Fit</code><span class="sig-paren">(</span><em>dataset</em>, <em>fit_function</em>, <em>external_fcn=&lt;function chi2&gt;</em>, <em>fit_name=None</em>, <em>fit_label=None</em>, <em>minimizer_to_use='iminuit'</em><span class="sig-paren">)</span><a class="headerlink" href="#kafe.fit.Fit" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
@@ -3327,7 +3339,7 @@ <h2>Auxilliary modules<a class="headerlink" href="#auxilliary-modules" title="Pe
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/objects.inv b/doc/html/objects.inv
diff --git a/doc/html/overview.html b/doc/html/overview.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>kafe Overview &mdash; kafe 1.0.1 documentation</title>
+  <title>kafe Overview &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -30,7 +30,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="index.html"/> 
+    <link rel="top" title="kafe 1.1.0 documentation" href="index.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -349,7 +349,7 @@ <h2>Example<a class="headerlink" href="#example" title="Permalink to this headli
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/py-modindex.html b/doc/html/py-modindex.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Python Module Index &mdash; kafe 1.0.1 documentation</title>
+  <title>Python Module Index &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -30,7 +30,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="index.html"/>
+    <link rel="top" title="kafe 1.1.0 documentation" href="index.html"/>
 
 
 
@@ -354,7 +354,7 @@ <h1>Python Module Index</h1>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/search.html b/doc/html/search.html
@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Search &mdash; kafe 1.0.1 documentation</title>
+  <title>Search &mdash; kafe 1.1.0 documentation</title>
 
 
 
@@ -30,7 +30,7 @@
 
 
 
-    <link rel="top" title="kafe 1.0.1 documentation" href="index.html"/> 
+    <link rel="top" title="kafe 1.1.0 documentation" href="index.html"/> 
 
 
   <script src="_static/js/modernizr.min.js"></script>
@@ -154,7 +154,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'1.0.1',
+            VERSION:'1.1.0',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',
             HAS_SOURCE:  true

diff --git a/doc/html/searchindex.js b/doc/html/searchindex.js
diff --git a/doc/latex/kafe.pdf b/doc/latex/kafe.pdf
diff --git a/doc/latex/kafe.tex b/doc/latex/kafe.tex
@@ -20,7 +20,7 @@
 
 \title{kafe Documentation}
 \date{June 22, 2016}
-\release{1.0.1}
+\release{1.1.0}
 \author{D. Savoiu, G. Quast}
 \newcommand{\sphinxlogo}{}
 \renewcommand{\releasename}{Release}
@@ -2352,7 +2352,23 @@ \subsection{\texttt{Dataset}: Collection of data points (\texttt{kafe.dataset})}
 
 
 \subsection{\texttt{Fit}: Fit of model functions to a \texttt{Dataset} (\texttt{kafe.fit})}
-\label{module_doc:fit-fit-of-model-functions-to-a-dataset-kafe-fit}\label{module_doc:module-kafe.fit}\index{kafe.fit (module)}\phantomsection\label{module_doc:module-fit}\index{fit (module)}\index{Fit (class in kafe.fit)}
+\label{module_doc:fit-fit-of-model-functions-to-a-dataset-kafe-fit}\label{module_doc:module-kafe.fit}\index{kafe.fit (module)}\phantomsection\label{module_doc:module-fit}\index{fit (module)}\index{CL2Chi2() (in module kafe.fit)}
+
+\begin{fulllineitems}
+\phantomsection\label{module_doc:kafe.fit.CL2Chi2}\pysiglinewithargsret{\code{kafe.fit.}\bfcode{CL2Chi2}}{\emph{CL}}{}
+Helper function to calculate DeltaChi2 from confidence level CL
+
+\end{fulllineitems}
+
+\index{Chi22CL() (in module kafe.fit)}
+
+\begin{fulllineitems}
+\phantomsection\label{module_doc:kafe.fit.Chi22CL}\pysiglinewithargsret{\code{kafe.fit.}\bfcode{Chi22CL}}{\emph{dc2}}{}
+Helper function to calculate confidence level CL from DeltaChi2
+
+\end{fulllineitems}
+
+\index{Fit (class in kafe.fit)}
 
 \begin{fulllineitems}
 \phantomsection\label{module_doc:kafe.fit.Fit}\pysiglinewithargsret{\strong{class }\code{kafe.fit.}\bfcode{Fit}}{\emph{dataset}, \emph{fit\_function}, \emph{external\_fcn=\textless{}function chi2\textgreater{}}, \emph{fit\_name=None}, \emph{fit\_label=None}, \emph{minimizer\_to\_use='iminuit'}}{}