# icarus_ICN

**Repository Path**: masterlovsky/icarus

## Basic Information

- **Project Name**: icarus_ICN
- **Description**: forked from icarus-icn-simulator
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-09-20
- **Last Updated**: 2024-04-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Icarus ICN caching simulator

Icarus is a Python-based discrete-event simulator for evaluating caching
performance in Information Centric Networks (ICN).

Icarus is not bound to any specific ICN architecture. Its design allows users
to implement and evaluate new caching policies or caching and routing strategy
with few lines of code.

This document explains how to configure and run the simulator.

## Installation

First, ensure that you have Python installed on your machine with version 2.7.9+ or 3.4+.

Then, clone this repository on your local machine and run:

    $ make install

This downloads and installs all required dependencies and installs Icarus in _editable_ mode.
This means that you can make changes directly on the source code to have effect on your installation.

## Usage

You can use Icarus in three different ways:

* Run simulations using models provided by Icarus
* Process and analyze results from those simulations
* Use Icarus modeling tools into your own code.

You can a set of simulations by executing:

    $ icarus run --results <RESULTS_FILE> <CONF_FILE>

where:

* `RESULTS_FILE` is the [pickle](http://docs.python.org/3/library/pickle.html) file in which results will be saved,
* `CONF_FILE` is the configuration file describing the experiments to run.

To learn how to set up the configuration file, you may want to look at `config.py`
and possibly modify it according to your requirements.
Alternatively, you can look at the `examples` folder which
contains examples of configuration files for various use cases.

Once simulations complete you can print the content of your results file into a
human readable format, running:

    $ icarus results print <RESULTS_PICKLE_FILE> > <OUTPUT_TEXT_FILE>

Icarus also provides a set of helper functions for plotting results.
Look at the `examples` folder for plot examples.

By executing the steps illustrated above it is possible to run simulations using the
topologies, cache policies, strategies and result collectors readily available on
Icarus. Icarus makes it easy to implement new models to use in simulations.

To implement new models, please refer to the description of the simulator
provided in this paper:

L.Saino, I. Psaras and G. Pavlou, Icarus: a Caching Simulator for Information Centric
Networking (ICN), in Proc. of SIMUTOOLS'14, Lisbon, Portugal, March 2014.
\[[PDF](https://lorenzosaino.github.io/publications/icarus-simutools14.pdf)\],
\[[Slides](https://lorenzosaino.github.io/publications/icarus-simutools14-slides.pdf)\],
\[[BibTex](https://lorenzosaino.github.io/publications/icarus-simutools14-bib.txt)\]

Otherwise, please browse the source code. It is very well documented and easy to
understand.

Finally, Icarus provides utilities for modeling the performance of caches and
work with traffic traces. The code is included in the `icarus.tools` package.
These tools are described in detail in [this paper](https://lorenzosaino.github.io/publications/icarus-simutools14.pdf).

## Docker container

This repository contains a Dockerfile that can be used to build a container running Icarus.
You need Docker installed on your machine to do so.

You can build a container image with Icarus running:

    docker build [--build-arg py=<python-version>] -t icarus .

where `python-version` is the version of Python you want to use, e.g. `3.6`.

You can now spin a container giving you shell access, which you could use to
poke around the container and explore the code by running:

    docker run --rm -it icarus

Finally you can run any Icarus command with:

    docker run icarus <COMMAND>

To run a simulation with Icarus it is advisable to mount in the container
the directories where the config file is located and where you intend
to store results and access them from the container.

For example, to use config.py and store the result file in the root of the project
you could run the container with the following command:

    docker run -v `pwd`:/data icarus icarus run -r /data/results.pickle /data/config.py

## Development

Running `make install` creates a fully functional development environment.
You can run all test cases with:

    $ make test

and build HTML documentation with:

    $ make doc

## Citing

If you use Icarus for your paper, please refer to the following publication:

    @inproceedings{icarus-simutools14,
       author = {Saino, Lorenzo and Psaras, Ioannis and Pavlou, George},
       title = {Icarus: a Caching Simulator for Information Centric Networking (ICN)},
       booktitle = {Proceedings of the 7th International ICST Conference on Simulation Tools and Techniques},
       series = {SIMUTOOLS '14},
       year = {2014},
       location = {Lisbon, Portugal},
       numpages = {10},
       publisher = {ICST},
       address = {ICST, Brussels, Belgium, Belgium},
    }

## Documentation

If you desire further information about Icarus, you can find it in the following places:

* In [this paper](https://lorenzosaino.github.io/publications/icarus-simutools14.pdf), which describes the overall architecture of the Icarus simulator,
  the motivations for its design, the models implemented and shows some snippets of codes on how to use the modelling tools.
* In the [API reference](http://icarus-sim.github.io/doc/), which documents all packages, modules, classes, methods
  and functions included in the Icarus simulator.
* In the [source code](https://www.github.com/icarus-sim/icarus/), which is well organized and thoroughly documented.

## Reproduce results of previous papers

### Hash-routing schemes, ACM SIGCOMM ICN '13

The Icarus simulator can be used to reproduce the results and plot the graphs presented in the paper:

L.Saino, I. Psaras and G. Pavlou, Hash-routing Schemes for Information Centric Networking,
in *Proc. of the 3rd ACM SIGCOMM workshop on Information Centric Networking (ICN'13)*, Hong Kong, China, August 2013.
[\[PDF\]](https://lorenzosaino.github.io/publications/hashrouting-icn13.pdf),
[\[BibTex\]](https://lorenzosaino.github.io/publications/hashrouting-icn13-bib.txt)

To do so, refer to the instructions reported in the  [icarus-sim/hashrouting-icn13-results](http://github.com/icarus-sim/hashrouting-icn13-results) repository.

## License

Icarus is licensed under the terms of the [GNU GPLv2 license](http://www.gnu.org/licenses/gpl-2.0.html).

## Contacts

* For general questions or clarifications, ask on the [Icarus mailing list](http://mailman.ee.ucl.ac.uk/mailman/listinfo/icarus)
* For reporting bugs, [open an issue](https://github.com/icarus-sim/icarus/issues)

## Acknowledgments

This work received funding from the UK EPSRC, under grant agreement no. EP/K019589/1 ([COMIT project](http://www.ee.ucl.ac.uk/comit-project/)),
the EU-Japan initiative, under EU FP7 grant agreement no. 608518 and NICT contract no. 167 ([GreenICN project](http://www.greenicn.org/))
and from the EU FP7 program, under grant agreements 318488 ([Flamingo Network of Excellence project](http://www.fp7-flamingo.eu/)).