Skip to content

Commit

Permalink
deploy: 9e4da8a
Browse files Browse the repository at this point in the history
  • Loading branch information
@rpartzsch
rpartzsch committed Nov 21, 2023
0 parents commit 18b6310
Show file tree
Hide file tree
Showing 74 changed files with 11,657 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +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: 1f890f407304dc48d54c1e11c38ebb2b
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/Configuration.doctree
Binary file not shown.
Binary file added .doctrees/Documentation.doctree
Binary file not shown.
Binary file added .doctrees/Introduction.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/hardware_code.doctree
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/main_code.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
239 changes: 239 additions & 0 deletions Configuration.html

Large diffs are not rendered by default.

504 changes: 504 additions & 0 deletions Documentation.html

Large diffs are not rendered by default.

191 changes: 191 additions & 0 deletions Introduction.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AIDA-TLU &mdash; AIDA-TLU 0.9 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=049aceee"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Configuration" href="Configuration.html" />
<link rel="prev" title="Welcome to AIDA-TLU’s documentation!" href="index.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html" class="icon icon-home">
AIDA-TLU
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">AIDA-TLU</a></li>
<li class="toctree-l1"><a class="reference internal" href="#installation">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">IPbus</a></li>
<li class="toctree-l2"><a class="reference internal" href="#python-packages">Python packages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#usage">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="#documentation">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="Documentation.html">Documentation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="hardware_code.html">Hardware Level</a></li>
<li class="toctree-l1"><a class="reference internal" href="main_code.html">Main Level</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">AIDA-TLU</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">AIDA-TLU</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/Introduction.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="aida-tlu">
<h1>AIDA-TLU<a class="headerlink" href="#aida-tlu" title="Link to this heading"></a></h1>
<a class="reference external image-reference" href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a>
<p>Repository for controlling the AIDA-2020 Trigger Logic Unit (TLU) with Python using uHAL bindings from <a class="reference external" href="https://ipbus.web.cern.ch/">IPbus</a>.
The Python control software is based on <a class="reference external" href="https://github.com/eudaq/eudaq/tree/master/user/tlu">EUDAQ2</a>.
The software is a lightweight version written in Python with a focus on readability and user-friendliness.
Most user cases can be set with a .yaml configuration file and started by executing a single Python script.
For a more in-depth look at the hardware components please take a look at the official <a class="reference external" href="https://ohwr.org/project/fmc-mtlu">AIDA-2020 TLU project</a>.</p>
</section>
<section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
<section id="id1">
<h2>IPbus<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
<p>You need to install <a class="reference external" href="https://ipbus.web.cern.ch/doc/user/html/software/install/compile.html">IPbus</a> and its Python bindings to the desired interpreter.
Follow the linked tutorial for prerequisites and general installation.
The following commands have been proven useful for custom installation and building against current (non-system) Python within an environment:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>-j<span class="w"> </span><span class="k">$((</span><span class="sb">`</span>nproc<span class="sb">`</span><span class="o">-</span><span class="m">1</span><span class="k">))</span>
<span class="c1"># Pass current PATH to su shell to build against current environment python</span>
sudo<span class="w"> </span>env<span class="w"> </span><span class="nv">PATH</span><span class="o">=</span><span class="nv">$PATH</span><span class="w"> </span>make<span class="w"> </span>install<span class="w"> </span><span class="nv">prefix</span><span class="o">=</span>&lt;install_location&gt;
</pre></div>
</div>
<p>Afterwards you should be able to import uhal in your specific Python environment.
Then import the library path</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">LD_LIBRARY_PATH</span><span class="o">=</span>/opt/cactus/lib
</pre></div>
</div>
<p>and start the controlhub</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>controlhub_start
</pre></div>
</div>
<p>from the corresponding directory.</p>
</section>
<section id="python-packages">
<h2>Python packages<a class="headerlink" href="#python-packages" title="Link to this heading"></a></h2>
<p>Install the Python package as usual.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="o">.</span>
</pre></div>
</div>
</section>
</section>
<section id="usage">
<h1>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h1>
<p>There are multiple ways to use the control software of the AIDA 2020 TLU.
If one executes tlu.py in the main directory, the TLU is initialized, configured and starts a run automatically.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>tlu.py
</pre></div>
</div>
<p>The TLU is configured with the standard tlu_configuration file. To stop the run use ctrl+c.</p>
<p>While configuring the TLU outputs are powered on and off.
This leads to problems in AIDA mode where the clock is powered off shortly during configuration.
To avoid this at the start of runs in AIDA mode the best way is to use the aidatlu.py script.
This is started and controlled with the terminal input:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-i<span class="w"> </span>aidatlu.py
</pre></div>
</div>
<p>This initializes the main tlu.py script. One is now able to control the TLU through the Python terminal interface,
with the following commands:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>tlu.configure
tlu.run
tlu.help
</pre></div>
</div>
<p>Naturally, this also works for any EUDET mode runs.
Runs are stopped with the keyboard interrupt ctr+c.
For more commands take a look at the python script aidatlu.py.</p>
<p>All configurations are done by the use of a yaml file (tlu_configuration.yaml).</p>
</section>
<section id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h1>
<p>Additionally, take a look at the <a class="reference external" href="https://silab-bonn.github.io/aidatlu/">documentation</a>.</p>
<p>Structure of the AIDA 202 TLU python control software.</p>
<a class="reference internal image-reference" href="_images/structure.png"><img alt="_images/structure.png" src="_images/structure.png" style="width: 600px;" /></a>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to AIDA-TLU’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="Configuration.html" class="btn btn-neutral float-right" title="Configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2023, Rasmus Partzsch.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Binary file added _images/4_pin_lemo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/hdmi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/structure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/test_setup_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 18b6310

Please sign in to comment.