Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
mrakitin committed Oct 7, 2023
1 parent 436d4c8 commit c4147eb
Show file tree
Hide file tree
Showing 47 changed files with 90 additions and 89 deletions.
2 changes: 1 addition & 1 deletion hklpy/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8c09b9bef91d75e64a94b3ee77a1c2fa
config: 0d3105552ca9cfedd71d57385a0b010f
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 2 additions & 2 deletions hklpy/_modules/hkl/calc.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hkl.calc &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>hkl.calc &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/_modules/hkl/context.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hkl.context &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>hkl.context &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/_modules/hkl/diffract.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hkl.diffract &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>hkl.diffract &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/_modules/hkl/engine.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hkl.engine &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>hkl.engine &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/_modules/hkl/geometries.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hkl.geometries &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>hkl.geometries &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/_modules/hkl/sample.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hkl.sample &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>hkl.sample &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/_modules/hkl/user.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hkl.user &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>hkl.user &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/_modules/hkl/util.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>hkl.util &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>hkl.util &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>Overview: module code &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -35,7 +35,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
2 changes: 1 addition & 1 deletion hklpy/_sources/examples/notebooks/geo_k4cv.ipynb.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"here could be replaced entirely with `hkl.geometries.SimulatedK4CV`\n",
"but we choose to show here the complete steps to produce that class.)\n",
"The [*hklpy*\n",
"documentation](https://blueskyproject.io/hklpy/master/geometries.html)\n",
"documentation](https://blueskyproject.io/hklpy/geometries.html?highlight=geometries#module-hkl.geometries)\n",
"provides a complete list of diffractometer geometries.\n",
"\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion hklpy/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0+untagged.1.g45dbf4e',
VERSION: '0+untagged.1.gbb516ef',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions hklpy/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Reference &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>API Reference &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -38,7 +38,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/calc.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>calc &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>calc &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -38,7 +38,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/context.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>context &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>context &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -38,7 +38,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/diffract.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>diffract &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>diffract &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -38,7 +38,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/engine.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>engine &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>engine &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -38,7 +38,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Examples &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>Examples &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -38,7 +38,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/examples/notebooks/geo_e4cv.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>E4CV : 4-circle diffractometer example &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>E4CV : 4-circle diffractometer example &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -41,7 +41,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
4 changes: 2 additions & 2 deletions hklpy/examples/notebooks/geo_e6c.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>E6C : 6-circle diffractometer example &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>E6C : 6-circle diffractometer example &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -41,7 +41,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down
6 changes: 3 additions & 3 deletions hklpy/examples/notebooks/geo_k4cv.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>K4CV : 4-circle kappa diffractometer example &mdash; hklpy 0+untagged.1.g45dbf4e documentation</title>
<title>K4CV : 4-circle kappa diffractometer example &mdash; hklpy 0+untagged.1.gbb516ef documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -41,7 +41,7 @@
hklpy
</a>
<div class="version">
0+untagged.1.g45dbf4e
0+untagged.1.gbb516ef
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand Down Expand Up @@ -163,7 +163,7 @@ <h2>Setup the <em>K4CV</em> diffractometer in <em>hklpy</em><a class="headerlink
<section id="Define-this-diffractometer">
<h2>Define <em>this</em> diffractometer<a class="headerlink" href="#Define-this-diffractometer" title="Permalink to this heading"></a></h2>
<p>Create a Python class that specifies the names of the real-space positioners. We call it <code class="docutils literal notranslate"><span class="pre">KappaFourCircle</span></code> here but that choice is arbitrary. Pick any valid Python name not already in use. The convention is to start Python class names with a capital letter and use CamelCase to mark word starts.</p>
<p>The argument to the <code class="docutils literal notranslate"><span class="pre">KappaFourCircle</span></code> class tells which <em>hklpy</em> base class will be used. This sets the geometry. (The class we show here could be replaced entirely with <code class="docutils literal notranslate"><span class="pre">hkl.geometries.SimulatedK4CV</span></code> but we choose to show here the complete steps to produce that class.) The <a class="reference external" href="https://blueskyproject.io/hklpy/master/geometries.html">hklpy documentation</a> provides a complete list of diffractometer geometries.</p>
<p>The argument to the <code class="docutils literal notranslate"><span class="pre">KappaFourCircle</span></code> class tells which <em>hklpy</em> base class will be used. This sets the geometry. (The class we show here could be replaced entirely with <code class="docutils literal notranslate"><span class="pre">hkl.geometries.SimulatedK4CV</span></code> but we choose to show here the complete steps to produce that class.) The <a class="reference external" href="https://blueskyproject.io/hklpy/geometries.html?highlight=geometries#module-hkl.geometries">hklpy documentation</a> provides a complete list of diffractometer geometries.</p>
<p>In <em>hklpy</em>, the reciprocal-space axes are known as <code class="docutils literal notranslate"><span class="pre">pseudo</span></code> positioners while the real-space axes are known as <code class="docutils literal notranslate"><span class="pre">real</span></code> positioners. For the real positioners, it is possible to use different names than the canonical names used internally by the <em>hkl</em> library. That is not covered here.</p>
<p>Note: The keyword argument <code class="docutils literal notranslate"><span class="pre">kind=&quot;hinted&quot;</span></code> is an indication that this signal may be plotted.</p>
<p>This <code class="docutils literal notranslate"><span class="pre">KappaFourCircle()</span></code> class example uses simulated motors. See the drop-down for an example how to use EPICS motors.</p>
Expand Down
2 changes: 1 addition & 1 deletion hklpy/examples/notebooks/geo_k4cv.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
"here could be replaced entirely with `hkl.geometries.SimulatedK4CV`\n",
"but we choose to show here the complete steps to produce that class.)\n",
"The [*hklpy*\n",
"documentation](https://blueskyproject.io/hklpy/master/geometries.html)\n",
"documentation](https://blueskyproject.io/hklpy/geometries.html?highlight=geometries#module-hkl.geometries)\n",
"provides a complete list of diffractometer geometries.\n",
"\n",
"\n",
Expand Down
Loading

0 comments on commit c4147eb

Please sign in to comment.