updated manuals, jungfrau server (reqd firmware vversion)

This commit is contained in:
2018-08-23 15:52:12 +02:00
parent b7f62fcd47
commit e0b8fb3609
656 changed files with 37896 additions and 34 deletions

View File

@ -0,0 +1,92 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Binaries</TITLE>
<META NAME="description" CONTENT="Binaries">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00021000000000000000">
Binaries</A>
</H2>
The complete software package is composed of several programs which
can be installed (or locally compiled) depending on one's requirements:
<P>
<UL>
<LI><FONT COLOR="#0000ff">libSlsDetector.so, libSlsReceiver.so</FONT>:
<BR>
The <I>slsDetector shared and static libraries</I>, which are
necessary for all user interfaces. The <I>C++ API</I> via the class
<I>slsDetectorUsers</I> (installed with the default package) or the
<I>Python API</I> via the class <I>sls_detector</I> (installed with the
package including Python API), which can be used from the user's acquisition
software to control the detectors and the data receivers.
<P>
</LI>
<LI><FONT COLOR="#0000ff">sls_detector_put, sls_detector_get,
sls_detector_acquire, sls_detector_help</FONT>:
<BR>
The <I>command line interfaces</I>, which are provided to communicate with the
detectors and data receivers using the command line.
<P>
</LI>
<LI><FONT COLOR="#0000ff">slsReceiver</FONT>:
<BR>
The <I>data receiver</I>, which can be run on a different machine than the
client, receives the data from the detector and processes it. The receiver can
be configured, controlled and monitored by the client.
<P>
</LI>
<LI><FONT COLOR="#0000ff">slsMultiReceiver</FONT>:
<BR>
It is the same as the <I>slsReceiver</I>, but that it is a single process
for many multiple slsReceiver child processes. One can configure the start TCP port,
number of slsReceiver processes and if call back should be enabled or not.
<P>
</LI>
<LI><FONT COLOR="#0000ff">slsDetectorGUI</FONT>:
<BR>
The <I>graphical user interface</I>, which provides a user friendly way
of operating the detectors and data receivers with online data preview.
<P>
</LI>
<LI><FONT COLOR="#0000ff">energyCalibrationWizard,angularCalibrationWizard</FONT>:
<BR>
The <I>calibration wizards</I> to analyze the data and produce the energy or
angular calibration files.
<P>
</LI>
<LI>The <I>virtual Detector servers</I> to simulate the detectors behavior.
However, only control commands work, not the data acquisition itself.
</LI>
</UL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,46 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Clean Shared Memory</TITLE>
<META NAME="description" CONTENT="Clean Shared Memory">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00045000000000000000">
Clean Shared Memory</A>
</H2>
It is very crucial to clean the shared memory, before using a new version of
the SLS Detector Package or a different detector type.
<P>
One can use the <code>cleansharedmemory.sh</code> script available under the
slsDetector Package.
<P>
One can also just delete the files that are typically located under /dev/shm/ folder
and starts with slsDetectorPackage.
<P>
One no longer has to delete segments using ipcs.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,34 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Compilation</TITLE>
<META NAME="description" CONTENT="Compilation">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00043000000000000000">
Compilation</A>
</H2>
One requires <code>cmake</code> to compile and can be done in two ways:
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,74 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Contents</TITLE>
<META NAME="description" CONTENT="Contents">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<BR>
<H2><A NAME="SECTION00010000000000000000">
Contents</A>
</H2>
<!--Table of Contents-->
<UL>
<LI><A NAME="tex2html20"
HREF="Software_Package.html">The Software Package</A>
<UL>
<LI><A NAME="tex2html21"
HREF="Binaries.html">Binaries</A>
</UL>
<BR>
<LI><A NAME="tex2html22"
HREF="Install_Binaries_via_Conda.html">Install Binaries via Conda</A>
<LI><A NAME="tex2html23"
HREF="Install_via_Source_Code.html">Install via Source Code</A>
<UL>
<LI><A NAME="tex2html24"
HREF="Download_Source_Code.html">Download Source Code</A>
<LI><A NAME="tex2html25"
HREF="Requirements.html">Requirements</A>
<LI><A NAME="tex2html26"
HREF="Compilation.html">Compilation</A>
<LI><A NAME="tex2html27"
HREF="Setting_environment_variabl.html">Setting environment variables</A>
<LI><A NAME="tex2html28"
HREF="Clean_Shared_Memory.html">Clean Shared Memory</A>
</UL>
<BR>
<LI><A NAME="tex2html29"
HREF="Software_Upgrade.html">Software Upgrade</A>
<UL>
<LI><A NAME="tex2html30"
HREF="MYTHEN.html">MYTHEN</A>
<LI><A NAME="tex2html31"
HREF="GOTTHARD.html">GOTTHARD</A>
<LI><A NAME="tex2html32"
HREF="EIGER.html">EIGER</A>
<LI><A NAME="tex2html33"
HREF="JUNGFRAU.html">JUNGFRAU</A>
</UL></UL>
<!--End of Table of Contents-->
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,61 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Directly using cmake</TITLE>
<META NAME="description" CONTENT="Directly using cmake">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00043200000000000000">
Directly using cmake</A>
</H3>
<P>
Use cmake to create out-of-source builds, by creating a build folder parallel to
source directory.
<PRE>
$ cd ..
$ mkdir slsDetectorPackage-build
$ cd slsDetectorPackage-build
$ cmake ../slsDetectorPackage -DCMAKE_BUILD_TYPE=Debug -DUSE_HDF5=OFF
$ make
</PRE>
<P>
Use the following as an example to compile statically and using specific hdf5
folder
<PRE>
$ HDF5_ROOT=/opt/hdf5v1.10.0 cmake ../slsDetectorPackage
-DCMAKE_BUILD_TYPE=Debug -DUSE_HDF5=ON
</PRE>
<P>
After compiling, the libraries and executables will be found at `bin` directory
<PRE>
$ ls bin/
gui_client libSlsDetector.a libSlsDetector.so libSlsReceiver.a
libSlsReceiver.so sls_detector_acquire sls_detector_get slsDetectorGui
sls_detector_help sls_detector_put slsReceiver
</PRE>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,52 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Download Source Code</TITLE>
<META NAME="description" CONTENT="Download Source Code">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00041000000000000000">
Download Source Code</A>
</H2>
<P>
<UL>
<LI>Only the package
<PRE>
#Clone source code with specific release
git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git --branch
4.0.0
</PRE>
</LI>
<LI>The package including Python interface
<PRE>
#Clone source code with specific release
git clone https://github.com/slsdetectorgroup/sls_detector.git --branch
4.0.0
</PRE>
</LI>
</UL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,39 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>EIGER</TITLE>
<META NAME="description" CONTENT="EIGER">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00053000000000000000">
EIGER</A>
</H2>
<P>
In such cases, the users are not expected to compile the software
themselves (which would require dedicated softwares) but only to download on the
detector board the programming files and/or software package provided by
the SLS Detectors group.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,86 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>EIGER Firmware</TITLE>
<META NAME="description" CONTENT="EIGER Firmware">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00053100000000000000">
EIGER Firmware</A>
</H3>
<I>For SLS Detector Package v4.0.0</I>
<BR>
Minimum compatible version: 22
<BR>
Latest version: 22
<BR>
<P>
<OL>
<LI>One must get the latest package's corresponding bit files from the SLS
Detector Group.
</LI>
<LI>If one does not have the bcp script, that should also be obtained from
the SLS Detector Group. It is required to program the bit files and requires
that tftp be installed on the pc.
</LI>
<LI>Bring the detector into programmable mode by either of the following ways.
Both ways end up in just the central LED blinking.
<OL>
<LI>hard reset on the back panel boards resulting in blinking LEDS
</LI>
<LI>by having the following program running in the background.
<PRE>
boot_recovery
</PRE>
</LI>
</OL>
</LI>
<LI>Start a terminal for each half module and run the following to see
progress.
<PRE>
nc -p 3000 -u bebxxx 3000
</PRE>
</LI>
<LI>Run the following to update firmware
<PRE>
#update back end fpga
bcp download.bit bebxxx:/fw0
#update front left fpga
bcp download.bit bebxxx:/febl
#update front right fpga
bcp download.bit bebxxx:/febr
#update kernel
bcp download.bit bebxxx:/kernel
</PRE>
Please update bit files with great caution as it could make your board
inaccessible, if done incorrectly.
</LI>
</OL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,70 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>EIGER On-board Software</TITLE>
<META NAME="description" CONTENT="EIGER On-board Software">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00053200000000000000">
EIGER On-board Software</A>
</H3>
Every SLS Detector package release will have its coresponding matching on-board
server under <B>slsDetectorPackage/serverBin</B>.
<P>
Update the on-board software without connecting to the detector
<PRE>
#password for the boards: root
#Kill existing servers that are running on the detector
ssh root@beb031 killall eigerDetectorServer;
#Copy on-board server to detector inside executables folder
scp ~/path-where-it-is/eigerDetectorServerxxx root@bebxxx:~/executables;
#Overwrite the actual eigerDetectorServer on board
scp ~/path-where-it-is/eigerDetectorServerxxx
root@bebxxx:~/executables/eigerDetectorServer;
#sync
ssh root@bebxxx sync;
#reboot the eiger board
</PRE>
<P>
<P><P>
<BR>
One can connect to the detector by:
<PRE>
ssh root@bebxxx
password: root
</PRE>
<P>
The on-board server is in&nbsp;/executables folder and respawned at startup in
<BR><code>/etc/rc5.d/S50board_com.sh</code>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,39 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>GOTTHARD</TITLE>
<META NAME="description" CONTENT="GOTTHARD">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00052000000000000000">
GOTTHARD</A>
</H2>
<P>
In such cases, the users are not expected to compile the software
themselves (which would require dedicated softwares) but only to download on the
detector board the programming files and/or software package provided by
the SLS Detectors group.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,93 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>GOTTHARD Firmware</TITLE>
<META NAME="description" CONTENT="GOTTHARD Firmware">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00052100000000000000">
GOTTHARD Firmware</A>
</H3>
<I>For SLS Detector Package v4.0.0</I>
<BR>
Minimum compatible version:
<BR>
11.01.2013
<BR>
Latest version:
<BR>
26.06.2018 (50um)
<BR>
08.02.2018 (25 um Master)
<BR>
09.02.2018 (25 um Slave)
<BR>
<P>
Normally, the firmware will be upgraded by us as it requires programming the
FPGA via the USB-Blaster.
<P>
To upgrade the firmware you need either a working version of the Altera
Quartus software or of the Quartus programmer, which can easily be downloaded
from:
<BR><TT><A NAME="tex2html5"
HREF="https://www.altera.com/download/programming/quartus2/pq2-index.jsp">https://www.altera.com/download/programming/quartus2/pq2-index.jsp</A></TT>
<P>
Normally, installation of the software and of the driver for the
USB-Blaster (provided together with the MYTHEN detector) are simpler under
Windows.
<P>
Under Windows, the first time that you connect the USB-Blaster to one
of your USB ports, you will be asked to install new hardware. Set the path to
search for the driver to:
<code>C:\altera\80sp1\qprogrammer\drivers\usb-blasterp</code> (where
<code>C:\altera\80sp1\qprogrammer\</code> is assumed to be ther path where your
Quartus version is installed).
<OL>
<LI>After starting the Quartus programmer, click on Hardware Setup and in the
"Currently selected hardware" window select USB-Blaster.
</LI>
<LI>In the Mode combo box select "Active Serial Programming".
</LI>
<LI>Plug the end of your USB-Blaster WITH THE ADAPTER PROVIDED in the
connector ASMI on the MCS board taking care that pin1 corresponds to the one
indexed and with the rectangualr pad.
</LI>
<LI>Click on add file and from select the programming file provided when
the upgrade has been reccomended.
</LI>
<LI>Check "Program/Configure" and "Verify".
</LI>
<LI>Push the start button and wait until the programming process is
finished (progress bar top left).
</LI>
<LI>In case the programmer gives you error messages, check the polarity of
your cable (pin1 corresponds) and that you have selected the correct programming
connector.
</LI>
</OL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,89 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>GOTTHARD On-board Software</TITLE>
<META NAME="description" CONTENT="GOTTHARD On-board Software">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00052200000000000000">
GOTTHARD On-board Software</A>
</H3>
Every SLS Detector package release will have its coresponding matching on-board
server under <B>slsDetectorPackage/serverBin</B>.
<P>
<OL>
<LI>Install tftp if the pc does not have it.
</LI>
<LI>Copy the server from serverBin folder to /tftpboot (or equivalent tftp
folder) of the pc
</LI>
<LI>Copy the server to the detector by:
<OL>
<LI>Connect to the blackfin on the detector
<BR><code>telnet bchipxxx</code>
</LI>
<LI>Prevent existing on-board server from respawning by:
<OL>
<LI>Edit <code>/etc/inittab</code>
</LI>
<LI>Comment out the line
<code>#ttyS0::respawn:/gotthardDetectorServervxxx</code>
</LI>
<LI>Reboot blackfin using <code>reboot</code>
</LI>
<LI>Run <code>ps</code> to ensure no gotthardDetectorServers are running
</LI>
</OL>
</LI>
<LI>Copy new on-board server from pc to the blackfin using:
<BR><code>tftp pcxxx -r gotthardDetectorServerxxx -g</code>
</LI>
<LI>Respawn the new server (server starts at detector statup):
<OL>
<LI>Edit <code>/etc/inittab</code>
</LI>
<LI>Uncomment out the line
<code>ttyS0::respawn:/gotthardDetectorServervxxx</code>
</LI>
<LI>Reboot blackfin using <code>reboot</code>
</LI>
<LI>Run <code>ps</code> to ensure that both the gotthardDetectorServers are
running.
<BR><code>gotthardDetectorServerxxx</code>
<BR><code>gotthardDetectorServerxxx 1953</code>
</LI>
</OL>
</LI>
</OL>
</LI>
</OL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,97 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Install Binaries via Conda</TITLE>
<META NAME="description" CONTENT="Install Binaries via Conda">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H1><A NAME="SECTION00030000000000000000">
Install Binaries via Conda</A>
</H1>
This section is useful only if one wants to download only the binaries for
specific distribution and use the package via command line. Please refer later
sections to download source code and compile them.
<P>
One can download and install Miniconda via
<P>
<TT><A NAME="tex2html1"
HREF="https://conda.io/miniconda.html">https://conda.io/miniconda.html</A></TT>
<P>
The conda package uses Travis CI for continuous integration with
automatic deployment to Anaconda Cloud. One can download only the package or the
package including the python interface.
<P>
After the installation, the binaries will be available in your path.
<P>
Please remember to clear shared memory after installation.
<PRE>
#displays list of shared memeory segments
ipcs -m
#remove segments that have nattach equal to zero. They key is the first column
ipcrm -M [key]
</PRE>
<P>
<UL>
<LI>Only the package
<PRE>
#Add conda channels
conda config --add channels conda-forge
conda config --add channels slsdetectorgroup
#Install latest version
conda install sls_detector_software
#Install specific release (GLIBC2.14)
conda install sls_detector_software=4.0.0
#Scientific Linux 6 version (GLIBC2.12)
conda install sls_detector_software=SL6_4.0.0
</PRE>
</LI>
<LI>The package including Python interface
<PRE>
#Add conda channels
conda config --add channels conda-forge
conda config --add channels sls_detector
#Install latest version
conda install sls_detector
#Install specific release (GLIBC2.14)
conda install sls_detector=4.0.0
#Scientific Linux 6 version (GLIBC2.12)
conda install sls_detector=SL6_4.0.0
</PRE>
</LI>
</UL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,35 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Install via Source Code</TITLE>
<META NAME="description" CONTENT="Install via Source Code">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H1><A NAME="SECTION00040000000000000000">
Install via Source Code</A>
</H1>
This section is useful if one wants to use the API and embed it in their
acquisition system, or if one wants to download the source code and compile.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,39 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>JUNGFRAU</TITLE>
<META NAME="description" CONTENT="JUNGFRAU">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00054000000000000000">
JUNGFRAU</A>
</H2>
<P>
In such cases, the users are not expected to compile the software
themselves (which would require dedicated softwares) but only to download on the
detector board the programming files and/or software package provided by
the SLS Detectors group.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,135 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>JUNGFRAU Firmware</TITLE>
<META NAME="description" CONTENT="JUNGFRAU Firmware">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00054100000000000000">
JUNGFRAU Firmware</A>
</H3>
<I>For SLS Detector Package v4.0.0</I>
<BR>
Minimum compatible version: 15.06.2018
<BR>
Latest version: 15.06.2018
<BR>
<P>
At times, one has to update the firmware, which then also requires updating the
on-board software.
<P>
<B><I>Jungfrau firmware can be upgraded via the SLS Detector Package
binaries from the command line.</I></B>
<P>
<OL>
<LI>One must get the latest package's corresponding POF file from the SLS
Detector Group.
</LI>
<LI>Update the latest SLS Detector package installed.
</LI>
<LI>Update the on-board software as per the instructions in the next
section.
</LI>
<LI>Start the on-board server in debug mode:
<OL>
<LI>Connect to the blackfin on the detector
<BR><code>telnet bchipxxx</code>
</LI>
<LI>Prevent existing on-board server from respawning by:
<OL>
<LI>Edit <code>/etc/inittab</code>
</LI>
<LI>Comment out the line
<code>#ttyS0::respawn:/jungfrauDetectorServervxxx</code>
</LI>
<LI>Reboot blackfin using <code>reboot</code>
</LI>
<LI>Run <code>ps</code> to ensure no gotthardDetectorServers are running
</LI>
</OL>
</LI>
<LI>Start the server in debug mode using:
<BR><code>./jungfrauDetectorServerxxx -debug</code>
<BR>
Leave this console on to come back to it later.
</LI>
</OL>
</LI>
<LI>From the command line of the pc, clear shared memory
<BR><code>./sls_detector_get free</code>
<BR>
If one gets shmget error, please clean the shared memory properly using the
script in <code>slsDetectorPackage/cleansharedmemory.sh</code>
</LI>
<LI>Add the detector to shared memory using
<BR><code>./sls_detector_put hostname bchipxxx</code>
</LI>
<LI>Program the FPGA using
<BR><code>./sls_detector_put programfpga xxx.pof</code>
</LI>
<LI>Once the programming is done:
<OL>
<LI>Switch to the console that has the debug server running and kill it
using Ctrl+C and ensure no jungfrauDetectorServers are
running
</LI>
<LI>Restart the new server to see if it runs with the new firmware
<BR><code>./jungfrauDetectorServerxxx</code>
<BR>
If the server didn't start properly, please contact us with the error message
shown when starting the server up, else continue with the following steps.
</LI>
<LI>Respawn the new server (server starts at detector statup):
<OL>
<LI>Edit <code>/etc/inittab</code>
</LI>
<LI>Uncomment out the line
<code>ttyS0::respawn:/jungfrauDetectorServervxxx</code>
</LI>
<LI>Reboot blackfin using <code>reboot</code>
</LI>
<LI>Run <code>ps</code> to ensure that both the gotthardDetectorServers are
running.
<BR><code>jungfrauDetectorServervxxx</code>
<BR><code>jungfrauDetectorServervxxx 1953</code>
</LI>
</OL>
</LI>
</OL>
<P>
</LI>
</OL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,89 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>JUNGFRAU On-board Software</TITLE>
<META NAME="description" CONTENT="JUNGFRAU On-board Software">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00054200000000000000">
JUNGFRAU On-board Software</A>
</H3>
Every SLS Detector package release will have its coresponding matching on-board
server under <B>slsDetectorPackage/serverBin</B>.
<P>
<OL>
<LI>Install tftp if the pc does not have it.
</LI>
<LI>Copy the server from serverBin folder to /tftpboot (or equivalent tftp
folder) of the pc
</LI>
<LI>Copy the server to the detector by:
<OL>
<LI>Connect to the blackfin on the detector
<BR><code>telnet bchipxxx</code>
</LI>
<LI>Prevent existing on-board server from respawning by:
<OL>
<LI>Edit <code>/etc/inittab</code>
</LI>
<LI>Comment out the line
<code>#ttyS0::respawn:/jungfrauDetectorServervxxx</code>
</LI>
<LI>Reboot blackfin using <code>reboot</code>
</LI>
<LI>Run <code>ps</code> to ensure no gotthardDetectorServers are running
</LI>
</OL>
</LI>
<LI>Copy new on-board server from pc to the blackfin using:
<BR><code>tftp pcxxx -r jungfrauDetectorServervxxx -g</code>
</LI>
<LI>Respawn the new server (server starts at detector statup):
<OL>
<LI>Edit <code>/etc/inittab</code>
</LI>
<LI>Uncomment out the line
<code>ttyS0::respawn:/jungfrauDetectorServervxxx</code>
</LI>
<LI>Reboot blackfin using <code>reboot</code>
</LI>
<LI>Run <code>ps</code> to ensure that both the gotthardDetectorServers are
running.
<BR><code>jungfrauDetectorServervxxx</code>
<BR><code>jungfrauDetectorServervxxx 1953</code>
</LI>
</OL>
</LI>
</OL>
</LI>
</OL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,37 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>MYTHEN</TITLE>
<META NAME="description" CONTENT="MYTHEN">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00051000000000000000">
MYTHEN</A>
</H2>
In such cases, the users are not expected to compile the software
themselves (which would require dedicated softwares) but only to download on the
detector board the programming files and/or software package provided by
the SLS Detectors group.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,79 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>MYTHEN Firmware</TITLE>
<META NAME="description" CONTENT="MYTHEN Firmware">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00051100000000000000">
MYTHEN Firmware</A>
</H3>
<P>
To upgrade the firmware you need either a working version of the Altera
Quartus software or of the Quartus programmer, which can easily be downloaded
from:
<BR><TT><A NAME="tex2html4"
HREF="https://www.altera.com/download/programming/quartus2/pq2-index.jsp">https://www.altera.com/download/programming/quartus2/pq2-index.jsp</A></TT>
<P>
<BR>
<P>
Normally, installation of the software and of the driver for the
USB-Blaster (provided together with the MYTHEN detector) are simpler under
Windows.
<P>
Under Windows, the first time that you connect the USB-Blaster to one
of your USB ports, you will be asked to install new hardware. Set the path to
search for the driver to:
<code>C:\altera\80sp1\qprogrammer\drivers\usb-blasterp</code> (where
<code>C:\altera\80sp1\qprogrammer\</code> is assumed to be ther path where your
Quartus version is installed).
<OL>
<LI>After starting the Quartus programmer, click on Hardware Setup and in the
"Currently selected hardware" window select USB-Blaster.
</LI>
<LI>In the Mode combo box select "Active Serial Programming".
</LI>
<LI>Plug the end of your USB-Blaster WITH THE ADAPTER PROVIDED in the
connector ASMI on the MCS board taking care that pin1 corresponds to the one
indexed and with the rectangualr pad.
</LI>
<LI>Click on add file and from select the programming file provided when
the upgrade has been reccomended.
</LI>
<LI>Check "Program/Configure" and "Verify".
</LI>
<LI>Push the start button and wait until the programming process is
finished (progress bar top left).
</LI>
<LI>In case the programmer gives you error messages, check the polarity of
your cable (pin1 corresponds) and that you have selected the correct programming
connector.
</LI>
</OL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,83 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>MYTHEN On-board Software</TITLE>
<META NAME="description" CONTENT="MYTHEN On-board Software">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00051200000000000000">
MYTHEN On-board Software</A>
</H3>
<OL>
<LI>Connect to the board using telnet:
<PRE>
telnet mymcs.mydomain.com
username: root
password: pass
</PRE>
</LI>
<LI>Kill currently running servers and ensure <code>/mnt/flash/root</code> exists.
<PRE>
killall mythenDetectorServer
ls /mnt/flash/root
#if the directory does not exist mkdir /mnt/flash/root
</PRE>
</LI>
<LI>Transfer the provided software by ftp to the MCS.
<PRE>
ftp mymcs.mydomain.com
username: root
password: pass
cd /mnt/flash/root
put mythenDetectorServer
quit
</PRE>
<P>
</LI>
<LI>After pressing reset on the board, the board should reboot.
<P>
</LI>
<LI>If the program does not correctly start
<OL>
<LI>Check by using the http interface that it is started by the inittab
(check that the file <code>/mnt/etc/inittab</code> ends with the line
<BR><code>myid2:3:once:/mnt/flash/root/mythenDetectorServer</code>).
</LI>
<LI>If program has not started, make the program executable by telnetting to
the MCS and executing:
<BR><code>chmod a+xrw /mnt/flash/root/mythenDetectorServer</code>
</LI>
<LI>After pressing reset on the board, the board should reboot and the
acqusition program correctly start.
</LI>
</OL>
</LI>
</OL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,80 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Qt4 Installation for GUI</TITLE>
<META NAME="description" CONTENT="Qt4 Installation for GUI">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00042100000000000000">
Qt4 Installation for GUI</A>
</H3>
It must be installed before Qwt. A Qt version equal or higher than 4.6 is
required. One can install it:
<UL>
<LI>via YUM:
<PRE>
yum install qt-devel
</PRE>
</LI>
<LI>via download from:
<BR><TT><A NAME="tex2html2"
HREF="
https://download.qt.io/archive/qt/4.8/4.8.2/qt-everywhere-opensource-src-4.8.2.t
ar.gz">https://download.qt.io/archive/qt/4.8/4.8.2/qt-everywhere-opensource-src-4.8.2.t
ar.gz</A></TT>
<P>
To install:
<PRE>
&gt; gunzip qt-everywhere-opensource-src-4.8.2.tar.gz
&gt; tar xvf qt-everywhere-opensource-src-4.8.2.tar
&gt; ./configure
&gt; make
&gt; make install
</PRE>
By default Qt4 will be installed in /usr/local/Trolltech/Qt-4.8.2/.
</LI>
</UL>
<P>
<B>Setup Environment</B>
<P>
One has to ensure that <code>PATH</code> and <code>LD_LIBRARY_PATH</code> have
been updated to include Qt4 install path, binaries and libraries.
Confirm by executing <code>qmake -v</code> and ensuring the result points to Qt4 (not
Qt3 or Qt5).
<P>
If the environment is not set up, one can add the libraries and
executables to the .bashrc by adding
<code>LD_LIBRARY_PATH</code> and <code>PATH</code>:
<PRE>
export QTDIR=/usr/local/Trolltech/Qt-4.8.2
export PATH=$QTDIR/bin:$PATH
export LD_LIBRARY_PATH=$QTDIR/lib:$LD_LIBRARY_PATH
</PRE>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,78 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Qwt Installation for GUI</TITLE>
<META NAME="description" CONTENT="Qwt Installation for GUI">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00042200000000000000">
Qwt Installation for GUI</A>
</H3>
Before installing Qwt, one must install Qt
and ensure that <code>QTDIR</code>, <code>LD_LIBRARY_PATH</code> and <code>PATH</code> point to
the correct Qt4
version.
<P>
A Qwt version equal or higher than 6 is required. One can
install it:
<UL>
<LI>via YUM:
<PRE>
yum install qwt-devel
</PRE>
</LI>
<LI>via download from:
<BR><TT><A NAME="tex2html3"
HREF="
https://sourceforge.net/projects/qwt/files/qwt/6.0.0/qwt-6.0.0.zip/download">https://sourceforge.net/projects/qwt/files/qwt/6.0.0/qwt-6.0.0.zip/download</A></TT>
<P>
To install:
<PRE>
&gt; cd qwt-6.0.0
&gt; qmake
&gt; make
&gt; make install
</PRE>
By default Qwt will be installed int /usr/local/qwt-6.0.0
</LI>
</UL>
<P>
<B>Setup Environment</B>
<P>
One has to ensure that <code>QWTDIR</code> and <code>LD_LIBRARY_PATH</code> have
been updated to include Qwt install path and libraries.
<P>
If the environment is not set up, one can add the libraries to the
.bashrc by adding <code>LD_LIBRARY_PATH</code>:
<PRE>
export QWTDIR=/usr/local/qwt-6.0.0/
export LD_LIBRARY_PATH=$QWTDIR/lib:$LD_LIBRARY_PATH
</PRE>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,82 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Requirements</TITLE>
<META NAME="description" CONTENT="Requirements">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00042000000000000000">
Requirements</A>
</H2>
These are the basic requirements to install and use the software. Fine Tuning
the system will be discussed in other documentation provided.
<UL>
<LI><I>C/C++</I>:
<BR>
The software is written in C/C++. If Python API is used, it is a wrap around
to the C++ software. Any Linux installation with working libgcc should be
sufficient.
<P>
</LI>
<LI><I>Shared Memory</I>:
<BR>
Access to the shared memory of the control PC is required for the client.
<P>
</LI>
<LI><I>Network</I>:
<BR>
The control PC communicates to the detectors and data receivers over TCP/IP.
Therefore, the detector should receive a proper IP address (either DHCP or
static) and no firewall should be present between the control PC and the
detector.
<P>
</LI>
<LI><I>Compilation</I>:
<BR>
cmake is required to compile. make is also possible, but is harder to find
dependencies.
<P>
</LI>
<LI><I>GUI</I>:
<BR>
To use the GUI, one requires atleast Qt4.8.2 and Qwt6.0. Installation of these
are discussed in the next sections.
<P>
</LI>
<LI><I>Calibration Wizards</I>:
<BR>
They are based on the CERN Root data analysis framework. Installation of it is
discussed in the next sections.
<P>
</LI>
</UL>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,63 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Root Installation for Calibration Wizards</TITLE>
<META NAME="description" CONTENT="Root Installation for Calibration Wizards">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00042300000000000000">
Root Installation for Calibration Wizards</A>
</H3>
The software has been developed and tested with root 5.20, but any version
should work. One can download it from:
<PRE>
&gt; svn co https://root.cern.ch/svn/root/trunk root
</PRE>
<P>
To install:
<PRE>
&gt; cd root
&gt; ./configure --enable-qt
&gt; make
&gt; make install
</PRE>
<P>
Edit your .bashrc to define the ROOTSYS enviroment variable and annd
the libraries and executables to the <code>LD_LIBRARY_PATH</code> and <code>PATH</code>:
<PRE>
export ROOTSYS=/usr/local/root-5.34
export PATH=$ROOTSYS/bin:$PATH
export LD_LIBRARY_PATH=$ROOTSYS/lib:$LD_LIBRARY_PATH
</PRE>
<P>
You can also download the binaries, assuming that your linux and gcc versions
match as in:
<PRE>
http://root.cern.ch/drupal/content/production-version-534
</PRE>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,34 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Setting environment variables</TITLE>
<META NAME="description" CONTENT="Setting environment variables">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H2><A NAME="SECTION00044000000000000000">
Setting environment variables</A>
</H2>
One can set up the environment variables in the following ways.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,45 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>The Software Package</TITLE>
<META NAME="description" CONTENT="The Software Package">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H1><A NAME="SECTION00020000000000000000">
The Software Package</A>
</H1>
The SLS detectors software is intended to control the detectors developed by
the SLS Detectors group. The detectors currently supported are:
<P>
MYTHEN, GOTTHARD, EIGER and JUNGFRAU.
<P>
The package provides software for the distributed system that comprises of
detectors, data receivers (to process detector data), and the client (to control
or monitor the system). The client and data receivers can be embedded in
the user's acquisitions system. Furthermore, the package also provides some
tools for detector calibration.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,37 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Software Upgrade</TITLE>
<META NAME="description" CONTENT="Software Upgrade">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H1><A NAME="SECTION00050000000000000000">
Software Upgrade</A>
</H1>
<P>
The upgrade of the package could require an upgrade of the on-board detector
server and/or firmware running on the detector as well.
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,67 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Using .bashrc file</TITLE>
<META NAME="description" CONTENT="Using .bashrc file">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00044100000000000000">
Using .bashrc file</A>
</H3>
<OL>
<LI><code>emacs ~/.bashrc</code>
</LI>
<LI>Add the following function <code>setup_slsdet</code> and replace <code>path</code>
with absolute path of installed directory
<PRE>
function setup_slsdet
{
export PKGPATH=[path]
export LD_LIBRARY_PATH=$PKGPATH/slsDetectorPackage/build/bin:$LD_LIBRARY_PATH
export PATH=$PKGPATH/slsDetectorPackage/build/bin:$PATH
cd $PKGPATH/slsDetectorPackage/build/bin
}
</PRE>
</LI>
<LI><code>source ~/.bashrc</code>
</LI>
<LI>Next time, just run <code>setup_slsdet</code> to load the environment
variables.
</LI>
</OL>
<P>
One can also add the GUI environment variables if installed locally by adding
the following in the function <code>setup_sldet</code>
<BR><PRE>
export QTDIR=/path-where-it-is/Qt-4.8.2
export QWTDIR=/path-where-it-is/qwt-6.0.1
export QWT3D=/path-where-it-is/qwtplot3d
export QMAKESPEC=$QTDIR/mkspecs/linux-g++
export LD_LIBRARY_PATH=$QTDIR/lib:$QWTDIR/lib:$QWT3D/lib:$LD_LIBRARY _PATH
export PATH=$QTDIR/bin:$PATH
</PRE>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,82 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Using script cmk.sh</TITLE>
<META NAME="description" CONTENT="Using script cmk.sh">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00043100000000000000">
Using script cmk.sh</A>
</H3>
The script uses <code>cmake</code>. After compiling, the libraries and executables
will be found in `slsDetectorPackage/build/bin` directory.
Usage: [-c] [-b] [-h] [-d HDF5 directory] [-j]
<UL>
<LI>-[no option]: only make
</LI>
<LI>-c: Clean
</LI>
<LI>-b: Builds/Rebuilds CMake files normal mode
</LI>
<LI>-h: Builds/Rebuilds Cmake files with HDF5 package
</LI>
<LI>-d: HDF5 Custom Directory
</LI>
<LI>-t: Build/Rebuilds only text client
</LI>
<LI>-r: Build/Rebuilds only receiver
</LI>
<LI>-g: Build/Rebuilds only gui
</LI>
<LI>-j: Number of threads to compile through
</LI>
</UL>
<P>
Some example options for compilation:
<P>
Most basic option: <code>./cmk.sh -b</code>
<P>
For only make: <code>./cmk.sh</code>
<P>
For make clean;make: <code>./cmk.sh -c</code>
<P>
For using hdf5 without custom dir /blabla: <code>./cmk.sh -h -d /blabla</code>
<P>
For rebuilding cmake without hdf5: <code>./cmk.sh -b</code>
<P>
For using multiple cores to compile faster: <code>./cmk.sh -j9</code>
<P>
For rebuilding only certain parts: <code>./cmk.sh -tg</code> (only text client and
gui)
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,2 @@
No implementation found for style `graphicx'
No implementation found for style `hyperref'

