F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Update ns-3 version in tutorial examples

Browse Source
This commit is contained in:
Tom Henderson
2021-07-14 08:16:40 -07:00
parent 9319cdd791
commit 9df8ef4b29
1 changed files with 27 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
doc/tutorial/source/getting-started.rst
View File

@@ -68,14 +68,14 @@ You may want to take this opportunity to explore the |ns3| wiki
a bit, or the main web site at https://www.nsnam.org, since there is a
wealth of information there.
As of the most recent |ns3| release (ns-3.33), the following tools
As of the most recent |ns3| release (ns-3.34), the following tools
are needed to get started with |ns3|:
============ ===========================================================
Prerequisite Package/version
============ ===========================================================
C++ compiler ``clang++`` or ``g++`` (g++ version 4.9 or greater)
Python ``python3`` version >=3.5
C++ compiler ``clang++`` or ``g++`` (g++ version 7 or greater)
Python ``python3`` version >=3.6
Git any recent version (to access |ns3| from `GitLab.com <https://gitlab.com/nsnam/ns-3-dev/>`_)
tar any recent version (to unpack an `ns-3 release <https://www.nsnam.org/releases/>`_)
bunzip2 any recent version (to uncompress an |ns3| release)
@@ -124,22 +124,22 @@ get a copy of a release by typing the following into your Linux shell
$ cd
$ mkdir workspace
$ cd workspace
$ wget https://www.nsnam.org/release/ns-allinone-3.33.tar.bz2
$ tar xjf ns-allinone-3.33.tar.bz2
$ wget https://www.nsnam.org/release/ns-allinone-3.34.tar.bz2
$ tar xjf ns-allinone-3.34.tar.bz2
Notice the use above of the ``wget`` utility, which is a command-line
tool to fetch objects from the web; if you do not have this installed,
you can use a browser for this step.
Following these steps, if you change into the directory
``ns-allinone-3.33``, you should see a number of files and directories
``ns-allinone-3.34``, you should see a number of files and directories
.. sourcecode:: text
$ cd ns-allinone-3.33
$ cd ns-allinone-3.34
$ ls
bake constants.py ns-3.33 README
build.py netanim-3.108 pybindgen-0.21.0.post15+nga587377 util.py
bake constants.py ns-3.34 README
build.py netanim-3.108 pybindgen-0.22.0 util.py
You are now ready to build the base |ns3| distribution and may skip ahead
to the section on building |ns3|.
@@ -189,7 +189,7 @@ release number:
.. sourcecode:: bash
$ python3 download.py -n ns-3.33
$ python3 download.py -n ns-3.34
After this step, the additional repositories of |ns3|, bake, pybindgen,
and netanim will be downloaded to the ``ns-3-allinone`` directory.
@@ -258,10 +258,10 @@ distribution of your choice.
There are a few configuration targets available:
1. ``ns-3.33``: the module corresponding to the release; it will download
1. ``ns-3.34``: the module corresponding to the release; it will download
components similar to the release tarball.
2. ``ns-3-dev``: a similar module but using the development code tree
3. ``ns-allinone-3.33``: the module that includes other optional features
3. ``ns-allinone-3.34``: the module that includes other optional features
such as Click routing, Openflow for |ns3|, and the Network Simulation
Cradle
4. ``ns-3-allinone``: similar to the released version of the allinone
@@ -279,12 +279,12 @@ code either by inspection of the repository list or by going to the
`"ns-3 Releases"
<https://www.nsnam.org/releases>`_
web page and clicking on the latest release link. We'll proceed in
this tutorial example with ``ns-3.33``.
this tutorial example with ``ns-3.34``.
We are now going to use the bake tool to pull down the various pieces of
|ns3| you will be using. First, we'll say a word about running bake.
bake works by downloading source packages into a source directory,
Bake works by downloading source packages into a source directory,
and installing libraries into a build directory. bake can be run
by referencing the binary, but if one chooses to run bake from
outside of the directory it was downloaded into, it is advisable
@@ -307,7 +307,7 @@ Step into the workspace directory and type the following into your shell:
.. sourcecode:: bash
$ ./bake.py configure -e ns-3.33
$ ./bake.py configure -e ns-3.34
Next, we'll ask bake to check whether we have enough tools to download
various components. Type:
@@ -331,11 +331,11 @@ You should see something like the following:
> patch tool - OK
> Path searched for tools: /usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin ...
In particular, download tools such as Mercurial, CVS, Git, and Bazaar
In particular, download tools such as Git and Mercurial
are our principal concerns at this point, since they allow us to fetch
the code. Please install missing tools at this stage, in the usual
way for your system (if you are able to), or contact your system
administrator as needed to install these tools.
administrator as needed to install these tools. You can also
Next, try to download the software:
@@ -361,20 +361,18 @@ should yield something like:
>> Searching for system dependency gir-bindings - OK
>> Searching for system dependency pygobject - OK
>> Searching for system dependency cmake - OK
>> Downloading castxml-0.3.6 (target directory:castxml-0.3.6) - OK
>> Downloading netanim-3.108 - OK
>> Downloading pygccxml-2.0.1 - OK
>> Downloading pybindgen-0.21.0.post15+nga587377 (target directory:pybindgen) - OK
>> Downloading ns-3.33 (target directory:ns-3.33) - OK
>> Downloading pybindgen-0.22.0 (target directory:pybindgen) - OK
>> Downloading ns-3.34 (target directory:ns-3.34) - OK
The above suggests that five sources have been downloaded. Check the
The above suggests that three sources have been downloaded. Check the
``source`` directory now and type ``ls``; one should see:
.. sourcecode:: bash
$ cd source
$ ls
castxml-0.3.6 netanim-3.108 ns-3.33 pybindgen pygccxml-2.0.1 v2.0.1.tar.gz
netanim-3.108 ns-3.34 pybindgen
You are now ready to build the |ns3| distribution.
@@ -405,7 +403,7 @@ native |ns3| build system, Waf, to be introduced later in this tutorial.
If you downloaded
using a tarball you should have a directory called something like
``ns-allinone-3.33`` under your ``~/workspace`` directory.
``ns-allinone-3.34`` under your ``~/workspace`` directory.
Type the following:
.. sourcecode:: bash
@@ -424,7 +422,7 @@ script builds the various pieces you downloaded. First, the script will
attempt to build the netanim animator, then the pybindgen bindings generator,
and finally |ns3|. Eventually you should see the following::
Waf: Leaving directory '/path/to/workspace/ns-allinone-3.33/ns-3.33/build'
Waf: Leaving directory '/path/to/workspace/ns-allinone-3.34/ns-3.34/build'
'build' finished successfully (6m25.032s)
Modules built:
@@ -446,7 +444,7 @@ and finally |ns3|. Eventually you should see the following::
Modules not built (see ns-3 tutorial for explanation):
brite click openflow
Leaving directory ./ns-3.33
Leaving directory ./ns-3.34
Regarding the portion about modules not built::
@@ -473,9 +471,9 @@ and you should see something like:
.. sourcecode:: text
>> Building pybindgen-0.21.0.post15+nga587377 - OK
>> Building pybindgen-0.22.0 - OK
>> Building netanim-3.108 - OK
>> Building ns-3.33 - OK
>> Building ns-3.34 - OK
There may be failures to build all components, but the build will proceed
anyway if the component is optional. For example, a recent portability issue
@@ -675,7 +673,7 @@ for an already configured project:
.. sourcecode:: bash
$ ./waf --check-profile
Waf: Entering directory \`/path/to/ns-3-allinone/ns-3.33/build\'
Waf: Entering directory \`/path/to/ns-3-allinone/ns-3.34/build\'
Build profile: debug
The build.py script discussed above supports also the ``--enable-examples``