Skip to content

Commit ee50b3c

Browse files
committed
modify doc/thz.rst
1 parent 1b5dae5 commit ee50b3c

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

doc/thz.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ In this module, it tests the link-layer transmission performance of the nanoscal
1515
Model Description
1616
*****************
1717

18-
The source code for the new module lives in the directory ``src/thz``.
18+
The source code for the new module lives in the directory ``/thz``.
1919

20-
* The frequency database file (data_frequency.txt) and the corresponding molecular absorption coefficient database file (data_AbsCoe.txt) are located inside ``src/thz/model``.
20+
* The frequency database file (data_frequency.txt) and the corresponding molecular absorption coefficient database file (data_AbsCoe.txt) are located inside ``/thz/model``.
2121

2222
Design
2323
======
@@ -38,7 +38,7 @@ Design
3838
Scope and Limitations
3939
=====================
4040

41-
* In its current state, the THz system module is adapt to the latest ns-3 version (ns-3.29)
41+
* In its current state, the THz system module is adapt to the latest ns-3 version (ns-3.30)
4242
* As of now, the ns-3 interface to THz is Ipv4 only.
4343

4444
References
@@ -57,24 +57,24 @@ The first step is to clone THz from the github repository and build it::
5757
$ git clone https://github.com/UBnano-Terasim/Terasim-ns3
5858
$ cd Terasim-ns3
5959

60-
Copy the thz folder to your local source folder of ns-3 directory (../ns-allinone-3.29/ns-3.29/src), then go back to ns-allinone-3.29 folder to build the THz module by::
60+
Copy the thz folder to your local source folder of ns-3 directory (../ns-allinone-3.30/ns-3.30/contrib), then go back to ns-allinone-3.30 folder to build the THz module by::
6161

6262
$ cd ../..
6363
$ ./build.py
6464
65-
Once THz has been built successfully, try to run one of the examples (i.e., nano-adhoc.cc). First, you need to copy this example from ns-3.29/src/thz/examples to ns-3.29/scratch::
65+
Once THz has been built successfully, try to run one of the examples (i.e., nano-adhoc.cc). First, you need to copy this example from ../thz/examples to ns-3.30/scratch::
6666

67-
$ cp ns-3.29/src/thz/examples/nano-adhoc.cc ns-3.29/scratch/nano-adhoc.cc
67+
$ cp ns-3.30/contrib/thz/examples/nano-adhoc.cc ns-3.30/scratch/nano-adhoc.cc
6868

69-
Then enter the ns-3.29 folder and run the example::
69+
Then enter the ns-3.30 folder and run the example::
7070

71-
$ cd ns-3.29
71+
$ cd ns-3.30
7272
$ ./waf --run scratch/nano-adhoc
7373

7474

7575
Helpers
7676
=======
77-
All the helper files can be found in ``src/thz/helper/``:
77+
All the helper files can be found in ``/thz/helper/``:
7878

7979
* THzHelper: helps to create THzNetDevice objects:
8080
* THzMacHelper: create THz MAC layers for THzNetDevice
@@ -148,7 +148,7 @@ The link layer performance in terms of the throughput and the discarding probabi
148148

149149
Examples
150150
===============
151-
The following examples have been written, which can be found in ``src/thz/examples/``:
151+
The following examples have been written, which can be found in ``/thz/examples/``:
152152

153153
* nano-adhoc.cc: This example file is for the nanoscale scenario of the THz-band communication networks, i.e., with transmission distance below one meter. It outputs the link layer performance mainly in terms of the throughput and the discarding probability of the DATA packets. In this example, an adhoc network architecture is implemented. User can set network topology in this file. The nodes in the nanonetwork are equipped with the energy module we developed. The basic parameters of the energy model can be set in this file. User can also set the number of samples of the TSOOK pulse within frequency range 0.9-4 THz window in this file. User can select one of the two MAC protocols that include a 0-way and a 2-way handshake protocols. 0-way starts the link layer transmission with a DATA frame and 2-way with an RTS frame. The selection can be done by setting the attribute value of EnableRts in THzMacNano. In the end, the user can also set the generated packet size and the mean value of the packet generation interval in this file.
154154

@@ -157,7 +157,7 @@ The following examples have been written, which can be found in ``src/thz/exampl
157157
Validation
158158
**********
159159

160-
This model has been tested validated by the results generated from the following test files, which can be found in ``src/thz/test``:
160+
This model has been tested validated by the results generated from the following test files, which can be found in ``/thz/test``:
161161

162162
* The test files ``test-thz-psd-macro.cc`` and ``test-thz-psd-nano.cc`` are used to plot the power spectral densities of the generated waveform by the physical layer and the received signal at certain distance for macroscale scenario and nanoscale scenario respectively.
163163
* The test file ``test-directional-antenna.cc`` plots the antenna radiation pattern of the directional antenna.

0 commit comments

Comments
 (0)