View File

@ -0,0 +1,38 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Without .bashrc file</TITLE>
<META NAME="description" CONTENT="Without .bashrc file">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<H3><A NAME="SECTION00044200000000000000">
Without .bashrc file</A>
</H3>
Go to binaries folder slsDetectorPackage/build/bin and execute the following:
<PRE>
export LD_LIBRARY_PATH=$PWD:$LD_LIBRARY_PATH
export PATH=$PWD:$PATH
</PRE>
<P>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,36 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>SLS Detectors software installation</TITLE>
<META NAME="description" CONTENT="SLS Detectors software installation">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<P>
<H1 ALIGN="CENTER">SLS Detectors software installation</H1>
<DIV>
<P ALIGN="CENTER"><STRONG>Anna Bergamaschi, Dhanya Thattil</STRONG></P>
<P ALIGN="CENTER"><STRONG>August 23, 2018</STRONG></P>
</DIV>
<BR><HR>
</BODY>
</HTML>

View File

@ -0,0 +1,13 @@
# LaTeX2HTML 2012 (1.2)
# Associate labels original text with physical files.
1;
# LaTeX2HTML 2012 (1.2)
# labels from external_latex_labels array.
1;

View File

@ -0,0 +1,30 @@
/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
.MATH { font-family: "Century Schoolbook", serif; }
.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
/* implement both fixed-size and relative sizes */
SMALL.XTINY { font-size : xx-small }
SMALL.TINY { font-size : x-small }
SMALL.SCRIPTSIZE { font-size : smaller }
SMALL.FOOTNOTESIZE { font-size : small }
SMALL.SMALL { }
BIG.LARGE { }
BIG.XLARGE { font-size : large }
BIG.XXLARGE { font-size : x-large }
BIG.HUGE { font-size : larger }
BIG.XHUGE { font-size : xx-large }
/* heading styles */
H1 { }
H2 { }
H3 { }
H4 { }
H5 { }
/* mathematics styles */
DIV.displaymath { } /* math displays */
TD.eqno { } /* equation-number cells */
/* document-specific styles come next */

View File

@ -0,0 +1,36 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2012 (1.2)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>SLS Detectors software installation</TITLE>
<META NAME="description" CONTENT="SLS Detectors software installation">
<META NAME="keywords" CONTENT="slsDetectorInstall">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2012">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="slsDetectorInstall.css">
</HEAD>
<BODY >
<P>
<H1 ALIGN="CENTER">SLS Detectors software installation</H1>
<DIV>
<P ALIGN="CENTER"><STRONG>Anna Bergamaschi, Dhanya Thattil</STRONG></P>
<P ALIGN="CENTER"><STRONG>August 23, 2018</STRONG></P>
</DIV>
<BR><HR>
</BODY>
</HTML>