<p>pespin has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-gsm-tester/+/18059">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">doc: install.adoc: Correctly split optional dependencies<br><br>Change-Id: Id8b5dcd15fd86c670915b928112699d831e6e7b0<br>---<br>M doc/manuals/chapters/install.adoc<br>1 file changed, 59 insertions(+), 18 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-tester refs/changes/59/18059/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/manuals/chapters/install.adoc b/doc/manuals/chapters/install.adoc</span><br><span>index ed38296..445b53c 100644</span><br><span>--- a/doc/manuals/chapters/install.adoc</span><br><span>+++ b/doc/manuals/chapters/install.adoc</span><br><span>@@ -324,47 +324,88 @@</span><br><span> and 'trial-N-bin.tgz' archives are produced by the 'jenkins-run.sh' script,</span><br><span> both for successful and failing runs.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-==== Install osmo-gsm-tester</span><br><span style="color: hsl(120, 100%, 40%);">+==== Install osmo-gsm-tester dependencies</span><br><span> </span><br><span> This assumes you have already created the jenkins user (see <<configure_jenkins_slave>>).</span><br><span> </span><br><span> Dependencies needed will depend on lots of factors, like your distribution, your</span><br><span> specific setup, which hardware you plan to support, etc.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-On a Debian/Ubuntu based system, these commands install the packages needed to</span><br><span style="color: hsl(0, 100%, 40%);">-run the osmo-gsm-tester.py code, i.e. install these on your main unit:</span><br><span style="color: hsl(120, 100%, 40%);">+On a Debian/Ubuntu based system, these commands install the mandatory packages</span><br><span style="color: hsl(120, 100%, 40%);">+needed to run the osmo-gsm-tester.py code, i.e. install these on your main unit:</span><br><span> </span><br><span> ----</span><br><span> apt-get install \</span><br><span style="color: hsl(0, 100%, 40%);">- dbus \</span><br><span style="color: hsl(0, 100%, 40%);">- tcpdump \</span><br><span style="color: hsl(0, 100%, 40%);">- sqlite3 \</span><br><span> python3 \</span><br><span style="color: hsl(0, 100%, 40%);">- python3-setuptools \</span><br><span> python3-yaml \</span><br><span> python3-mako \</span><br><span> python3-gi \</span><br><span style="color: hsl(0, 100%, 40%);">- python3-numpy \</span><br><span style="color: hsl(0, 100%, 40%);">- python3-wheel \</span><br><span style="color: hsl(0, 100%, 40%);">- ofono \</span><br><span style="color: hsl(0, 100%, 40%);">- patchelf \</span><br><span style="color: hsl(0, 100%, 40%);">- sudo \</span><br><span style="color: hsl(0, 100%, 40%);">- libcap2-bin \</span><br><span style="color: hsl(0, 100%, 40%);">- python3-pip \</span><br><span style="color: hsl(0, 100%, 40%);">- udhcpc \</span><br><span style="color: hsl(0, 100%, 40%);">- iperf3 \</span><br><span> locales</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+If one plans to use the 2G ESME (_esme.py_), following extra dependencies shall</span><br><span style="color: hsl(120, 100%, 40%);">+be installed:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+apt-get install python3-setuptools python3-pip</span><br><span style="color: hsl(120, 100%, 40%);">+pip3 install "git+https://github.com/podshumok/python-smpplib.git@master#egg=smpplib"</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+If one plans to use the 2G OsmoHLR (_hlr_osmo.py_), following extra dependencies shall</span><br><span style="color: hsl(120, 100%, 40%);">+be installed:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+apt-get install sqlite3</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+If one plans to use SISPM power supply hardware (_powersupply_sispm.py_),</span><br><span style="color: hsl(120, 100%, 40%);">+following extra dependencies shall be installed:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+apt-get install python3-setuptools python3-pip</span><br><span> pip3 install \</span><br><span style="color: hsl(0, 100%, 40%);">- "git+https://github.com/podshumok/python-smpplib.git@master#egg=smpplib" \</span><br><span style="color: hsl(0, 100%, 40%);">- pydbus \</span><br><span> pyusb \</span><br><span> pysispm</span><br><span> ----</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+If one plans to use software-based RF emulation on Amarisoft ENB implemented</span><br><span style="color: hsl(120, 100%, 40%);">+through its CTRL interface (_rfemu_amarisoftctrl.py_), following extra</span><br><span style="color: hsl(120, 100%, 40%);">+dependencies shall be installed:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+apt-get install python3-websocket</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+If one plans to use srsLTE UE metrics subsystems (_ms_srs.py_), following extra</span><br><span style="color: hsl(120, 100%, 40%);">+dependencies shall be installed:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+apt-get install python3-numpy</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+If one plans to use ofono modems (_ms_ofono.py_), following extra dependencies</span><br><span style="color: hsl(120, 100%, 40%);">+shall be installed:</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+apt-get install \</span><br><span style="color: hsl(120, 100%, 40%);">+ dbus \</span><br><span style="color: hsl(120, 100%, 40%);">+ python3 \</span><br><span style="color: hsl(120, 100%, 40%);">+ ofono \</span><br><span style="color: hsl(120, 100%, 40%);">+ python3-pip \</span><br><span style="color: hsl(120, 100%, 40%);">+ udhcpc</span><br><span style="color: hsl(120, 100%, 40%);">+pip3 install \</span><br><span style="color: hsl(120, 100%, 40%);">+ pydbus</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> IMPORTANT: ofono may need to be installed from source to contain the most</span><br><span> recent fixes needed to operate your modems. This depends on the modem hardware</span><br><span> used and the tests run. Please see <<hardware_modems>>.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+Finally, these programs are usually required by osmo-gsm-tester on the Slave Unit to run and manage processes:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+apt-get install \</span><br><span style="color: hsl(120, 100%, 40%);">+ tcpdump \</span><br><span style="color: hsl(120, 100%, 40%);">+ patchelf \</span><br><span style="color: hsl(120, 100%, 40%);">+ sudo \</span><br><span style="color: hsl(120, 100%, 40%);">+ libcap2-bin \</span><br><span style="color: hsl(120, 100%, 40%);">+ iperf3</span><br><span style="color: hsl(120, 100%, 40%);">+----</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> ==== User Permissions</span><br><span> </span><br><span> On the main unit, create a group for all users that should be allowed to use</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-gsm-tester/+/18059">change 18059</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-gsm-tester/+/18059"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-gsm-tester </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Id8b5dcd15fd86c670915b928112699d831e6e7b0 </div>
<div style="display:none"> Gerrit-Change-Number: 18059 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>