diff --git a/doc/models/Makefile b/doc/models/Makefile index f9ced2a5c..2dd3991bb 100644 --- a/doc/models/Makefile +++ b/doc/models/Makefile @@ -33,6 +33,7 @@ SOURCES = \ $(SRC)/lte/doc/source/lte-user.rst \ $(SRC)/lte/doc/source/lte-design.rst \ $(SRC)/lte/doc/source/lte-testing.rst \ + $(SRC)/lte/doc/source/lte-references.rst \ $(SRC)/propagation/doc/propagation.rst \ $(SRC)/network/doc/network-overview.rst \ $(SRC)/network/doc/packets.rst \ @@ -53,7 +54,11 @@ SOURCES = \ $(SRC)/flow-monitor/doc/flow-monitor.rst \ # list all model library figure files that need to be copied to -# $SOURCETEMP/figures. Either a .dia or both a .pdf and .png +# $SOURCETEMP/figures. For each figure to be included in all +# documentation formats (html, latex...) the following formats are supported: +# 1) a single .dia file (preferred option, because it can be edited) +# 2) a single .eps file +# 3) both a .pdf and .png file SOURCEFIGS = \ figures/testbed.dia \ figures/emulated-channel.dia \ @@ -72,11 +77,18 @@ SOURCEFIGS = \ $(SRC)/lte/doc/source/figures/ff-example.dia \ $(SRC)/lte/doc/source/figures/lte-enb-architecture.dia \ $(SRC)/lte/doc/source/figures/lte-ue-architecture.dia \ + $(SRC)/lte/doc/source/figures/lte-interference-test-scenario.dia \ + $(SRC)/lte/doc/source/figures/lte-mcs-index.eps \ + $(SRC)/lte/doc/source/figures/lenaThrTestCase1.eps \ + $(SRC)/lte/doc/source/figures/lenaThrTestCase2.eps \ + $(SRC)/lte/doc/source/figures/simulationTime.eps \ + $(SRC)/lte/doc/source/figures/memoryUsage.eps \ $(SRC)/uan/doc/auvmobility-classes.dia \ $(SRC)/netanim/doc/animation-dumbbell.png \ $(SRC)/netanim/doc/animation-dumbbell.pdf \ -# specify figures for build process (all dia figures) +# specify figures from which .png and .pdf figures need to be +# generated (all dia and eps figures) IMAGES_EPS = \ $(FIGURES)/testbed.eps \ $(FIGURES)/emulated-channel.eps \ @@ -95,9 +107,15 @@ IMAGES_EPS = \ $(FIGURES)/ff-example.eps \ $(FIGURES)/lte-enb-architecture.eps \ $(FIGURES)/lte-ue-architecture.eps \ + $(FIGURES)/lte-interference-test-scenario.eps \ + $(FIGURES)/lte-mcs-index.eps \ + $(FIGURES)/lenaThrTestCase1.eps \ + $(FIGURES)/lenaThrTestCase2.eps \ + $(FIGURES)/simulationTime.eps \ + $(FIGURES)/memoryUsage.eps \ $(FIGURES)/auvmobility-classes.eps \ -# rescale figures as necessary +# rescale pdf figures as necessary $(FIGURES)/testbed.pdf_width = 5in $(FIGURES)/emulated-channel.pdf_width = 6in $(FIGURES)/node.pdf_width = 5in @@ -119,6 +137,7 @@ IMAGES = $(IMAGES_EPS) $(IMAGES_PNG) $(IMAGES_PDF) %.eps : %.dia; $(DIA) -t eps $< -e $@ %.png : %.dia; $(DIA) -t png $< -e $@ +%.png : %.eps; $(CONVERT) $< $@ %.pdf : %.eps; $(EPSTOPDF) $< -o=$@; if test x$($@_width) != x; then TMPFILE=`mktemp`; ./rescale-pdf.sh $($@_width) $@ $${TMPFILE} && mv $${TMPFILE} $@; fi # You can set these variables from the command line. diff --git a/src/lte/doc/source/lte-design.rst b/src/lte/doc/source/lte-design.rst index 43df70960..537343604 100644 --- a/src/lte/doc/source/lte-design.rst +++ b/src/lte/doc/source/lte-design.rst @@ -219,6 +219,8 @@ can be used because of the SC-FDMA modulation. As a consequence, all RBs can be allocated by the eNB regardless of the bandwidth configuration. +.. _sec-lte-amc: + Adaptive Modulation and Coding ++++++++++++++++++++++++++++++ diff --git a/src/lte/doc/source/lte-testing.rst b/src/lte/doc/source/lte-testing.rst index 7326cd7ce..09053b954 100644 --- a/src/lte/doc/source/lte-testing.rst +++ b/src/lte/doc/source/lte-testing.rst @@ -101,6 +101,8 @@ deals with floating point arithmetic approximation issues. System Tests ~~~~~~~~~~~~ +.. _sec-lte-amc-tests: + Adaptive Modulation and Coding Tests ------------------------------------ @@ -110,7 +112,7 @@ corresponding to different SNR values perceived by the UE. The aim of the test is to check that in each test case the chosen MCS corresponds to some known reference values. These reference values are obtained by re-implementing in Octave (see `src/lte/test/reference/lte_amc.m`) the -model described in Section :ref:`Adaptive Modulation and Coding` for the calculation of the +model described in Section :ref:`sec-lte-amc` for the calculation of the spectral efficiency, and determining the corresponding MCS index by manually looking up the tables in [R1-081483]_. The resulting test vector is represented in Figure :ref:`fig-lte-mcs-index`. @@ -119,7 +121,7 @@ The MCS which is used by the simulator is measured by obtaining the tracing output produced by the scheduler after 4ms (this is needed to account for the initial delay in CQI reporting). The SINR which is calcualted by the simulator is also obtained using the -`LteSinrChunkProcessor``interface. The test +``LteSinrChunkProcessor`` interface. The test passes if both the following conditions are satisfied: #. the SINR calculated by the simulator correspond to the SNR @@ -134,6 +136,8 @@ passes if both the following conditions are satisfied: Test vector for Adaptive Modulation and Coding + + Inter-cell Interference Tests ----------------------------- @@ -165,7 +169,7 @@ The test vectors are obtained by use of a dedicated octave script the link budget calculations (including interference) corresponding to the topology of each test case, and outputs the resulting SINR and spectral efficiency. The latter is then used to determine (using the same procedure adopted for -:ref:`Inter-cell Interference Tests`. We note that the test vector +:ref:`sec-lte-amc-tests`. We note that the test vector contains separate values for uplink and downlink.