Skip to content

Commit

Permalink
test
Browse files Browse the repository at this point in the history
  • Loading branch information
EFontesP90 committed Oct 31, 2024
1 parent b8fcae1 commit 89e2212
Show file tree
Hide file tree
Showing 3 changed files with 356 additions and 1 deletion.
209 changes: 209 additions & 0 deletions link_to_system_adaptation/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
The following license governs the use of Simu5G.

Disclaimer
----------

Simu5G is an open source simulator licensed under LGPL, and based on
OMNeT framework which is available under the Academic Public License and
a commercial license (see https://omnest.com/licensingfaq.php). You are
solely responsible for obtaining the appropriate license for your use(s)
of OMNeT. Intel is not responsible for obtaining any such licenses, nor
liable for any licensing fees due in connection with your use of OMNeT.
Neither the University of Pisa, nor the authors of this software, are
responsible for obtaining any such licenses, nor liable for any licensing
fees due in connection with your use of OMNeT.

Simu5G is based on 3GPP specifications, which may involve patented and
proprietary technology. See https://www.3gpp.org/contact/3gpp-faqs#L5.
You are solely responsible for determining if your use of Simu5G requires
any additional licenses. Intel is not responsible for obtaining any such
licenses, nor liable for any licensing fees due in connection with your
use of Simu5G. Neither the University of Pisa, nor the authors of this
software, are responsible for obtaining any such licenses, nor liable
for any licensing fees due in connection with your use of OMNeT.

This software is provided on an "as is" basis, without warranties of
any kind, either express or implied, including, but not limited to,
warranties of accuracy, adequacy, validity, reliability or compliance
for any specific purpose. Neither the University of Pisa, nor the
authors of this software, are liable for any loss, expense or damage
of any type that may arise in using this software.

If you use this software or part of it for your research, please cite
our work:

G. Nardini, D. Sabella, G. Stea, P. Thakkar, A. Virdis, "Simu5G – An
OMNeT++ Library for End-to-End Performance Evaluation of 5G Networks,"
in IEEE Access, vol. 8, pp. 181176-181191, 2020,
doi: 10.1109/ACCESS.2020.3028550.

If you include this software or part of it within your own software,
README and LICENSE files cannot be removed from it and must be included
in the root directory of your software package.


GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.


This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.

1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
146 changes: 146 additions & 0 deletions link_to_system_adaptation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
Simu5G
=======

5G NR and LTE/LTE-A user-plane simulation model, compatible with the
INET Framework.
Website: http://simu5g.org


Disclaimer
----------

Simu5G is an open source simulator licensed under LGPL, and based on
OMNeT framework which is available under the Academic Public License and
a commercial license (see https://omnest.com/licensingfaq.php). You are
solely responsible for obtaining the appropriate license for your use(s)
of OMNeT. Intel is not responsible for obtaining any such licenses, nor
liable for any licensing fees due in connection with your use of OMNeT.
Neither the University of Pisa, nor the authors of this software, are
responsible for obtaining any such licenses, nor liable for any licensing
fees due in connection with your use of OMNeT.

Simu5G is based on 3GPP specifications, which may involve patented and
proprietary technology. See https://www.3gpp.org/contact/3gpp-faqs#L5.
You are solely responsible for determining if your use of Simu5G requires
any additional licenses. Intel is not responsible for obtaining any such
licenses, nor liable for any licensing fees due in connection with your
use of Simu5G. Neither the University of Pisa, nor the authors of this
software, are responsible for obtaining any such licenses, nor liable
for any licensing fees due in connection with your use of OMNeT.

This software is provided on an "as is" basis, without warranties of
any kind, either express or implied, including, but not limited to,
warranties of accuracy, adequacy, validity, reliability or compliance
for any specific purpose. Neither the University of Pisa, nor the
authors of this software, are liable for any loss, expense or damage
of any type that may arise in using this software.

If you use this software or part of it for your research, please cite
our work:

G. Nardini, D. Sabella, G. Stea, P. Thakkar, A. Virdis, "Simu5G – An
OMNeT++ Library for End-to-End Performance Evaluation of 5G Networks,"
in IEEE Access, vol. 8, pp. 181176-181191, 2020,
doi: 10.1109/ACCESS.2020.3028550.

If you include this software or part of it within your own software,
README and LICENSE files cannot be removed from it and must be included
in the root directory of your software package.



Core contributors
-----------------

- Giovanni Nardini ([email protected])
- Giovanni Stea ([email protected])
- Antonio Virdis ([email protected])


Dependencies
------------

This version requires:

- OMNeT++ 6.0.1
- INET 4.5


Simu5G Features
---------------

General

- eNodeB, gNodeB and UE models
- Full LTE and NR protocol stack
- Simple PGW/UPF model implementing GTP protocol

PDCP-RRC

- Header compression/decompression
- Logical connection establishment and maintenance
- E-UTRA/NR Dual connectivity
- Split Bearer

RLC

- Multiplexing/Demultiplexing of MAC SDUs
- UM, (AM and TM testing) modes

MAC

- HARQ functionalities
- Allocation management
- AMC
- Scheduling Policies (MAX C/I, Proportional Fair, DRR)
- Carrier Aggregation
- Support to multiple numerologies
- Flexible TDD/FDD

PHY

- Channel Feedback management
- Realistic 3GPP channel model with
- inter-cell interference
- path-loss
- fast fading
- shadowing
- (an)isotropic antennas

Advanced features

- X2 communication support
- X2-based handover
- CoMP Coordinated Scheduling support
- Device-to-device communications
- Support for vehicular mobility (integration with Veins 5.2)
- ETSI-compliant model of Multi-access Edge Computing (MEC) systems


Applications

- Voice-over-IP (VoIP)
- Constant Bit Rate (CBR)
- Trace-based Video-on-demand (VoD)


Real-time emulation support
---------------------------

Simu5G supports real-time network emulation capabilities. Navigate to
one of the examples included in the "emulation" folder and take a look
at the README file included therein.


Limitations
-----------

- User Plane only (Control Plane not modeled)
- no EPS bearer support – note: a similar concept, "connections", has
been implemented, but they are neither dynamic nor statically
configurable via some config file
- radio bearers not implemented, not even statically configured radio
bearers (dynamically allocating bearers would need the RRC protocol,
which is Control Plane so not implemented)


2 changes: 1 addition & 1 deletion main.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Purpose:
Project main file. In this file are set the Link-level-Simulator-Variables (LLS) for configuring the desired
simulation scenario, conditions and outputs.
simulation scenario, conditions, and outputs.
Author: Ernesto Fontes Pupo / Claudia Carballo González
Date: 2024-10-30
Expand Down

0 comments on commit 89e2212

Please sign in to comment.