2018-07-31 20:57:30 +01:00
|
|
|
# CORE Documentation
|
|
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
2020-01-10 00:36:00 +00:00
|
|
|
CORE (Common Open Research Emulator) is a tool for building virtual networks. As an emulator, CORE builds a
|
|
|
|
|
representation of a real computer network that runs in real time, as opposed to simulation, where abstract models are
|
|
|
|
|
used. The live-running emulation can be connected to physical networks and routers. It provides an environment for
|
2020-04-13 19:51:12 +01:00
|
|
|
running real applications and protocols, taking advantage of tools provided by the Linux operating system.
|
2018-07-31 20:57:30 +01:00
|
|
|
|
2020-01-10 00:36:00 +00:00
|
|
|
CORE is typically used for network and protocol research, demonstrations, application and platform testing, evaluating
|
2019-06-11 20:05:04 +01:00
|
|
|
networking scenarios, security studies, and increasing the size of physical test networks.
|
2018-07-31 20:57:30 +01:00
|
|
|
|
|
|
|
|
### Key Features
|
|
|
|
|
* Efficient and scalable
|
|
|
|
|
* Runs applications and protocols without modification
|
|
|
|
|
* Drag and drop GUI
|
|
|
|
|
* Highly customizable
|
|
|
|
|
|
|
|
|
|
## Topics
|
|
|
|
|
|
2019-06-11 20:05:04 +01:00
|
|
|
| Topic | Description|
|
|
|
|
|
|-------|------------|
|
2020-04-09 22:34:52 +01:00
|
|
|
|[Installation](install.md)|How to install CORE and its requirements|
|
2021-11-11 18:59:11 +00:00
|
|
|
|[Architecture](architecture.md)|Overview of the architecture|
|
|
|
|
|
|[Node Types](nodetypes.md)|Overview of node types supported within CORE|
|
2020-04-09 22:34:52 +01:00
|
|
|
|[GUI](gui.md)|How to use the GUI|
|
2020-05-11 20:27:47 +01:00
|
|
|
|[(BETA) Python GUI](pygui.md)|How to use the BETA python based GUI|
|
2020-09-12 07:49:26 +01:00
|
|
|
|[Python API](python.md)|Covers how to control core directly using python|
|
|
|
|
|
|[gRPC API](grpc.md)|Covers how control core using gRPC|
|
2020-04-09 22:34:52 +01:00
|
|
|
|[Distributed](distributed.md)|Details for running CORE across multiple servers|
|
2021-11-11 18:59:11 +00:00
|
|
|
|[Control Network](ctrlnet.md)|How to use control networks to communicate with nodes from host|
|
2021-11-15 22:33:05 +00:00
|
|
|
|[Config Services](configservices.md)|Overview of provided config services and creating custom ones|
|
2019-06-11 20:05:04 +01:00
|
|
|
|[Services](services.md)|Overview of provided services and creating custom ones|
|
|
|
|
|
|[EMANE](emane.md)|Overview of EMANE integration and integrating custom EMANE models|
|
|
|
|
|
|[Performance](performance.md)|Notes on performance when using CORE|
|
2020-04-09 22:34:52 +01:00
|
|
|
|[Developers Guide](devguide.md)|Overview on how to contribute to CORE|
|
2018-07-31 20:57:30 +01:00
|
|
|
|
|
|
|
|
## Credits
|
|
|
|
|
|
2020-01-10 00:36:00 +00:00
|
|
|
The CORE project was derived from the open source IMUNES project from the University of Zagreb in 2004. In 2006,
|
|
|
|
|
changes for CORE were released back to that project, some items of which were adopted. Marko Zec <zec@fer.hr> is the
|
|
|
|
|
primary developer from the University of Zagreb responsible for the IMUNES (GUI) and VirtNet (kernel) projects. Ana
|
2019-06-11 20:05:04 +01:00
|
|
|
Kukec and Miljenko Mikuc are known contributors.
|
2018-07-31 20:57:30 +01:00
|
|
|
|
2020-01-10 00:36:00 +00:00
|
|
|
Jeff Ahrenholz has been the primary Boeing developer of CORE, and has written this manual. Tom Goff designed the
|
|
|
|
|
Python framework and has made significant contributions. Claudiu Danilov, Rod Santiago, Kevin Larson, Gary Pei,
|
|
|
|
|
Phil Spagnolo, and Ian Chakeres have contributed code to CORE. Dan Mackley helped develop the CORE API, originally to
|
2019-06-11 20:05:04 +01:00
|
|
|
interface with a simulator. Jae Kim and Tom Henderson have supervised the project and provided direction.
|
2018-07-31 20:57:30 +01:00
|
|
|
|
2020-04-09 22:34:52 +01:00
|
|
|
Copyright (c) 2005-2020, the Boeing Company.
|
