Common Open Research Emulator

emane emulating-networks emulation emulator network python rf wireless

Find a file

Blake J. Harnden 82c3d57dd3 setup a simple default way for dealing with configurable options and added conifg group opbjects as a better way to access the same information formatted within a string		2018-06-14 08:41:48 -07:00
daemon	setup a simple default way for dealing with configurable options and added conifg group opbjects as a better way to access the same information formatted within a string	2018-06-14 08:41:48 -07:00
doc	Merge branch 'rel/5.1'	2018-05-22 20:44:26 -07:00
gui	Merge branch 'rel/5.1'	2018-05-22 20:44:26 -07:00
netns	updates to try and resync make dist to include current files	2018-03-14 10:43:25 -07:00
ns3	updates to account for config messages in core handlers that dont contain all configuration options	2018-06-07 15:32:16 -07:00
scripts	fixed typo for sysv script PYTHONPATH	2018-04-20 20:38:50 -07:00
.editorconfig	removed pip check, updated make files for using DESTDIR, removed usage of pip during make install	2017-08-21 12:55:51 -07:00
.gitignore	removed swap file and added to gitignore	2018-03-25 22:18:37 -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	initial pass at removing bsd and code related to using bsd nodes	2018-03-07 12:54:19 -08:00
Changelog	Update Changelog	2018-05-22 20:56:24 -07:00
configure.ac	Update configure.ac	2018-05-23 10:05:43 -07:00
Jenkinsfile	broke out testing to individual tests	2018-03-07 10:00:50 -08: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	updated sysv file to provide the python_path environment variable when not already present	2018-04-11 09:57:02 -07:00
README.md	updates to README to add Discord and online documentation link	2018-05-02 08:50:38 -07:00
sonar-project.properties	removed deprecated sonarqube setting to try and leverage new branch settings	2018-03-02 09:47:28 -08:00

README.md

CORE

CORE: Common Open Research Emulator

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.

Documentation and Examples

Documentation hosted on GitHub
- http://coreemu.github.io/core/
Basic Script Examples
- Examples
Custom Service Example
- sample.py
Custom Emane Model Example
- examplemodel.py

Support

We are leveraging Discord for persistent chat rooms, voice chat, and GitHub integration. This allows for more dynamic conversations and the capability to respond faster. Feel free to join us at the link below. https://discord.gg/AKd7kmP

You can also get help with questions, comments, or trouble, by using the CORE mailing lists:

core-users for general comments and questions
core-dev for bugs, compile errors, and other development issues

Building CORE

./bootstrap.sh
./configure
make
sudo make install

Building Documentation

./bootstrap.sh
./configure
make doc

Building Packages

Install fpm: http://fpm.readthedocs.io/en/latest/installing.html

Build package commands, DESTDIR is used for gui packaging only

./bootstrap.sh
./configure
make
mkdir /tmp/core-gui
make fpm DESTDIR=/tmp/core-gui

This will produce:

CORE GUI rpm/deb files
- core-gui_$VERSION_$ARCH
CORE ns3 rpm/deb files
- python-core-ns3_$VERSION_$ARCH
CORE python rpm/deb files for SysV and systemd service types
- python-core-sysv_$VERSION_$ARCH
- python-core-systemd_$VERSION_$ARCH

Running CORE

First start the CORE services:

# sysv
sudo service core-daemon start
# systemd
sudo systemctl start core-daemon

This automatically runs the core-daemon program. Assuming the GUI is in your PATH, run the CORE GUI by typing the following:

core-gui

This launches the CORE GUI. You do not need to run the GUI as root.