Common Open Research Emulator
Find a file
bharnden 5ab71377cc
Merge pull request #712 from coreemu/develop
merge develop for 9.0.0 release
2022-11-18 14:46:29 -08:00
.github updated workflow to use newer version 2022-10-12 21:35:22 -07:00
daemon gui: updated custom nodes to use config services and updated labels to reflect that 2022-10-14 21:40:40 -07:00
dockerfiles install: updated dockerfiles for installing using the script based method for centos/ubuntu 2022-10-14 10:42:31 -07:00
docs install: updates to make python3.9 the minimum required version, updates to various dependencies to account for known vulnerabilities 2022-10-13 10:15:38 -07:00
man daemon: removing python tlv related code and tests related to it 2022-03-08 14:18:47 -08:00
netns daemon: removing python tlv related code and tests related to it 2022-03-08 14:18:47 -08:00
package examples: updated python switch example to show the need to use ids for switch/hub interfaces 2022-11-10 09:54:31 -08:00
.editorconfig added net client to consolidate bridge and interface creation 2019-09-26 15:20:32 -07:00
.gitignore install: updated automated install to place virtual environment to /opt/core/venv to be consistent with new package location 2022-09-29 13:58:09 -07:00
ASSIGNMENT_OF_COPYRIGHT.pdf updated assignment of copyright file name to add to dist file 2017-12-18 09:28:41 -08:00
bootstrap.sh daemon: removing python tlv related code and tests related to it 2022-03-08 14:18:47 -08:00
CHANGELOG.md updated changelog for next release 2022-11-18 11:09:56 -08:00
configure.ac install: updates to make python3.9 the minimum required version, updates to various dependencies to account for known vulnerabilities 2022-10-13 10:15:38 -07:00
LICENSE updates to simplify tracking the copyright and an update to 2018, still room for improvement 2018-03-15 10:36:54 -07:00
Makefile.am install: updates to support building deb/rpm packages that contain python wheels and install core from a single file, updates to core to install scripts by way of python directly 2022-07-27 16:00:10 -07:00
README.md install: updates to make python3.9 the minimum required version, updates to various dependencies to account for known vulnerabilities 2022-10-13 10:15:38 -07:00
setup.sh install: updated poetry version to install in setup.sh to 1.2.1 2022-10-14 08:43:12 -07:00
tasks.py install: bumped grpcio versions to 1.49.1 2022-10-14 12:14:20 -07:00

CORE

CORE: Common Open Research Emulator

Copyright (c)2005-2022 the Boeing Company.

See the LICENSE file included in this distribution.

About

The Common Open Research Emulator (CORE) is a tool for emulating networks on one or more machines. You can connect these emulated networks to live networks. CORE consists of a GUI for drawing topologies of lightweight virtual machines, and Python modules for scripting network emulation.

Quick Start

Requires Python 3.9+. More detailed instructions and install options can be found here.

Package Install

Grab the latest deb/rpm from releases.

This will install vnoded/vcmd, system dependencies, and CORE within a python virtual environment at /opt/core/venv.

sudo <yum/apt> install -y ./<package>

Then install OSPF MDR from source:

git clone https://github.com/USNavalResearchLaboratory/ospf-mdr.git
cd ospf-mdr
./bootstrap.sh
./configure --disable-doc --enable-user=root --enable-group=root \
  --with-cflags=-ggdb --sysconfdir=/usr/local/etc/quagga --enable-vtysh \
  --localstatedir=/var/run/quagga
make -j$(nproc)
sudo make install

Script Install

The following should get you up and running on Ubuntu 22.04. This would install CORE into a python3 virtual environment and install OSPF MDR from source.

git clone https://github.com/coreemu/core.git
cd core
# install dependencies to run installation task
./setup.sh
# run the following or open a new terminal
source ~/.bashrc
# Ubuntu
inv install
# CentOS
inv install -p /usr

Documentation & Support

We are leveraging GitHub hosted documentation and Discord for persistent chat rooms. This allows for more dynamic conversations and the capability to respond faster. Feel free to join us at the link below.