From e3a8e477bd6eae2f2e2749a4a50604cc71d9446c Mon Sep 17 00:00:00 2001 From: Valerio Mariani <valerio.mariani@desy.de> Date: Tue, 13 Aug 2019 14:58:22 +0200 Subject: [PATCH] Updated documentation --- cfelpyutils/crystfel_utils.py | 3 +- cfelpyutils/geometry_utils.py | 10 +- docs/_modules/cfelpyutils/crystfel_utils.html | 1 - docs/_modules/cfelpyutils/geometry_utils.html | 1 - docs/_modules/cfelpyutils/named_tuples.html | 1 - docs/_modules/index.html | 1 - ...tation_guidelines_for_contributors.rst.txt | 2 + docs/_sources/index.rst.txt | 5 +- docs/_sources/modules.rst.txt | 7 -- docs/cfelpyutils.crystfel_utils.html | 1 - docs/cfelpyutils.geometry_utils.html | 1 - docs/cfelpyutils.html | 1 - docs/cfelpyutils.named_tuples.html | 3 - ...mentation_guidelines_for_contributors.html | 3 +- docs/genindex.html | 1 - docs/index.html | 10 +- docs/modules.html | 114 ------------------ docs/objects.inv | Bin 508 -> 516 bytes docs/py-modindex.html | 1 - docs/search.html | 1 - docs/searchindex.js | 2 +- ...tation_guidelines_for_contributors.doctree | Bin 19892 -> 19892 bytes docs_src/_build/doctrees/environment.pickle | Bin 54740 -> 54547 bytes docs_src/_build/doctrees/index.doctree | Bin 12227 -> 12224 bytes docs_src/_build/doctrees/modules.doctree | Bin 2565 -> 0 bytes .../_modules/cfelpyutils/crystfel_utils.html | 1 - .../_modules/cfelpyutils/geometry_utils.html | 1 - .../_modules/cfelpyutils/named_tuples.html | 1 - docs_src/_build/html/_modules/index.html | 1 - ...tation_guidelines_for_contributors.rst.txt | 2 + docs_src/_build/html/_sources/index.rst.txt | 5 +- docs_src/_build/html/_sources/modules.rst.txt | 7 -- .../html/cfelpyutils.crystfel_utils.html | 1 - .../html/cfelpyutils.geometry_utils.html | 1 - docs_src/_build/html/cfelpyutils.html | 1 - .../_build/html/cfelpyutils.named_tuples.html | 3 - ...mentation_guidelines_for_contributors.html | 3 +- docs_src/_build/html/genindex.html | 1 - docs_src/_build/html/index.html | 10 +- docs_src/_build/html/modules.html | 114 ------------------ docs_src/_build/html/objects.inv | Bin 508 -> 516 bytes docs_src/_build/html/py-modindex.html | 1 - docs_src/_build/html/search.html | 1 - docs_src/_build/html/searchindex.js | 2 +- docs_src/_templates/localtoc.html | 13 ++ ...umentation_guidelines_for_contributors.rst | 2 + docs_src/index.rst | 5 +- 47 files changed, 45 insertions(+), 300 deletions(-) delete mode 100644 docs/_sources/modules.rst.txt delete mode 100644 docs/modules.html delete mode 100644 docs_src/_build/doctrees/modules.doctree delete mode 100644 docs_src/_build/html/_sources/modules.rst.txt delete mode 100644 docs_src/_build/html/modules.html create mode 100644 docs_src/_templates/localtoc.html diff --git a/cfelpyutils/crystfel_utils.py b/cfelpyutils/crystfel_utils.py index ac7b96b..ba3c8fe 100644 --- a/cfelpyutils/crystfel_utils.py +++ b/cfelpyutils/crystfel_utils.py @@ -361,7 +361,7 @@ def load_crystfel_geometry(filename): This function is a reimplementation of the get_detector_geometry_2 function from CrystFEL. It reads information from a CrystFEL geometry file. - + For a full documentation of the CrystFEL geometry format, see the relevant `man page <http://www.desy.de/~twhite/crystfel/manual-crystfel_geometry.html>`_. @@ -375,7 +375,6 @@ def load_crystfel_geometry(filename): * The code of this function is currently synchronized with the code of the function 'get_detector_geometry_2' in CrystFEL at commit 41a8fa9819010. - Arguments: filename (str): the absolute or relative path to a CrystFEL geometry file. diff --git a/cfelpyutils/geometry_utils.py b/cfelpyutils/geometry_utils.py index 0efdb03..e2c4e55 100644 --- a/cfelpyutils/geometry_utils.py +++ b/cfelpyutils/geometry_utils.py @@ -134,7 +134,7 @@ def compute_visualization_pix_maps(geometry): This function takes as input some geometry information read from a `CrystFEL <http://www.desy.de/~twhite/crystfel/manual-crystfel_geometry.html>`_ file, and returns a set of pre-computed pixel maps that can be used to display data in an - ImageView widget from the `PyQtGraph <http://pyqtgraph.org/>`_ library. + ImageView widget (from the `PyQtGraph <http://pyqtgraph.org/>`_ library). These pixel maps are different from the ones generated by the :func:`~compute_pix_maps` function. The main differences are: @@ -187,9 +187,9 @@ def apply_geometry_to_data(data, geometry): the input data, and is symmetric around the center of the reference system (i.e: the beam interaction point). - This restrictions often cause the returned array to be bigger than the minimum size - needed to store the physical layout of the pixels in the detector, particularly if - the detector is not centered at the beam interaction point. + These restrictions often cause the returned array to be bigger than the minimum + size needed to store the physical layout of the pixels in the detector, + particularly if the detector is not centered at the beam interaction point. Arguments: @@ -202,7 +202,7 @@ def apply_geometry_to_data(data, geometry): Returns: numpy.ndarray: an array containing the data with the geometry information - applied. + applied. """ pixel_maps = compute_pix_maps(geometry) x_map, y_map = pixel_maps.x, pixel_maps.y diff --git a/docs/_modules/cfelpyutils/crystfel_utils.html b/docs/_modules/cfelpyutils/crystfel_utils.html index f114828..8d1f451 100644 --- a/docs/_modules/cfelpyutils/crystfel_utils.html +++ b/docs/_modules/cfelpyutils/crystfel_utils.html @@ -703,7 +703,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="../../cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/_modules/cfelpyutils/geometry_utils.html b/docs/_modules/cfelpyutils/geometry_utils.html index 61de150..32df1d9 100644 --- a/docs/_modules/cfelpyutils/geometry_utils.html +++ b/docs/_modules/cfelpyutils/geometry_utils.html @@ -270,7 +270,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="../../cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/_modules/cfelpyutils/named_tuples.html b/docs/_modules/cfelpyutils/named_tuples.html index 5c11e47..f12c4e8 100644 --- a/docs/_modules/cfelpyutils/named_tuples.html +++ b/docs/_modules/cfelpyutils/named_tuples.html @@ -94,7 +94,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="../../cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/_modules/index.html b/docs/_modules/index.html index a28cdf2..0426bf5 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -56,7 +56,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="../cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="../documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/_sources/documentation_guidelines_for_contributors.rst.txt b/docs/_sources/documentation_guidelines_for_contributors.rst.txt index bcdb3cb..60bcb63 100644 --- a/docs/_sources/documentation_guidelines_for_contributors.rst.txt +++ b/docs/_sources/documentation_guidelines_for_contributors.rst.txt @@ -1,3 +1,5 @@ +:orphan: + Guidelines for Contributors =========================== diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index a3b5c6e..ef4ad25 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -3,14 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -CFELPyUtils -=========== +The CFELPyUtils Library +======================= .. toctree:: :hidden: cfelpyutils - documentation_guidelines_for_contributors Introduction diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt deleted file mode 100644 index 31f2701..0000000 --- a/docs/_sources/modules.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -cfelpyutils -=========== - -.. toctree:: - :maxdepth: 4 - - cfelpyutils diff --git a/docs/cfelpyutils.crystfel_utils.html b/docs/cfelpyutils.crystfel_utils.html index 58736df..d162d9e 100644 --- a/docs/cfelpyutils.crystfel_utils.html +++ b/docs/cfelpyutils.crystfel_utils.html @@ -95,7 +95,6 @@ file.</td> <li class="toctree-l2"><a class="reference internal" href="cfelpyutils.named_tuples.html">named_tuples</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/cfelpyutils.geometry_utils.html b/docs/cfelpyutils.geometry_utils.html index a474102..411b8e2 100644 --- a/docs/cfelpyutils.geometry_utils.html +++ b/docs/cfelpyutils.geometry_utils.html @@ -161,7 +161,6 @@ applied.</p> <li class="toctree-l2"><a class="reference internal" href="cfelpyutils.named_tuples.html">named_tuples</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/cfelpyutils.html b/docs/cfelpyutils.html index e7a0d92..24ffb50 100644 --- a/docs/cfelpyutils.html +++ b/docs/cfelpyutils.html @@ -70,7 +70,6 @@ <li class="toctree-l2"><a class="reference internal" href="cfelpyutils.named_tuples.html">named_tuples</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/cfelpyutils.named_tuples.html b/docs/cfelpyutils.named_tuples.html index 377126c..66a4c7c 100644 --- a/docs/cfelpyutils.named_tuples.html +++ b/docs/cfelpyutils.named_tuples.html @@ -16,7 +16,6 @@ <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - <link rel="next" title="Guidelines for Contributors" href="documentation_guidelines_for_contributors.html" /> <link rel="prev" title="The geometry_utils Module" href="cfelpyutils.geometry_utils.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -119,7 +118,6 @@ pixel, the center of the reference system, and the x axis.</li> <li class="toctree-l2 current"><a class="current reference internal" href="#">named_tuples</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> @@ -128,7 +126,6 @@ pixel, the center of the reference system, and the x axis.</li> <li><a href="index.html">Documentation overview</a><ul> <li><a href="cfelpyutils.html">The cfelpyutils Package</a><ul> <li>Previous: <a href="cfelpyutils.geometry_utils.html" title="previous chapter">The geometry_utils Module</a></li> - <li>Next: <a href="documentation_guidelines_for_contributors.html" title="next chapter">Guidelines for Contributors</a></li> </ul></li> </ul></li> </ul> diff --git a/docs/documentation_guidelines_for_contributors.html b/docs/documentation_guidelines_for_contributors.html index 81baa5a..1791906 100644 --- a/docs/documentation_guidelines_for_contributors.html +++ b/docs/documentation_guidelines_for_contributors.html @@ -16,7 +16,6 @@ <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - <link rel="prev" title="The named_tuples Module" href="cfelpyutils.named_tuples.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -104,7 +103,7 @@ Python.</li> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> - <h3><a href="index.html">Table of Contents</a></h3> + <h3><a href="index.html">CFELPyUtils</a></h3> <ul> <li><a class="reference internal" href="#">Guidelines for Contributors</a><ul> <li><a class="reference internal" href="#version-control">Version Control</a></li> diff --git a/docs/genindex.html b/docs/genindex.html index 19e0c10..c2a43c1 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -147,7 +147,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/index.html b/docs/index.html index 6e91902..1b1aac8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -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>CFELPyUtils — CFELPyUtils 1.0.0 documentation</title> + <title>The CFELPyUtils Library — CFELPyUtils 1.0.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" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> @@ -33,8 +33,8 @@ <div class="body" role="main"> - <div class="section" id="cfelpyutils"> -<h1>CFELPyUtils<a class="headerlink" href="#cfelpyutils" title="Permalink to this headline">¶</a></h1> + <div class="section" id="the-cfelpyutils-library"> +<h1>The CFELPyUtils Library<a class="headerlink" href="#the-cfelpyutils-library" title="Permalink to this headline">¶</a></h1> <div class="toctree-wrapper compound"> </div> <div class="section" id="introduction"> @@ -97,9 +97,9 @@ to the project:</p> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> - <h3><a href="#">Table of Contents</a></h3> + <h3><a href="#">CFELPyUtils</a></h3> <ul> -<li><a class="reference internal" href="#">CFELPyUtils</a><ul> +<li><a class="reference internal" href="#">The CFELPyUtils Library</a><ul> <li><a class="reference internal" href="#introduction">Introduction</a></li> <li><a class="reference internal" href="#installation">Installation</a></li> <li><a class="reference internal" href="#authors">Authors</a></li> diff --git a/docs/modules.html b/docs/modules.html deleted file mode 100644 index c6b1e68..0000000 --- a/docs/modules.html +++ /dev/null @@ -1,114 +0,0 @@ - -<!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" lang="en"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>cfelpyutils — CFELPyUtils 1.0.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" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.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> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="cfelpyutils"> -<h1>cfelpyutils<a class="headerlink" href="#cfelpyutils" title="Permalink to this headline">¶</a></h1> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="cfelpyutils.crystfel_utils.html">crystfel_utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="cfelpyutils.geometry_utils.html">geometry_utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="cfelpyutils.named_tuples.html">named_tuples</a></li> -</ul> -</li> -</ul> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">CFELPyUtils</a></h1> - - - - - - - - -<h3>Navigation</h3> -<ul> -<li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a></li> -</ul> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3>Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" /> - <input type="submit" value="Go" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2019, OnDA Team. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs/objects.inv b/docs/objects.inv index 4a820253d6ecab3d4028bc2d93308bcfad0ecf29..a7f57df54099dbcb716c8510407aa5ef15984664 100644 GIT binary patch delta 379 zcmV->0fhei1B3*Sl7CVwA#FQHY2re(K%yi}q)$H}v?Y|%P8&C{e}BI*iRm7Ma;4?M zAmvuMWTgP~gy=cG$ZReid?tQGan#RI?ToG8@iZco{erj<k}!OVr66;#+BHV|vY?jB z0xfS^4Ly#S8(oL8$*u=dqLgr_Zn2e^5lbez9<#dPL1nH=3x8Pg3g<+bdFbEVltl0Y zX|Vt0RgfGQwxtqqefoXT<m>}s!YdHlu0<+{F@ydtvG?&7D&q~4SgZN29?gGo^(@qC z7OI<tdiWC+8Ov5oQWP&Q))xB6pdUmDp<g70sU3C&H?mheJ*?igXLM@YT;Y%0o0dPQ z9^nVK=?eW~igYbIsO-pfahXG5{e@3U&Oq=24BktPsVw|ok~*-uyU2ULo&=~Cpmk3W zrBLvKLDk{~*@0*bj!|F#);vaMS=U8R(R|(d<$061&vtAZzSBgzs9qr>bmih>!k7D5 ZbUp@%rde3wV_y93^GS2AegL4`!s@Bzy*U5? delta 371 zcmV-(0gV2H1pEV#l7G@FA#FQHY2wmoA&E#bL7#p=XiF&2PAfOCe}BJYi0KZ5E}iAV zAYHC9#hd{2gy=cG*xO7z_)PqW;;5UWd1-9*j;9f!><`3+P=w)AECrQ;&CA+o=OndU zNwmCb)%Q4Ju5=yBCcExQiPoY#b&IXSj94<!^^nyS52`ZlEPr6l3!D*c=Ar*^<A~q~ zQe*GsB}oPhTc-t#ProagoP8incmZP5wnzmrrq|yk_BP%^?|IE6*5-U$jpkn5d=_dk z3$>hudiWO=8Ov5oQ4}vP))xBQLpO*LLcd80Q#)(~H?UVcJ*?g||LD}V8Q~Ayn}*-3 z9^ePJX@q_;#cYNhRJP=**kvHCzwoK!3<Q^8@J{8JD(SzH$^)yLi@f*iNq{N=T6Y9d z3X)3(MS~Y)3!*kSMt%KT{TQ8PZ5JKI`sMjODZlEoN7dRGAnGzcCVYuMf6F#Na=H&I Re9VhKd_JlFrC*iVzO>BRwYdNQ diff --git a/docs/py-modindex.html b/docs/py-modindex.html index b250e79..02294c3 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -88,7 +88,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/search.html b/docs/search.html index e7b25fc..a117965 100644 --- a/docs/search.html +++ b/docs/search.html @@ -83,7 +83,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs/searchindex.js b/docs/searchindex.js index 2f17d5d..ab1eb8a 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["cfelpyutils","cfelpyutils.crystfel_utils","cfelpyutils.geometry_utils","cfelpyutils.named_tuples","documentation_guidelines_for_contributors","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["cfelpyutils.rst","cfelpyutils.crystfel_utils.rst","cfelpyutils.geometry_utils.rst","cfelpyutils.named_tuples.rst","documentation_guidelines_for_contributors.rst","index.rst"],objects:{"":{cfelpyutils:[0,0,0,"-"]},"cfelpyutils.crystfel_utils":{load_crystfel_geometry:[1,1,1,""]},"cfelpyutils.geometry_utils":{apply_geometry_to_data:[2,1,1,""],compute_pix_maps:[2,1,1,""],compute_visualization_pix_maps:[2,1,1,""]},"cfelpyutils.named_tuples":{PixelMaps:[3,2,1,""]},"cfelpyutils.named_tuples.PixelMaps":{phi:[3,3,1,""],r:[3,3,1,""],x:[3,3,1,""],y:[3,3,1,""],z:[3,3,1,""]},cfelpyutils:{crystfel_utils:[1,0,0,"-"],geometry_utils:[2,0,0,"-"],named_tuples:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute"},terms:{"41a8fa9819010":1,"class":[3,5],"float":[],"function":[1,2,5],"int":[],"new":[],"return":[1,2],For:[1,5],The:[4,5],These:2,absolut:1,accord:2,activ:4,adjust:[],alia:3,all:[2,4],along:2,also:5,amplitud:3,anaconda:5,andrew:5,angl:3,ani:[1,2],anton:5,appli:[2,4,5],apply_geometry_to_data:2,around:2,arrai:2,assum:[],avail:[2,5],awai:2,axi:3,barti:5,base:3,beam:2,been:[],befor:4,between:3,big:2,bigger:2,binari:4,black:4,both:4,branch:4,c99:4,can:[2,4,5],caus:2,ceil:2,center:[2,3,5],centos7:4,cfel:5,cfelpyutil:[3,4],channel:[],chapman:5,check:5,code:[1,4],collect:3,com:[],come:4,command:5,commit:1,commonli:4,compat:4,compil:4,complet:2,comput:2,compute_min_array_s:[],compute_pix_map:2,compute_visualization_pix_map:2,conda:5,connect:[],contain:[0,1,2,3,5],contribut:[4,5],convent:2,convert:[],coordin:[2,3],corner:2,correspond:[1,5],creat:4,crystfel:[1,2],crystfel_util:0,current:[1,4,5],cython:4,data:[2,5],describ:[],desi:5,detector:[2,5],develop:[4,5],dict:[1,2],dictionari:[1,2],differ:[2,5],direct:2,displai:2,displayedus:[],distanc:3,distribut:5,doc:[],docstr:4,document:1,documentation_guidelines_for_contributor:[],driessen:4,each:3,electron:5,enough:2,ensur:4,entri:2,exampl:4,except:4,extens:4,facil:4,feel:4,field:3,fifth:[],file:[1,2,4],filenam:1,find:4,first:[],flow:4,folder:4,follow:4,fork:[],format:1,formatt:4,found:5,fourth:[],free:[4,5],from:[1,2,3,5],full:1,futur:4,gcc:4,gener:2,geometri:[1,2,3,5],geometry_util:0,get_detector_geometry_2:1,git:4,gitflow:4,github:4,googl:4,guid:4,hamburg:5,hand:2,has:[],henri:5,here:[4,5],how:4,howev:4,http:[],imag:5,imageview:2,implement:[],index:5,inform:[1,2,3,5],input:2,instead:[],institut:5,interact:2,interfac:4,intern:5,introduct:[],iso:4,just:[],kei:1,known:4,lab:5,languag:[1,4],laser:5,layout:2,lcsl:4,left:2,librari:[0,2,3,4,5],like:2,link:[],lint:4,linux:4,load:1,load_crystfel_geometri:[1,2],main:[0,2],mainli:4,make:[],man:1,mani:5,manipul:2,manual:5,map:[2,3],mariani:5,match:1,matplotlib:2,minimum:2,model:[],morgan:5,most:4,mostli:5,must:4,name:[2,3],named_tupl:0,ndarrai:[2,3],need:2,none:2,note:[],number:3,numpi:[2,3],nvie:[],object:2,often:2,onda:4,ondateam:5,one:4,ones:2,onli:2,order:4,org:[],orient:2,origin:2,other:2,out:5,packag:[1,5],page:1,paramet:[1,2,3],part:4,particularli:2,path:1,peopl:5,perform:[4,5],phi:[2,3],physic:2,pip:5,pixel:[2,3],pixel_map:[],pixelmap:[2,3],platform:4,pleas:[4,5],point:2,possibl:4,post:[],pre:2,prepar:[],process:5,program:4,project:[4,5],propos:4,provid:[],pull:4,pylint:4,pylintrc:4,pypi:5,pyqtgraph:2,python2:5,python3:5,python:[1,5],rai:5,read:[1,2,5],readi:[],reason:4,refer:[2,3],reimplement:1,rel:1,relat:5,releas:5,relev:1,repositori:[4,5],request:4,requir:4,respect:[],restrict:2,result:[],rhel7:4,right:2,root:4,run:[4,5],same:2,scienc:5,scm:[],see:[1,4,5],set:[2,4],setup:5,sever:5,shape:2,should:[2,4],size:2,softwar:[1,5],some:[1,2,4],sourc:[1,2],specif:4,stack:4,standard:4,state:4,store:[1,2,3],str:[1,2],strategi:4,stro:[],style:4,submiss:4,submit:4,submodul:[],success:[],support:[4,5],suppos:[],symmetr:2,sync:[],synchron:1,system:[2,3,4],take:2,task:5,test:5,than:2,thi:[1,2,3],third:[],thoma:5,three:[],through:[],throughout:3,top:2,toward:2,tupl:[2,3],twhite:[],two:4,type:[1,2],use:4,used:[2,3,4,5],uses:[1,4],using:[2,4,5],util:[1,2,5],valerio:5,valu:[1,2],variou:5,vector:[],vincent:4,visual:2,welcom:[4,5],wheel:4,when:4,which:[0,2],white:5,whole:0,widget:2,work:[],worlwid:5,write:4,written:[4,5],wth:[],www:[],zenith:2},titles:["The cfelpyutils Package","The crystfel_utils Module","The geometry_utils Module","The named_tuples Module","Guidelines for Contributors","CFELPyUtils"],titleterms:{The:[0,1,2,3],author:5,cfelpyutil:[0,5],code:5,contributor:[4,5],control:4,crystfel_util:1,document:5,geometry_util:2,guidelin:[4,5],instal:5,introduct:5,modul:[1,2,3],named_tupl:3,packag:0,python:4,thecfelpyutil:[],version:4}}) \ No newline at end of file +Search.setIndex({docnames:["cfelpyutils","cfelpyutils.crystfel_utils","cfelpyutils.geometry_utils","cfelpyutils.named_tuples","documentation_guidelines_for_contributors","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["cfelpyutils.rst","cfelpyutils.crystfel_utils.rst","cfelpyutils.geometry_utils.rst","cfelpyutils.named_tuples.rst","documentation_guidelines_for_contributors.rst","index.rst"],objects:{"":{cfelpyutils:[0,0,0,"-"]},"cfelpyutils.crystfel_utils":{load_crystfel_geometry:[1,1,1,""]},"cfelpyutils.geometry_utils":{apply_geometry_to_data:[2,1,1,""],compute_pix_maps:[2,1,1,""],compute_visualization_pix_maps:[2,1,1,""]},"cfelpyutils.named_tuples":{PixelMaps:[3,2,1,""]},"cfelpyutils.named_tuples.PixelMaps":{phi:[3,3,1,""],r:[3,3,1,""],x:[3,3,1,""],y:[3,3,1,""],z:[3,3,1,""]},cfelpyutils:{crystfel_utils:[1,0,0,"-"],geometry_utils:[2,0,0,"-"],named_tuples:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute"},terms:{"41a8fa9819010":1,"class":[3,5],"function":[1,2,5],"return":[1,2],For:[1,5],The:4,These:2,absolut:1,accord:2,activ:4,alia:3,all:[2,4],along:2,also:5,amplitud:3,anaconda:5,andrew:5,angl:3,ani:[1,2],anton:5,appli:[2,4,5],apply_geometry_to_data:2,around:2,arrai:2,avail:[2,5],awai:2,axi:3,barti:5,base:3,beam:2,befor:4,between:3,big:2,bigger:2,binari:4,black:4,both:4,branch:4,c99:4,can:[2,4,5],caus:2,ceil:2,center:[2,3,5],centos7:4,cfel:5,cfelpyutil:[3,4],chapman:5,check:5,code:[1,4],collect:3,come:4,command:5,commit:1,commonli:4,compat:4,compil:4,complet:2,comput:2,compute_pix_map:2,compute_visualization_pix_map:2,conda:5,contain:[0,1,2,3,5],contribut:[4,5],convent:2,coordin:[2,3],corner:2,correspond:[1,5],creat:4,crystfel:[1,2],crystfel_util:0,current:[1,4,5],cython:4,data:[2,5],desi:5,detector:[2,5],develop:[4,5],dict:[1,2],dictionari:[1,2],differ:[2,5],direct:2,displai:2,distanc:3,distribut:5,docstr:4,document:1,driessen:4,each:3,electron:5,enough:2,ensur:4,entri:2,exampl:4,except:4,extens:4,facil:4,feel:4,field:3,file:[1,2,4],filenam:1,find:4,flow:4,folder:4,follow:4,format:1,formatt:4,found:5,free:[4,5],from:[1,2,3,5],full:1,futur:4,gcc:4,gener:2,geometri:[1,2,3,5],geometry_util:0,get_detector_geometry_2:1,git:4,gitflow:4,github:4,googl:4,guid:4,hamburg:5,hand:2,henri:5,here:[4,5],how:4,howev:4,imag:5,imageview:2,index:5,inform:[1,2,3,5],input:2,institut:5,interact:2,interfac:4,intern:5,iso:4,kei:1,known:4,lab:5,languag:[1,4],laser:5,layout:2,lcsl:4,left:2,librari:[0,2,3,4],like:2,lint:4,linux:4,load:1,load_crystfel_geometri:[1,2],main:[0,2],mainli:4,man:1,mani:5,manipul:2,manual:5,map:[2,3],mariani:5,match:1,matplotlib:2,minimum:2,morgan:5,most:4,mostli:5,must:4,name:[2,3],named_tupl:0,ndarrai:[2,3],need:2,none:2,number:3,numpi:[2,3],object:2,often:2,onda:4,ondateam:5,one:4,ones:2,onli:2,ontribut:[],order:4,orient:2,origin:2,other:2,out:5,packag:[1,5],page:1,paramet:[1,2,3],part:4,particularli:2,path:1,peopl:5,perform:[4,5],phi:[2,3],physic:2,pip:5,pixel:[2,3],pixelmap:[2,3],platform:4,pleas:[4,5],point:2,possibl:4,pre:2,process:5,program:4,project:[4,5],propos:4,pull:4,pylint:4,pylintrc:4,pypi:5,pyqtgraph:2,python2:5,python3:5,python:[1,5],rai:5,read:[1,2,5],reason:4,refer:[2,3],reimplement:1,rel:1,relat:5,releas:5,relev:1,repositori:[4,5],request:4,requir:4,restrict:2,rhel7:4,right:2,root:4,run:[4,5],same:2,scienc:5,see:[1,4,5],set:[2,4],setup:5,sever:5,shape:2,should:[2,4],size:2,softwar:[1,5],some:[1,2,4],sourc:[1,2],specif:4,stack:4,standard:4,state:4,store:[1,2,3],str:[1,2],strategi:4,style:4,submiss:4,submit:4,support:[4,5],symmetr:2,synchron:1,system:[2,3,4],take:2,task:5,test:5,than:2,thi:[1,2,3],thoma:5,throughout:3,top:2,toward:2,tupl:[2,3],two:4,type:[1,2],use:4,used:[2,3,4,5],uses:[1,4],using:[2,4,5],util:[1,2,5],valerio:5,valu:[1,2],variou:5,vincent:4,visual:2,welcom:[4,5],wheel:4,when:4,which:[0,2],white:5,whole:0,widget:2,worlwid:5,write:4,written:[4,5],zenith:2},titles:["The cfelpyutils Package","The crystfel_utils Module","The geometry_utils Module","The named_tuples Module","Guidelines for Contributors","The CFELPyUtils Library"],titleterms:{The:[0,1,2,3,5],author:5,cfelpyutil:[0,5],code:5,contributor:[4,5],control:4,crystfel_util:1,document:5,geometry_util:2,guidelin:[4,5],instal:5,introduct:5,librari:5,modul:[1,2,3],named_tupl:3,packag:0,python:4,version:4}}) \ No newline at end of file diff --git a/docs_src/_build/doctrees/documentation_guidelines_for_contributors.doctree b/docs_src/_build/doctrees/documentation_guidelines_for_contributors.doctree index a5446767a2c64afa17aadb39889320d78fe0f147..2795e8537dcec6ea31215d4f04779f2a532f6186 100644 GIT binary patch delta 397 zcmY+9ze@sP7{__;?maHfqOQBntS$|IG^C{tl8`6qV3?3&izO9_Qc*;MQ-6VjPeUM7 z66MfP@S0oDPbg?;Z)=Z&=CBuWu<haV`95Esr(S`21+K0E1loWy4<gQyLy+kQS>vFa zCZrG#y|^!DK*lsN@K;_2jb<z+2Rc3K@d_}AugV!Qa<;sQZ;BO5{o7zKt9h_vL4C$s zO@Ja39$eD0;KV!al(<;<98Z)nY<ea9(p0PstPnS&Hyu<&Qx6g+qea|Or?936!JzMY zK_KG{ezv0?dN6DgV1i!St%5ko%qoXf#lgDWRCPT{Vt}#Z7NbqCkB4dW`FGgeReyqL zxy2;3KC=YYAwqWpPXa_~IP}7aakh8Cx4R@XqN6k&zURaQ;}8FNcBaI^JpDFBUR+@M mr&IUghCc{#%*T=t!A5Ko1a#O&=xltbi;bC-4p!VtMg9QNQ+<a3 delta 397 zcmY+9ze@sP7{__;?mbQvq4UlYvrCN>f)jrXf|wT?VTplbizO9_Qc*-hQ-6VjPeUM7 z66MfP@S0oDPbg?;Z)=Z&=CBuWu<haVdA?tsr`>>d1Fo(CINE_a4+74TL$J^fvdV## zW~Dd}cHFlX!GZ;%<F9oI9JFXNIZ)}5-4H;-SNV*1%I=DZZ?X$(jxEsZN(FSRD$m5r z#2yntTvSWo$2;|uj4^hOC$b;AhJ;_Lf-UDV-l_uJ3{VkGEk^vk{H7AdmKFmKeb=f2 z2{8ECUk%a&k6VBVdg*luqQT4xhfUeXx&u@hf0V>9W5+#4yGDqIIEEtI?CxeHOC05e z9P~c3Mb{unccM=Mq-Y}k!ii~?yWsm>66#Z<w2-*x#2LmP{`1mgje|M*ZHl}&&-Blr k9>VoV4ANN1<RFQi%m#4ibC1yU^st4E#k>Yi+|8%{0EP>FJpcdz diff --git a/docs_src/_build/doctrees/environment.pickle b/docs_src/_build/doctrees/environment.pickle index b8ee0ab9479772890454c5d87da8fc1f9540c191..01fbaf40c43724d6e92092440e09687a7f8e1f1b 100644 GIT binary patch delta 6243 zcmc&&eQZ-z6z9P{7#o6<veB`v>wvWk24x!{C}Vc48QliNDQLjbbr;&pqb=<#IvN;g zgqS>|c%T1BB${Y~Y>+IAA0ZJ@kp!Zm5fy?TKs3S6EHTl51U&b?wy%A+r6WQ3=f3vb z^E>a{-#Pc(^X{4cG34NwoSiu@j~&d(tt49<MzZ(*S>#w{dA^+M^Y@^qNVw9R+y8d; zr+qJ3%L^RM-*)xCZ8^0PRH{I1GyOn<j<T4%K4%Gqm#A6|E8fS^(W6Gue*<&3qwA!@ zbcva7sFLoH^8%ru*X>ul(J+pZgH>I^0dk|NPB=vB%r!zkdDQGP9t5~`m$F^4;6w1! z8^wp=u};B*WPfc9s0!6plimdpJ^@3d+l}9YC#aKSGp9D-kC<`<AEz3hFb%wu{=SLb z;B0F5aNO=0h8lt0U0Lipr%eaDTc%a2{$3iX-KVqIb=j<7*JZ0RU`E6+Z@4cl5i~S6 zAp&OQk}fYY*;|*juk3w9@`+(nyRSRs4)rR}Dq2u7YpD)hADtfy4cR|!X&;NlTg=Ib zJWdSwH%dN9L}3=>9n`0OI`q+j22~9h4FhHrQ{pfqg|3t(7`_g_B65xt@FbZz07AL2 zJ0glma*4jMq!7irYf_qIIzTSYC><M5Fe216&X4~A8<1_xR6z)BKq2J!AZ93yok7Ul z@)^n8;CHBxEG{);xC9-IKO(}cGIF`bFrCsOC%r-inR(DSEtsTfUg;`kd@9q!li`te zyHvu2oDcj+A(YYmq^(0eJ8d~uxC(H%iw>*FD^{0qoLsfK)C6t<scyr~)m-DaSJ$KZ ziIR6|T`H)6M#|-r&}K!2l<@D-<+I2%)Qri<Kp7~drKT#=#EeW6toBsU48flz!ut$! zBBf5K;hkH-GJXNfs|(u6Yu2Q2fR`k6w`bK2Cv>;*y6K5x74Xgw1;tb)>U@Hz!@QgE zeemaOgPyE@UOOXM2eRsFWWCAjrYDQloI67noDeEmza+>y$GaIP>!&#!S>N#58Oi!8 ztFA`Y7rbtIvRGNZWwI>z*7u+=2uGe(rR$#rT{$^iO^VaCbpE|$*p{QuFM&tsmZojS z>x_nsMb?6EPmRfoH8>~dmDkcDBTsk~g~Gmo-((N?rBFbO6~=1bb#1Z5WNrN<{bEf# zB4d7(^SU}>wEQqK-P^Q$b@g=Jc`JJ*Z@`~uHq4BTxKu5s4&KdV5-v0p>Pcwf5gAEn z=5_Bh3Ay$;_S)J62Zv0QnV3+eU=#18MuAbkd@rw^arr2#u097+PIjGLdQ7Vxs~hQN zx|-d8M_PMWJ9|fJPs<>U!H9ZeoSRtm8#*#8>kS2XJWNA>Ie|1UDHEdPf-SaZrzc>q z^RV>^7(>TCZ%hfueg?Toow9>!+FmH$0fKL<QePtH1>Mm5N(yVZ<$U-V@<G$SPU(~j zJsXf1?2XVb1ZB74mWzCTj~MAe8+^2{hxMHVkKAOxbrvaDG-o2~haRHtdSH;}?_D(; zvro;s5H#r+fzVl?X37zDDYvJv#_H;ii;NalNs8KNIqivfBq*-2qI#aEn~T!L2Mi>* zc)Yr^v`C%hp>?Swa*_I)hxDa|7%5w<)BhhBq1g;vgeA8qx*Hi8$=@*AToO+=c+b=D zWY%+ZjfZ99=n4<HOC04lN8mgPg_YVAdJ<waK-IaaJxIEJzHUjmo*5Gl%f?JO54lUs z6x#zm$kY<>G)Fc=WpML3l+Z|0Q2BE3tKc%}*CvaeuNEGbjjv`Na+mljb3}YSNc8!M zXq%dHd$Wo6kz+$?w&~gM@~~`dppioKwMRR*A+^)L#gHgh>RB`bi1wC!{Dz;LwkR5i z(cT27=Hqtf#-xi1csF9FRQ%wH$P?K~<dOoe5bBQj#2$8eLoqMF%_6;YdXe37X#ZBH z%+d3U&P9o-<t^b|a;oL&DflSBwkvoAJe+X*G#aaSPea7JY??4co?o`0l=dXgMKqOQ zFMIJ2`EHqG>^TU)Zbi0{*PKSO{^Js|wzaVU$E3AnORJH**LpS~F_SMH=AjQ9^M$3K z1Cm~eo`t9CzBlTPJ_l##c_yKEXK~2|CZV7FamjDFq_NEm9<FJtfpKTsgF-Pm+BRFb zkNn=YU}6b;f8bI&Ore93)Gwd0&;UOzICV-c>VU&jM5Z=+O{_?8C8*QDX0mtrB%cMq zaC4j1M&ZNA9rAchE8QDWS`$_P?}4tOdyfLwg>HYqFS@%CG#ZqEV(K9sywTkXHj#Ur zlk@1?u!YQY28D%WpR)_bVP~uHd*Hzv?UWS6E)>@(77Jbos&X}B+TY#?if^<pExHs} zgn2UD-dXf>vS4{ftMPJNfY^<sW~vH8R7y^C)Pt$39Suc)#1*NjMV+SN;UoclcS(pG z>ntt$D@jaV?5rsIJ6Uj~v!eJ)l7IoXQQ&>o;$p;ZL?Pj$#IV9HxP~5E(Y#jJO7`_n zhw;Py>cv|D=6u3=VvizEa6vB@Mz9@%BHD`Jdy-9_bY5nY9xw82a&^0VTpPmSFieul yfpW0&;D8avH3JneJ~;q(hh80MGLKim70w+1t{}D#D#lPq;pu8nm~;Bgy#D}%Hv@A3 delta 7041 zcmcgxeQZ<L70)BFN$QlZE(8)1+xfsw?GQc^A_6T5353KX4TEmeN@u+|FR||&+q0iH zl8hRP7R2<nv7I+*t;AF&wFA<r>L`@88-i@wiZ&sJ+I4G(Cbn*^rgl?>_R&_AcJ96Y zc+au(Y8d=;uYK-0zkBZQoO|x|HJmPfb*8xFV99qcKVM?9LW9)}H(#wPRZM}<h_qjY zi`E*Dt#;G#aXB#vL)&Z0db?iVdwhK22O%7@n@-lgAv^(MQ#F&H`qe8-L(pP(S5mE0 z?;d$;Kbc%mR7Ag>e*S{{4H&Tf*+llE2p+M^3&<o~x9=66f%SE3gc%U)9KtC$S{JA~ zi5g9Z)B~!M%-~1=6nPfAM^*A1oNzf%wYA<}eHKOJ7udvyMRE>%s(zm7!HKq2&2chI zHGa-C$U*vf9^9YQQ`{T%_C*Z$8nZ%NSh~7%4Fyt6azGABYJ8X+GQb*bXhbZf!OF4z zHXqjG23TTe6Q!opzL+q_KGcHwvmB#j&$CDzRV>{*w(lC6cvubuW9rw`49WTtKG~w; zB)gP_1f%nZZ2q`%PcR%BV~oUDoF1c7pQ25IHZ(4rbIK%VjPgL(dg&rqW)L=mQX+?a z8klErSg{PpgF#951_Lo!1-0oATwQHy(We7bETbCUfGmwOHC@&~iKA^}E}N({Dn+G` zPnv6kle0_{>uNx8lr~ax@&avG0NPWWphTZ>@S4NrW)UgNz;mPZd5sc0O_im-@OVV@ z$=-+<7004t#IJHwH!~%xvCFw7T5v#Fhy=<}Der3Z+k?Es*Z5QH;74ss;C1KA77=mC z2yMpTc#~I{g^!!Oe3Lzd(%hSDZPI&Pu(W<lId<lnq>(0Y+{BT0o+L};t4xEZSYAe4 zsFahcb@>K1<{Nkp8B$j6^}|V*jVHpdQNq0i=1Z>9gNd*ltnP|Nwqtrxk6RqeYvD*1 ztHHGHHw<+Tr**%cS2v3{Rs`=VZx`!rTi6ErLz=e>S>C>hBe>zN^X^Z)yTQA^z*R>z zyx&~GijOj9U%gxi7K1d}Zs&6&CUU!{g`AVlXLCatBk6V%KW`F6`76NxJKrn!`XyUP z9G6DCay$~0Vzz-WJl1e859E8eW}eRPWv%a@JZA6n?k4a4#k>EoKwfIe7s$UCg2f<> z0{M1s#6)iQw2*TG`BrWyW2Edr;^F7Ng+MyVEmSVNGc>u`))UZu9<fy=`a)ieBe?ZU ztb<FP74X`62ds6MY{-3#tu(SXJk6FfguJ=zB)6B$i!hGb+ag(Cvx#z`EdGoXjRnFX zTX#4lN5jG7;rf8lf{>6c>`W(aROKvo7#SrGII<ya(r#puB5qFZwKB`wq(#pP<-<HQ zA^XFj^bK$=V<{!&>l`+68p(0OWUD2cAg__(T!Qu)nWRp#M^KTwcZZlUb+>f8Txnt$ zFDP?RA)k2K$XCY8yKSY}yc{+%oXg9>Pim6QOXlJ=XOp)lOQ)_n@ul(YIgf41!_0K| z8F`qB+-auBul)tzL2ju8(nPm(59Rs6Ln_jB@nY5*DtTR8$-8Ra)$q<*48L_$36o%R ze~SMkYQq6e-_Hudp|v-8?^~OOc!{%=k02-6gQ}_9?TBt;r!M*PdrxOo%=jxq3dt&q zhO!VpMgvkzeN=T0Di+_U6pT#7*)POtb&&p`ubEaQr92Sw1>+;qXaMg7RG0h}oh5IV z!1tS4AhM}t3A^upnyw{=jk59EyPM&Un=FYqe)E)Zj(*1%czbnTw{CVxFYlvueI)La zvC8XrZ#j&1EZV?+ynRqmfRcfp?WoHR^uG(j$r<RIg+K(5z;v?QPYGtrxdU9nZ#Gx; zvZ9BK#$+)V6d9v@!WxtQ0x^H8CHdRAWe$H;1>tDcp4ljsg+L_k8h^CrEbNNo;TqMv zuXO3eoXf647Ql*5g1+x4_lO}MqSFhys+87?$+?o1BvXtYEC@d*$D8#K2{M1YH5hj! zM@!SMfR`V%4X`9#)*T*^Y&~ILd>o6IHdQ6P?*^_XQ+4-NXZBVfE(k|MK_*qbg+ScJ zt)6~cY~>kwv=Bd2$KXeu>#`}EE(j+lWrquan0I$)E;FAvc^lIOmY>E(5T9k$g;;YJ znHLKw^je5UIJ9jmUNkOk^CUE{bEqP*b6ax)qbRN{VF$BU4tt~0a6AwkVNapd@>_UT z(+ApP?13-yZA>>tPjfm(tIRPx)-~VYE8R~EXQ8I&@l}e6Rv!9VOCCZ+Pf=W1K=|YB zH8|hXAY6m%J?$$f$kBL4B{IRhxd!g-y`>*ubf;Bi9f+PPcxtv1p55MduVNm@^BZ5- zal{3?tyNI6<M(B0>6sfl_6eQ;Kuh}S`d{q%n*3A#siSz4`G`sA<8w+<WTraw%_}7- zH^YIQb?D(!I~~}*vhx9<70i9jLL0R9wJ+I(2Bd>Fn`yHJrutSV+8K&|NGTs+uG;$8 z-y||VqZ7Rb=|Qt2xRl`|c-x9eV$_EZy8S4`pQkw?Eqj=fZAcuG)C{5}<Btbi{i|H9 z)HT}pr>0f14L>NB$V4-8$N#foVmcA&hiHGq{CTQT&zN4|Y2#nF!im}Cu*c)7{TNyE zPYued#E8O_a-zF|&=|%6t!NZ}>}eAuc*oPZw3y9`%1$Ct)L!_~1uJ}R*Zt*Y%?NyR z*N)n<lt5x{|9V_IbiS|x%mW*Q2y_gzmM=~zJ4pm42W-ohX$1IDsf>PSa7B5AMhaI4 zYRgw>1s@L7F00lEnB64W-B+8EO6=bUeDIirhX=cb!)Klt?Aj+h32&Zm#8#N8-~1%1 zdcNTKB?fIVeTk1rxSj9`?8_3q7_h<1o_E-w&oBAD=p7bEyrZ#L3<tqGQ-df6W~#9L o-b^jFFU}zDnd>uK>&!|q-kVjhUvUcOp#Ms}aPCa#%G2im0T}t~*8l(j diff --git a/docs_src/_build/doctrees/index.doctree b/docs_src/_build/doctrees/index.doctree index eabd823eacd46babafe90b699e47c95d0c7fd58c..56825e815042cab977fbe72fa411cd0543e69799 100644 GIT binary patch delta 1979 zcma)7ZA@EL7~X+4yQRQdMrqfU_Lf2mY~VIc1jI##;`mrs6E-&&25ooA>0MVF=$)&M z2tS6!T%zW^Vm5<l;*`XMWoef9y|18iA<@N%KXr+^X*8N8Tb3mzp7-9ilq^pFoZI*7 zd7k$@AH6hqeo!~Ad;RPgox8Zj+D`?(v+IezU}|?V8XM*NqT!LyNJ^n=2NY_O|1A!k z#f!dxY>W&Gu|!J3Qe{#J$)(YFBqkjchNCfIRACTLg&?H6qo>qDhv6GTb6JEET1@Mx zkNSH}nG^aw#rmTxc!UKT%aYkZ1@lB;qoJReVBFBFe~sC%V7XZ?D7Q;tDrMG{aD>c) z%{WHp!R)MtjB%U(JytLaw~fc$A4#;9ek_-a2*bjN5RV84m0p5TR&0`6AyMLo3#Csp z1e1S7fRkm&5G)%f-^10ie#>`RVQ%!J1f+(x^2hYQGtX}*-jWmVEy!7h&&!9&9frX- z(4S>pI5bKXdVPxC7*kMK4!5qLM#{w38At_3)~wN*4N!l8@x2dIrk%tL9S%3#HmxTg zLW$W~$~qM>l_h)vTg_p!2Mz3*eua&S9Go(rA{_i^YsyP(D4<)0>53R>L)a!-L%sKt zxv8K|g0A&fjD4umBKEM)sv&GH$XteJDuZM%GSvMS!&a<=KP&r*o$b5}!WJ(lX&j?4 zZQ0^Vps{j<T5uy8CX_Lyp6cbd;B<)t=BjF7L)EQ{iF|5)g1mJPd0Cy{jMc^_c-rbv zCy1%)1edLcY$wqum|!+&f;roxFk|Z`6F5v;Zok`D|2b8t2I@B4FrGzji<n`bRVRBJ zCc`fKv@x$*yaLzl`^Z%$%gcSO)h$8H(akNP5Zw6B96|DvD!a+qjE7rXf+44aEWt6S zH-Bq7nEx`O*uT(FF5xFXD|Uv&FX30G>!B6uwM8sLyXwY{c=FjezdbaPOex2e>_|m5 z!y+1Bm(LABUYBRv&e-&-cgUf;ALD#AU(l=zzOD9hF66a{{5`0h%<KF=sE1s&M1ogc z?Odyd_3%Adk29<Xb68w%Ch&m!5z_^njP?lO)DrN#dnaj8Puwr=R&GdxJOJ0cTPpXX zk)LAk4t0-X{7n*rLC+9L!Fi91jKL3{cJ2kO?m0%<PSP+`(`Ay-r7`s|rWpL?t2D@@ zSwW)+uGu!_CyMd?Q0k449gy%wxr~N(Mpdz}S_M7`QpQ(%fK;5zN3>%u9)X#<p7LYN zox2$9h%u4&CFYXCAzFpE#l~J|`+!m}zQnw6*W<~lzl`cF%gieq@zp$<h(#mOq>>ij zfVX{{`4cQc1L8^cNwaGr7IYY79h_qwS`2fT#EjJ)VtfIf^h@1LzmV4<Ta#31D)=vH zie>+XLMV|s2NX4hFG%6DDVaa~Ek(qe@iopBzxX#}74IVT6rB_gvrQI7-04MnQQU}D zJuZ7OYd0?MqWKOkAD}sp%Pm}PvPF^&@z7x*nM$y~GBz<0(F1fUpaKWzVp_#at9Sv# z+P5aH0tHl%fJALrrs`>=lQg1<k?BSHsivd`sZ}NTfM`nI#9yisJb0=SaUnC?>?8jG DRAgv? delta 2026 zcmai#e{54#6vubFR{CSZ{&Z#i{bSvzTgOxalLZ!FGjmY4s1Pu7blY3*p0&<xb<Aae znZp7d$vn?L6wIPTBP4{GhCo2Yg%NZvOT-vw_{0AciP30GFh<aO?pt5mMCU*Ey?gGt zpYuKEo_F7;omV^6htzLe{7~&F_8PV|H|=N}d3vZXJ}A*u9TGLB^KI}<@ij|TG;Qea z72^FPN$z)8ib5(>U4B>+(j|R~?s&3C=<SOOgHnf7Mce6<0yL}t(1_GV>Fd_8sfN7> zl+a>YK|{2%)s#7)*;TB0nVI*q_0pG??H2R{qwXnUg0mhsjO%JNz-&{@$%ByNc@Rgk ziw>`SMH*uvHR&|W+8l6BZ-TJ?2APJt`Z00_t{8(bZP=jsfbE@zn}&%smy<L|KT7Kd zgkE7lNOTK5QY+!BBPFl0efLUoa$Fb@)|Vb4-@+B06K<4lw0*NI)tgm=D!{Y4QS&pi z{KSOXve^XlT$bR}>R$3E$DFfj9{M4z?urdkiT-$m-X4=sRF)jd+m_333L?fZymtTB zW<4n?lFJaKl~ES{G$f2Wi3O&d9=K_=kW283(OJS$7SWYCd<<o#E>i#}m^}RgGZyu5 z)bt+F!#Z<~A~~EFdkF^2aniuCOmfu<l9i+3#dy#%uZ^Neo45n+T5|Nd0{Rwf8`+zs zdsm=8jN4dOSmBnnkvMo~JZ1}MhvgVajA3UI!~rzqx~v}6WG>hmh<RLDQEH|s+eOkm z{AiiI>QdTDhlctGAFZwJ?(2zQvqyS_T7EECNd)jpUM_pibP^|dl^ll+_DM31m9%FM ze^Z_wUKRbCTiOdK!zP|b#Y)p}K~H$3eA1wtwzvQb<$K6iOkP0yrMzho+8r(0MOnvb zc-PTJzUT7I&WH~sE-x9=WUVwIWxoqH!8M3E14_iL%rcMc^3P=UHGC+AV?8B)4vS8A zo**6Ear(4671wV7uPaB}#%Qac&9x$J(&f#gdEuffp!Lc$e*tYfqq+Z&*5(e9VMw|g zw3}o`eF3A1G1eo)@-O+ptltBhJtpH-Oj^E=upk4_>Dfu@S$FN$b;;CyD!6B<=B?F% z7NtV1E&NE^y}ywJZ1?T+j^eU>d8#S9S8@kH?_=zPFz0K~jmgvz6--&(Q0aG(qtN7U zHV&g*7ShU`6L7-sP$g7QXRcO`3>P}!SAREY;r%}tXw{vUd6}Hb8MNe7KEXc#L-1K* zo>f-l4?x@xqZN-gA7JL}6)G;E&wnSe$d;2`G5P>rxOVoVC})?wc!XKuJD)F`-Fz;) zC3rDpA#cJ&Xx-)$$c~C9*(1e19WgKGc9t5-V`5qFMslSS-@#3|SWpV|pJAo2LStpD zj^!vQk_!J)F;qyM9a4cgbGve*id19*;pyUof3pbUUl`^XO^GkCju7M67T4*VSc9`L z4tvpSHxBRP^b`(fae4-aJ2?E#hGbfoh&?Y1jr6l0AuE!I^e8<R<=`m2p5n|D=S7jV zrzpiiQ4WbFsU5d*Jz<)nf-L4Zoui+~N`e@gE5W-?R`NE!aV6NKT!}c7c`Fhk{{UMA BcXt2) diff --git a/docs_src/_build/doctrees/modules.doctree b/docs_src/_build/doctrees/modules.doctree deleted file mode 100644 index 4199b5bab20782ad04d80ffa107ac54a88f857bf..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2565 zcmZ8jOK%%D5O!?qWm~f2G(99S(xM2OxUkg%Jp{e<){6mMlI9i=)RGbj?~+?SED30U z_Rt~*cq{v7d+NvC)moB(g_gtNJihs6xPKh}``=)%`h^kGnRha`*Ge;PW9TPA!Ig{u z#5aG&Pw{ma7`m|9n~cY>2aQa~oEfg-$0+tf&+^Pkty+E25na*y7++(v<D|>^##T7a zW;`!fmCu;epmq43FO$FR&A(#h9_G$Nx1@0BqBs+e#6jpb;Y`9|E)|axKc(S_I%nk6 zJEW1qK9I~J#L&xfYAu9#?<iW-Z++&=hsBg;w}#J>jt@OY=V>d7k$5JKlSlD9yd4W& z@bO(ijigGB-|3lKAgb|3LSukui8a}{(9GxDUK@*`U)=2bDe~-Rx+t|*Yy*%Qt8i*d zA=UDlGS(EL=XB-_-vqDL6&J`(yaaMz<M{^9D?H!gc@}z&Ut|rqjI45<Y~%WOq~S!W zEccAhB!WzJ{F#P+L6?k|PQ;r-fJV!zs(^T&>uJ0XT_G7m)$hZwIo%5S$`?~^IEy!X z;i#&))hb`bdoSLIAH;KU2@no}<`pWnl|VRc^1NCYT9({Ix|vft|J_3sk{uMAw<fkz zqiaZZ#SKEq+5pxL>Y7$jp)}hOZMtunCN9(2M`4tClbA?a2A-@XH4{VMa_6L)qn94H z%{4PxIgY}I?gyHCV7~4yF`9(IoGWgq(<WlUC>ZQ$QDSjiyCJZBi{(+X^d`q@2;@j& zZrX*rPAd5-hVz-$PHD$CHg6t<VQN$qiY#Z^6cLh<1w~2%R;GrxF!{We@SIl?vXD-Y zb^pL)bD(LcNjNdQ)W(sV-|;-&?1v*k^LE(@kNHvpD@UETYo$);Fh2EjxErB?6tIGZ z;k1Bc;0(=pN-BO1BdJR72v?bA(28N;-R$b^m6dpZvAs#SG1?G870W>)6b`v%E{0R> z-L{oZWhI7-ot+&M;`cDBjXng>`StxTS8w5bdt>KhI7<mwpd^4#j)Y<u=2Xo+opZp= zu--=}g(rq*+AxB)13BO(HS8pGGp%OG5pYOGN(?5sjG`Mx)H_WcL}6coQA6g7lC-P? zs+B;3a7NKQ89c2dfL7U5`v*~Jxo4Uzi^QihzAUxnWb<T2k<5`hX=TmNQ^KUB(>x{8 zMA=(+gSZSQNXCNyw3!~mMvbgTO&FEDB*+Q#LS<FHCrL7;aGi)9z7o!r_NVc9u~=M} zD<`zN)@D9t{B8_QJC5OLI*}}<6U6ZXC_A9qhy3c*_df!bk(p&XZj$7|&5N}gr#0?B z$=$4SBV3Wg#lX=i_|MWj?1u}msUU4*wc!(6rt;p0FRN&zvfQN1LE3~71B;JweYQ(< z-I-k}N0&s%xybQ=qldXp^ggk;Tpan$qjxP%KB?CAlH@w0^{@^XnV@JB)VJ;_R4ff2 zg44IYL@?=AucmO*>loRPNHs&L*Uf*P#)0+IZM`#&LC(;REBF$eJ6L;~<(l3SUQn46 zTu_Er*XieQz|~#4dqck-1L!-jNGc}5YeyV4bB?isd-pLMffWwdKCr>PldkA+z9p@1 zV~AmG)-Jk<{kX^>?<HaVE<T8NHVl%$txACPDT)shD_-LNojA5(xLK;|^e~ecL&-fX z){@jtYrQ(mO-ZeX;8Cz*s`Iw`mFgEe!d82*WpS|fS{*vyvX8N7T$;mAcWpI0_+mh_ nw`wDN1ffUp0b?;oYJ+W0Z;6jvaaEEdmc~rek?HF5)9e2MU>^I` diff --git a/docs_src/_build/html/_modules/cfelpyutils/crystfel_utils.html b/docs_src/_build/html/_modules/cfelpyutils/crystfel_utils.html index f114828..8d1f451 100644 --- a/docs_src/_build/html/_modules/cfelpyutils/crystfel_utils.html +++ b/docs_src/_build/html/_modules/cfelpyutils/crystfel_utils.html @@ -703,7 +703,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="../../cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/_modules/cfelpyutils/geometry_utils.html b/docs_src/_build/html/_modules/cfelpyutils/geometry_utils.html index 61de150..32df1d9 100644 --- a/docs_src/_build/html/_modules/cfelpyutils/geometry_utils.html +++ b/docs_src/_build/html/_modules/cfelpyutils/geometry_utils.html @@ -270,7 +270,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="../../cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/_modules/cfelpyutils/named_tuples.html b/docs_src/_build/html/_modules/cfelpyutils/named_tuples.html index 5c11e47..f12c4e8 100644 --- a/docs_src/_build/html/_modules/cfelpyutils/named_tuples.html +++ b/docs_src/_build/html/_modules/cfelpyutils/named_tuples.html @@ -94,7 +94,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="../../cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="../../documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/_modules/index.html b/docs_src/_build/html/_modules/index.html index a28cdf2..0426bf5 100644 --- a/docs_src/_build/html/_modules/index.html +++ b/docs_src/_build/html/_modules/index.html @@ -56,7 +56,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="../cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="../documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/_sources/documentation_guidelines_for_contributors.rst.txt b/docs_src/_build/html/_sources/documentation_guidelines_for_contributors.rst.txt index bcdb3cb..60bcb63 100644 --- a/docs_src/_build/html/_sources/documentation_guidelines_for_contributors.rst.txt +++ b/docs_src/_build/html/_sources/documentation_guidelines_for_contributors.rst.txt @@ -1,3 +1,5 @@ +:orphan: + Guidelines for Contributors =========================== diff --git a/docs_src/_build/html/_sources/index.rst.txt b/docs_src/_build/html/_sources/index.rst.txt index a3b5c6e..ef4ad25 100644 --- a/docs_src/_build/html/_sources/index.rst.txt +++ b/docs_src/_build/html/_sources/index.rst.txt @@ -3,14 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -CFELPyUtils -=========== +The CFELPyUtils Library +======================= .. toctree:: :hidden: cfelpyutils - documentation_guidelines_for_contributors Introduction diff --git a/docs_src/_build/html/_sources/modules.rst.txt b/docs_src/_build/html/_sources/modules.rst.txt deleted file mode 100644 index 31f2701..0000000 --- a/docs_src/_build/html/_sources/modules.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -cfelpyutils -=========== - -.. toctree:: - :maxdepth: 4 - - cfelpyutils diff --git a/docs_src/_build/html/cfelpyutils.crystfel_utils.html b/docs_src/_build/html/cfelpyutils.crystfel_utils.html index 58736df..d162d9e 100644 --- a/docs_src/_build/html/cfelpyutils.crystfel_utils.html +++ b/docs_src/_build/html/cfelpyutils.crystfel_utils.html @@ -95,7 +95,6 @@ file.</td> <li class="toctree-l2"><a class="reference internal" href="cfelpyutils.named_tuples.html">named_tuples</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/cfelpyutils.geometry_utils.html b/docs_src/_build/html/cfelpyutils.geometry_utils.html index a474102..411b8e2 100644 --- a/docs_src/_build/html/cfelpyutils.geometry_utils.html +++ b/docs_src/_build/html/cfelpyutils.geometry_utils.html @@ -161,7 +161,6 @@ applied.</p> <li class="toctree-l2"><a class="reference internal" href="cfelpyutils.named_tuples.html">named_tuples</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/cfelpyutils.html b/docs_src/_build/html/cfelpyutils.html index e7a0d92..24ffb50 100644 --- a/docs_src/_build/html/cfelpyutils.html +++ b/docs_src/_build/html/cfelpyutils.html @@ -70,7 +70,6 @@ <li class="toctree-l2"><a class="reference internal" href="cfelpyutils.named_tuples.html">named_tuples</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/cfelpyutils.named_tuples.html b/docs_src/_build/html/cfelpyutils.named_tuples.html index 377126c..66a4c7c 100644 --- a/docs_src/_build/html/cfelpyutils.named_tuples.html +++ b/docs_src/_build/html/cfelpyutils.named_tuples.html @@ -16,7 +16,6 @@ <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - <link rel="next" title="Guidelines for Contributors" href="documentation_guidelines_for_contributors.html" /> <link rel="prev" title="The geometry_utils Module" href="cfelpyutils.geometry_utils.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -119,7 +118,6 @@ pixel, the center of the reference system, and the x axis.</li> <li class="toctree-l2 current"><a class="current reference internal" href="#">named_tuples</a></li> </ul> </li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> @@ -128,7 +126,6 @@ pixel, the center of the reference system, and the x axis.</li> <li><a href="index.html">Documentation overview</a><ul> <li><a href="cfelpyutils.html">The cfelpyutils Package</a><ul> <li>Previous: <a href="cfelpyutils.geometry_utils.html" title="previous chapter">The geometry_utils Module</a></li> - <li>Next: <a href="documentation_guidelines_for_contributors.html" title="next chapter">Guidelines for Contributors</a></li> </ul></li> </ul></li> </ul> diff --git a/docs_src/_build/html/documentation_guidelines_for_contributors.html b/docs_src/_build/html/documentation_guidelines_for_contributors.html index 81baa5a..1791906 100644 --- a/docs_src/_build/html/documentation_guidelines_for_contributors.html +++ b/docs_src/_build/html/documentation_guidelines_for_contributors.html @@ -16,7 +16,6 @@ <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> - <link rel="prev" title="The named_tuples Module" href="cfelpyutils.named_tuples.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -104,7 +103,7 @@ Python.</li> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> - <h3><a href="index.html">Table of Contents</a></h3> + <h3><a href="index.html">CFELPyUtils</a></h3> <ul> <li><a class="reference internal" href="#">Guidelines for Contributors</a><ul> <li><a class="reference internal" href="#version-control">Version Control</a></li> diff --git a/docs_src/_build/html/genindex.html b/docs_src/_build/html/genindex.html index 19e0c10..c2a43c1 100644 --- a/docs_src/_build/html/genindex.html +++ b/docs_src/_build/html/genindex.html @@ -147,7 +147,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/index.html b/docs_src/_build/html/index.html index 6e91902..1b1aac8 100644 --- a/docs_src/_build/html/index.html +++ b/docs_src/_build/html/index.html @@ -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>CFELPyUtils — CFELPyUtils 1.0.0 documentation</title> + <title>The CFELPyUtils Library — CFELPyUtils 1.0.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" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> @@ -33,8 +33,8 @@ <div class="body" role="main"> - <div class="section" id="cfelpyutils"> -<h1>CFELPyUtils<a class="headerlink" href="#cfelpyutils" title="Permalink to this headline">¶</a></h1> + <div class="section" id="the-cfelpyutils-library"> +<h1>The CFELPyUtils Library<a class="headerlink" href="#the-cfelpyutils-library" title="Permalink to this headline">¶</a></h1> <div class="toctree-wrapper compound"> </div> <div class="section" id="introduction"> @@ -97,9 +97,9 @@ to the project:</p> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> - <h3><a href="#">Table of Contents</a></h3> + <h3><a href="#">CFELPyUtils</a></h3> <ul> -<li><a class="reference internal" href="#">CFELPyUtils</a><ul> +<li><a class="reference internal" href="#">The CFELPyUtils Library</a><ul> <li><a class="reference internal" href="#introduction">Introduction</a></li> <li><a class="reference internal" href="#installation">Installation</a></li> <li><a class="reference internal" href="#authors">Authors</a></li> diff --git a/docs_src/_build/html/modules.html b/docs_src/_build/html/modules.html deleted file mode 100644 index c6b1e68..0000000 --- a/docs_src/_build/html/modules.html +++ /dev/null @@ -1,114 +0,0 @@ - -<!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" lang="en"> - <head> - <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>cfelpyutils — CFELPyUtils 1.0.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" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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> - <script type="text/javascript" src="_static/language_data.js"></script> - <link rel="index" title="Index" href="genindex.html" /> - <link rel="search" title="Search" href="search.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> - - - <div class="document"> - <div class="documentwrapper"> - <div class="bodywrapper"> - - - <div class="body" role="main"> - - <div class="section" id="cfelpyutils"> -<h1>cfelpyutils<a class="headerlink" href="#cfelpyutils" title="Permalink to this headline">¶</a></h1> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a><ul> -<li class="toctree-l2"><a class="reference internal" href="cfelpyutils.crystfel_utils.html">crystfel_utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="cfelpyutils.geometry_utils.html">geometry_utils</a></li> -<li class="toctree-l2"><a class="reference internal" href="cfelpyutils.named_tuples.html">named_tuples</a></li> -</ul> -</li> -</ul> -</div> -</div> - - - </div> - - </div> - </div> - <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> - <div class="sphinxsidebarwrapper"> -<h1 class="logo"><a href="index.html">CFELPyUtils</a></h1> - - - - - - - - -<h3>Navigation</h3> -<ul> -<li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a></li> -</ul> - -<div class="relations"> -<h3>Related Topics</h3> -<ul> - <li><a href="index.html">Documentation overview</a><ul> - </ul></li> -</ul> -</div> -<div id="searchbox" style="display: none" role="search"> - <h3>Quick search</h3> - <div class="searchformwrapper"> - <form class="search" action="search.html" method="get"> - <input type="text" name="q" /> - <input type="submit" value="Go" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> - </div> -</div> -<script type="text/javascript">$('#searchbox').show(0);</script> - - - - - - - - - </div> - </div> - <div class="clearer"></div> - </div> - <div class="footer"> - ©2019, OnDA Team. - - | - Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.5</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> - - </div> - - - - - </body> -</html> \ No newline at end of file diff --git a/docs_src/_build/html/objects.inv b/docs_src/_build/html/objects.inv index 4a820253d6ecab3d4028bc2d93308bcfad0ecf29..a7f57df54099dbcb716c8510407aa5ef15984664 100644 GIT binary patch delta 379 zcmV->0fhei1B3*Sl7CVwA#FQHY2re(K%yi}q)$H}v?Y|%P8&C{e}BI*iRm7Ma;4?M zAmvuMWTgP~gy=cG$ZReid?tQGan#RI?ToG8@iZco{erj<k}!OVr66;#+BHV|vY?jB z0xfS^4Ly#S8(oL8$*u=dqLgr_Zn2e^5lbez9<#dPL1nH=3x8Pg3g<+bdFbEVltl0Y zX|Vt0RgfGQwxtqqefoXT<m>}s!YdHlu0<+{F@ydtvG?&7D&q~4SgZN29?gGo^(@qC z7OI<tdiWC+8Ov5oQWP&Q))xB6pdUmDp<g70sU3C&H?mheJ*?igXLM@YT;Y%0o0dPQ z9^nVK=?eW~igYbIsO-pfahXG5{e@3U&Oq=24BktPsVw|ok~*-uyU2ULo&=~Cpmk3W zrBLvKLDk{~*@0*bj!|F#);vaMS=U8R(R|(d<$061&vtAZzSBgzs9qr>bmih>!k7D5 ZbUp@%rde3wV_y93^GS2AegL4`!s@Bzy*U5? delta 371 zcmV-(0gV2H1pEV#l7G@FA#FQHY2wmoA&E#bL7#p=XiF&2PAfOCe}BJYi0KZ5E}iAV zAYHC9#hd{2gy=cG*xO7z_)PqW;;5UWd1-9*j;9f!><`3+P=w)AECrQ;&CA+o=OndU zNwmCb)%Q4Ju5=yBCcExQiPoY#b&IXSj94<!^^nyS52`ZlEPr6l3!D*c=Ar*^<A~q~ zQe*GsB}oPhTc-t#ProagoP8incmZP5wnzmrrq|yk_BP%^?|IE6*5-U$jpkn5d=_dk z3$>hudiWO=8Ov5oQ4}vP))xBQLpO*LLcd80Q#)(~H?UVcJ*?g||LD}V8Q~Ayn}*-3 z9^ePJX@q_;#cYNhRJP=**kvHCzwoK!3<Q^8@J{8JD(SzH$^)yLi@f*iNq{N=T6Y9d z3X)3(MS~Y)3!*kSMt%KT{TQ8PZ5JKI`sMjODZlEoN7dRGAnGzcCVYuMf6F#Na=H&I Re9VhKd_JlFrC*iVzO>BRwYdNQ diff --git a/docs_src/_build/html/py-modindex.html b/docs_src/_build/html/py-modindex.html index b250e79..02294c3 100644 --- a/docs_src/_build/html/py-modindex.html +++ b/docs_src/_build/html/py-modindex.html @@ -88,7 +88,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/search.html b/docs_src/_build/html/search.html index e7b25fc..a117965 100644 --- a/docs_src/_build/html/search.html +++ b/docs_src/_build/html/search.html @@ -83,7 +83,6 @@ <h3>Navigation</h3> <ul> <li class="toctree-l1"><a class="reference internal" href="cfelpyutils.html">The cfelpyutils Package</a></li> -<li class="toctree-l1"><a class="reference internal" href="documentation_guidelines_for_contributors.html">Guidelines for Contributors</a></li> </ul> <div class="relations"> diff --git a/docs_src/_build/html/searchindex.js b/docs_src/_build/html/searchindex.js index 2f17d5d..ab1eb8a 100644 --- a/docs_src/_build/html/searchindex.js +++ b/docs_src/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["cfelpyutils","cfelpyutils.crystfel_utils","cfelpyutils.geometry_utils","cfelpyutils.named_tuples","documentation_guidelines_for_contributors","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["cfelpyutils.rst","cfelpyutils.crystfel_utils.rst","cfelpyutils.geometry_utils.rst","cfelpyutils.named_tuples.rst","documentation_guidelines_for_contributors.rst","index.rst"],objects:{"":{cfelpyutils:[0,0,0,"-"]},"cfelpyutils.crystfel_utils":{load_crystfel_geometry:[1,1,1,""]},"cfelpyutils.geometry_utils":{apply_geometry_to_data:[2,1,1,""],compute_pix_maps:[2,1,1,""],compute_visualization_pix_maps:[2,1,1,""]},"cfelpyutils.named_tuples":{PixelMaps:[3,2,1,""]},"cfelpyutils.named_tuples.PixelMaps":{phi:[3,3,1,""],r:[3,3,1,""],x:[3,3,1,""],y:[3,3,1,""],z:[3,3,1,""]},cfelpyutils:{crystfel_utils:[1,0,0,"-"],geometry_utils:[2,0,0,"-"],named_tuples:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute"},terms:{"41a8fa9819010":1,"class":[3,5],"float":[],"function":[1,2,5],"int":[],"new":[],"return":[1,2],For:[1,5],The:[4,5],These:2,absolut:1,accord:2,activ:4,adjust:[],alia:3,all:[2,4],along:2,also:5,amplitud:3,anaconda:5,andrew:5,angl:3,ani:[1,2],anton:5,appli:[2,4,5],apply_geometry_to_data:2,around:2,arrai:2,assum:[],avail:[2,5],awai:2,axi:3,barti:5,base:3,beam:2,been:[],befor:4,between:3,big:2,bigger:2,binari:4,black:4,both:4,branch:4,c99:4,can:[2,4,5],caus:2,ceil:2,center:[2,3,5],centos7:4,cfel:5,cfelpyutil:[3,4],channel:[],chapman:5,check:5,code:[1,4],collect:3,com:[],come:4,command:5,commit:1,commonli:4,compat:4,compil:4,complet:2,comput:2,compute_min_array_s:[],compute_pix_map:2,compute_visualization_pix_map:2,conda:5,connect:[],contain:[0,1,2,3,5],contribut:[4,5],convent:2,convert:[],coordin:[2,3],corner:2,correspond:[1,5],creat:4,crystfel:[1,2],crystfel_util:0,current:[1,4,5],cython:4,data:[2,5],describ:[],desi:5,detector:[2,5],develop:[4,5],dict:[1,2],dictionari:[1,2],differ:[2,5],direct:2,displai:2,displayedus:[],distanc:3,distribut:5,doc:[],docstr:4,document:1,documentation_guidelines_for_contributor:[],driessen:4,each:3,electron:5,enough:2,ensur:4,entri:2,exampl:4,except:4,extens:4,facil:4,feel:4,field:3,fifth:[],file:[1,2,4],filenam:1,find:4,first:[],flow:4,folder:4,follow:4,fork:[],format:1,formatt:4,found:5,fourth:[],free:[4,5],from:[1,2,3,5],full:1,futur:4,gcc:4,gener:2,geometri:[1,2,3,5],geometry_util:0,get_detector_geometry_2:1,git:4,gitflow:4,github:4,googl:4,guid:4,hamburg:5,hand:2,has:[],henri:5,here:[4,5],how:4,howev:4,http:[],imag:5,imageview:2,implement:[],index:5,inform:[1,2,3,5],input:2,instead:[],institut:5,interact:2,interfac:4,intern:5,introduct:[],iso:4,just:[],kei:1,known:4,lab:5,languag:[1,4],laser:5,layout:2,lcsl:4,left:2,librari:[0,2,3,4,5],like:2,link:[],lint:4,linux:4,load:1,load_crystfel_geometri:[1,2],main:[0,2],mainli:4,make:[],man:1,mani:5,manipul:2,manual:5,map:[2,3],mariani:5,match:1,matplotlib:2,minimum:2,model:[],morgan:5,most:4,mostli:5,must:4,name:[2,3],named_tupl:0,ndarrai:[2,3],need:2,none:2,note:[],number:3,numpi:[2,3],nvie:[],object:2,often:2,onda:4,ondateam:5,one:4,ones:2,onli:2,order:4,org:[],orient:2,origin:2,other:2,out:5,packag:[1,5],page:1,paramet:[1,2,3],part:4,particularli:2,path:1,peopl:5,perform:[4,5],phi:[2,3],physic:2,pip:5,pixel:[2,3],pixel_map:[],pixelmap:[2,3],platform:4,pleas:[4,5],point:2,possibl:4,post:[],pre:2,prepar:[],process:5,program:4,project:[4,5],propos:4,provid:[],pull:4,pylint:4,pylintrc:4,pypi:5,pyqtgraph:2,python2:5,python3:5,python:[1,5],rai:5,read:[1,2,5],readi:[],reason:4,refer:[2,3],reimplement:1,rel:1,relat:5,releas:5,relev:1,repositori:[4,5],request:4,requir:4,respect:[],restrict:2,result:[],rhel7:4,right:2,root:4,run:[4,5],same:2,scienc:5,scm:[],see:[1,4,5],set:[2,4],setup:5,sever:5,shape:2,should:[2,4],size:2,softwar:[1,5],some:[1,2,4],sourc:[1,2],specif:4,stack:4,standard:4,state:4,store:[1,2,3],str:[1,2],strategi:4,stro:[],style:4,submiss:4,submit:4,submodul:[],success:[],support:[4,5],suppos:[],symmetr:2,sync:[],synchron:1,system:[2,3,4],take:2,task:5,test:5,than:2,thi:[1,2,3],third:[],thoma:5,three:[],through:[],throughout:3,top:2,toward:2,tupl:[2,3],twhite:[],two:4,type:[1,2],use:4,used:[2,3,4,5],uses:[1,4],using:[2,4,5],util:[1,2,5],valerio:5,valu:[1,2],variou:5,vector:[],vincent:4,visual:2,welcom:[4,5],wheel:4,when:4,which:[0,2],white:5,whole:0,widget:2,work:[],worlwid:5,write:4,written:[4,5],wth:[],www:[],zenith:2},titles:["The cfelpyutils Package","The crystfel_utils Module","The geometry_utils Module","The named_tuples Module","Guidelines for Contributors","CFELPyUtils"],titleterms:{The:[0,1,2,3],author:5,cfelpyutil:[0,5],code:5,contributor:[4,5],control:4,crystfel_util:1,document:5,geometry_util:2,guidelin:[4,5],instal:5,introduct:5,modul:[1,2,3],named_tupl:3,packag:0,python:4,thecfelpyutil:[],version:4}}) \ No newline at end of file +Search.setIndex({docnames:["cfelpyutils","cfelpyutils.crystfel_utils","cfelpyutils.geometry_utils","cfelpyutils.named_tuples","documentation_guidelines_for_contributors","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["cfelpyutils.rst","cfelpyutils.crystfel_utils.rst","cfelpyutils.geometry_utils.rst","cfelpyutils.named_tuples.rst","documentation_guidelines_for_contributors.rst","index.rst"],objects:{"":{cfelpyutils:[0,0,0,"-"]},"cfelpyutils.crystfel_utils":{load_crystfel_geometry:[1,1,1,""]},"cfelpyutils.geometry_utils":{apply_geometry_to_data:[2,1,1,""],compute_pix_maps:[2,1,1,""],compute_visualization_pix_maps:[2,1,1,""]},"cfelpyutils.named_tuples":{PixelMaps:[3,2,1,""]},"cfelpyutils.named_tuples.PixelMaps":{phi:[3,3,1,""],r:[3,3,1,""],x:[3,3,1,""],y:[3,3,1,""],z:[3,3,1,""]},cfelpyutils:{crystfel_utils:[1,0,0,"-"],geometry_utils:[2,0,0,"-"],named_tuples:[3,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute"},terms:{"41a8fa9819010":1,"class":[3,5],"function":[1,2,5],"return":[1,2],For:[1,5],The:4,These:2,absolut:1,accord:2,activ:4,alia:3,all:[2,4],along:2,also:5,amplitud:3,anaconda:5,andrew:5,angl:3,ani:[1,2],anton:5,appli:[2,4,5],apply_geometry_to_data:2,around:2,arrai:2,avail:[2,5],awai:2,axi:3,barti:5,base:3,beam:2,befor:4,between:3,big:2,bigger:2,binari:4,black:4,both:4,branch:4,c99:4,can:[2,4,5],caus:2,ceil:2,center:[2,3,5],centos7:4,cfel:5,cfelpyutil:[3,4],chapman:5,check:5,code:[1,4],collect:3,come:4,command:5,commit:1,commonli:4,compat:4,compil:4,complet:2,comput:2,compute_pix_map:2,compute_visualization_pix_map:2,conda:5,contain:[0,1,2,3,5],contribut:[4,5],convent:2,coordin:[2,3],corner:2,correspond:[1,5],creat:4,crystfel:[1,2],crystfel_util:0,current:[1,4,5],cython:4,data:[2,5],desi:5,detector:[2,5],develop:[4,5],dict:[1,2],dictionari:[1,2],differ:[2,5],direct:2,displai:2,distanc:3,distribut:5,docstr:4,document:1,driessen:4,each:3,electron:5,enough:2,ensur:4,entri:2,exampl:4,except:4,extens:4,facil:4,feel:4,field:3,file:[1,2,4],filenam:1,find:4,flow:4,folder:4,follow:4,format:1,formatt:4,found:5,free:[4,5],from:[1,2,3,5],full:1,futur:4,gcc:4,gener:2,geometri:[1,2,3,5],geometry_util:0,get_detector_geometry_2:1,git:4,gitflow:4,github:4,googl:4,guid:4,hamburg:5,hand:2,henri:5,here:[4,5],how:4,howev:4,imag:5,imageview:2,index:5,inform:[1,2,3,5],input:2,institut:5,interact:2,interfac:4,intern:5,iso:4,kei:1,known:4,lab:5,languag:[1,4],laser:5,layout:2,lcsl:4,left:2,librari:[0,2,3,4],like:2,lint:4,linux:4,load:1,load_crystfel_geometri:[1,2],main:[0,2],mainli:4,man:1,mani:5,manipul:2,manual:5,map:[2,3],mariani:5,match:1,matplotlib:2,minimum:2,morgan:5,most:4,mostli:5,must:4,name:[2,3],named_tupl:0,ndarrai:[2,3],need:2,none:2,number:3,numpi:[2,3],object:2,often:2,onda:4,ondateam:5,one:4,ones:2,onli:2,ontribut:[],order:4,orient:2,origin:2,other:2,out:5,packag:[1,5],page:1,paramet:[1,2,3],part:4,particularli:2,path:1,peopl:5,perform:[4,5],phi:[2,3],physic:2,pip:5,pixel:[2,3],pixelmap:[2,3],platform:4,pleas:[4,5],point:2,possibl:4,pre:2,process:5,program:4,project:[4,5],propos:4,pull:4,pylint:4,pylintrc:4,pypi:5,pyqtgraph:2,python2:5,python3:5,python:[1,5],rai:5,read:[1,2,5],reason:4,refer:[2,3],reimplement:1,rel:1,relat:5,releas:5,relev:1,repositori:[4,5],request:4,requir:4,restrict:2,rhel7:4,right:2,root:4,run:[4,5],same:2,scienc:5,see:[1,4,5],set:[2,4],setup:5,sever:5,shape:2,should:[2,4],size:2,softwar:[1,5],some:[1,2,4],sourc:[1,2],specif:4,stack:4,standard:4,state:4,store:[1,2,3],str:[1,2],strategi:4,style:4,submiss:4,submit:4,support:[4,5],symmetr:2,synchron:1,system:[2,3,4],take:2,task:5,test:5,than:2,thi:[1,2,3],thoma:5,throughout:3,top:2,toward:2,tupl:[2,3],two:4,type:[1,2],use:4,used:[2,3,4,5],uses:[1,4],using:[2,4,5],util:[1,2,5],valerio:5,valu:[1,2],variou:5,vincent:4,visual:2,welcom:[4,5],wheel:4,when:4,which:[0,2],white:5,whole:0,widget:2,worlwid:5,write:4,written:[4,5],zenith:2},titles:["The cfelpyutils Package","The crystfel_utils Module","The geometry_utils Module","The named_tuples Module","Guidelines for Contributors","The CFELPyUtils Library"],titleterms:{The:[0,1,2,3,5],author:5,cfelpyutil:[0,5],code:5,contributor:[4,5],control:4,crystfel_util:1,document:5,geometry_util:2,guidelin:[4,5],instal:5,introduct:5,librari:5,modul:[1,2,3],named_tupl:3,packag:0,python:4,version:4}}) \ No newline at end of file diff --git a/docs_src/_templates/localtoc.html b/docs_src/_templates/localtoc.html new file mode 100644 index 0000000..24d5642 --- /dev/null +++ b/docs_src/_templates/localtoc.html @@ -0,0 +1,13 @@ +{# + basic/localtoc.html + ~~~~~~~~~~~~~~~~~~~ + + Sphinx sidebar template: local table of contents. + + :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- if display_toc %} + <h3><a href="{{ pathto(master_doc) }}">{{ _('CFELPyUtils') }}</a></h3> + {{ toc }} +{%- endif %} diff --git a/docs_src/documentation_guidelines_for_contributors.rst b/docs_src/documentation_guidelines_for_contributors.rst index bcdb3cb..60bcb63 100644 --- a/docs_src/documentation_guidelines_for_contributors.rst +++ b/docs_src/documentation_guidelines_for_contributors.rst @@ -1,3 +1,5 @@ +:orphan: + Guidelines for Contributors =========================== diff --git a/docs_src/index.rst b/docs_src/index.rst index a3b5c6e..ef4ad25 100644 --- a/docs_src/index.rst +++ b/docs_src/index.rst @@ -3,14 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -CFELPyUtils -=========== +The CFELPyUtils Library +======================= .. toctree:: :hidden: cfelpyutils - documentation_guidelines_for_contributors Introduction -- GitLab