core-extra/docs/index.md

# CORE Documentation

## Introduction

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
running real applications and protocols, taking advantage of tools provided by the Linux operating system.

CORE is typically used for network and protocol research, demonstrations, application and platform testing, evaluating
networking scenarios, security studies, and increasing the size of physical test networks.

### Key Features
* Efficient and scalable
* Runs applications and protocols without modification
* Drag and drop GUI
* Highly customizable

## Topics

| Topic                                | Description                                                       |
|--------------------------------------|-------------------------------------------------------------------|
| [Installation](install.md)           | How to install CORE and its requirements                          |
| [Architecture](architecture.md)      | Overview of the architecture                                      |
| [Node Types](nodetypes.md)           | Overview of node types supported within CORE                      |
| [GUI](gui.md)                        | How to use the GUI                                                |
| [Python API](python.md)              | Covers how to control core directly using python                  |
| [gRPC API](grpc.md)                  | Covers how control core using gRPC                                |
| [Distributed](distributed.md)        | Details for running CORE across multiple servers                  |
| [Control Network](ctrlnet.md)        | How to use control networks to communicate with nodes from host   |
| [Config Services](configservices.md) | Overview of provided config services and creating custom ones     |
| [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                              |
| [Developers Guide](devguide.md)      | Overview on how to contribute to CORE                             |