Introducing Showcases in INET

[Rudolf Hornig]

Dear INET users,

In the latest INET 3.6.0 release we have introduced a new class of 'example simulations' called showcases. While INET contains a lot of samples in the examples folder, they are somewhat unstructured and hard to understand. The main reason for this is, that these example networks were originally created by the developers to test their code and those tests later turned to examples. Usually, they have no clear goal and sometimes it is hard to tell what they are supposed to demonstrate. Additionally, they combine several features (sometimes unnecessarily) so it's a bit hard to figure out what is important and what is just needed for technical reasons...

To help INET users more effectively, we would like to introduce a new class of examples called showcases. They moved into a different folder to avoid confusion. They come with a short description that clearly states the goal of the sample, then describes a bit the model itself, and finally in also explains what results you should expect from the model. This would allow us to use these descriptions as a teaching material and understand how the specific feature is working even without running the actual example. We intend to add more and more showcases over the time and we would also very much welcome your contributions in similar format. The tentative plan is that we grow the number of showcases to cover all INET features and then retire the old 'examples' folder and use them as tests instead.

If you check the 'showcases' folder in the INET distribution, you will see several samples already. If you have ideas for additional ones or better, would contribute new ones (with similar structure), please do not hesitate. We believe that good documentation is something that INET is badly missing and this is the first step towards that. We have already published some of the showcase descriptions for your enjoyment :) 

Stay tuned for the rest of them coming in the following weeks and keep the feedback coming...

The OMNeT++ dev team

[Kyeong Soo (Joseph) Kim]

Dear Rudolf,

To test the said new feature of "showcases", I checked out v3.6.0 tag from the github repository and run "make makefiles".

But Ifailed compiling; below are the error messages:

===========================================================================================================================

opp_featuretool: Error: NED package 'inet.showcases.wireless' in feature 'wirelessshowcases' was not found.

opp_featuretool: Error: Check whether all NED folders are set properly (in the .nedfolders file) and all directories corresponding to the NED packages defined in the .oppfeatures file do exist.

make: *** [Makefile:22: makefiles-so] Error 1

===========================================================================================================================

So I just downloaded the said version from the OMNeT++ home page (i.e., tgz file) and this time, I had no such problems.

In this regard I checked the "showcases" directory and found that they are different for git version and tar file:

* git version

  + errorrate/

  + handover/

  + hiddennode/

  + levelofdetail/

  + power/

  + ratecontrol/

  + scaling/

  + throughput/

  + visualizer/

* tar file

  + visualizer/

  + wireless/

With the git version, I tried fiddling with project features (e.g., disabling "wirelesshowcases") but had no success.

I wonder whether you have tested with git tag v3.6.0 before releasing this version and how I could compile this version under git.

With regards,

Joseph

--
You received this message because you are subscribed to the Google Groups "INET Framework Contributors" group.
To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-contrib+unsub...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Alfonso Ariza Quintana]

I have suffered some of the problems also,

 

I have used this

git submodule update --recursive --remote

--

To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-co...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

 

--

You received this message because you are subscribed to the Google Groups "INET Framework Contributors" group.

To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-co...@googlegroups.com.

[Kyeong Soo (Joseph) Kim]

Dear Alfonso,

Great thanks!

That solved my problem, and now I can compile.

With regards,

Joseph

--

To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-contrib+unsubscri...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "INET Framework Contributors" group.

To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-contrib+unsubscri...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "INET Framework Contributors" group.

To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-contrib+unsubscri...@googlegroups.com.

[Rudolf Hornig]

Yeah, git submodules are not the easiest beast to tame... 

We had to go with using submodules as the showcases rfolder contains a lot of big files files (videos) that are constantly updated. Adding them to the main inet repo would have boasted the size exponentially while providing no real benefit. We did not wanted to put this burden to the users. We intend to regularly squash tutorials and showcases directory to keep their size small (we don't care about history there). We were considering GIT LFS too, but that comes with an other set of issues...

The released showcases NED and ini files are available in the TARBALL so you don't have to use git for that. The git version just contains the additonal HTML and video files. 

As for differences between the TAR and GIT content, that is intentional. We have released only those showcases that we deem 'final'. The rest of them is still under review.

Everybody is welcomed to share the experiences , as that would help fine tuning the remaining ones. So keep the comments coming :)

Rudolf

--

To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-contrib+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "INET Framework Contributors" group.

To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-contrib+unsub...@googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "INET Framework Contributors" group.

To unsubscribe from this group and stop receiving emails from it, send an email to inetframework-contrib+unsub...@googlegroups.com.