afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
Common Open Research Emulator
552 commits 17 branches 33 tags 20 MiB
Python 91.8%
C 5.4%
Shell 1.5%
Makefile 0.7%
M4 0.4%
Other 0.2%
Find a file
Blake J. Harnden 3ce416b610 updated test cases to fix old broken code
2018-01-09 15:52:29 -08:00
daemon updated test cases to fix old broken code 2018-01-09 15:52:29 -08:00
doc moved ns3 from under daemon to the root of the project and updated references 2018-01-04 16:34:22 -08:00
gui added initial fpm commands for building packages and minor updates to support 2017-12-21 16:19:12 -08:00
kernel kernel: Avoid using the gawk-specific gensub function. 2015-04-03 01:44:00 +00:00
netns updated rpm/deb files to be built for both sysv and systemd 2018-01-04 14:33:25 -08:00
ns3 moved ns3 from under daemon to the root of the project and updated references 2018-01-04 16:34:22 -08:00
packaging marked 5.0 release as 09/01/2017 in changelog related files 2017-08-31 15:33:28 -07:00
scripts systemd: remove limit on fork() branching factor 2017-01-12 14:14:41 -05: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 updated test cases to fix old broken code 2018-01-09 15:52:29 -08: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 import (Boeing r1752, NRL r878) 2013-08-29 14:21:13 +00:00
Changelog marked 5.0 release as 09/01/2017 in changelog related files 2017-08-31 15:33:28 -07:00
configure.ac moved ns3 from under daemon to the root of the project and updated references 2018-01-04 16:34:22 -08:00
LICENSE Update LICENSE 2017-09-27 11:06:17 -07:00
Makefile.am moved ns3 from under daemon to the root of the project and updated references 2018-01-04 16:34:22 -08:00
python-prefix.py merged cleanup branch with master 2017-06-19 18:09:28 -07:00
README-Xen initial import (Boeing r1752, NRL r878) 2013-08-29 14:21:13 +00:00
README.rst updated readme date to 2017 2017-08-28 14:06:57 -07:00
revision.sh build: Include revision information in distributions. 2016-01-26 17:01:23 -05:00
sonar-project.properties small test cleanup, can isolate to a singular core test fixture 2017-07-25 10:16:18 -07:00

README.rst 

====
CORE
====

CORE: Common Open Research Emulator

Copyright (c)2005-2017 the Boeing Company.

See the LICENSE file included in this distribution.

About
=====

CORE is a tool for emulating networks using a GUI or Python scripts. The CORE
project site (1) is a good source of introductory information, with a manual,
screenshots, and demos about this software. The GitHub project (2) hosts the
source repos, wiki, and bug tracker. There is a deprecated
Google Code page (3) with the old wiki, blog, bug tracker, and quickstart guide.

1. http://www.nrl.navy.mil/itd/ncs/products/core

2. https://github.com/coreemu/core

3. http://code.google.com/p/coreemu/

4. `Official Documentation`_

.. _Official Documentation: https://downloads.pf.itd.nrl.navy.mil/docs/core/core-html/index.html


Building CORE
=============

To build this software you should use:

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

Note: You may need to pass the proxy settings to sudo make install:
    sudo make install HTTP_PROXY=<proxy>

Here is what is installed with 'make install':

    /usr/local/bin/core-gui
    /usr/local/sbin/core-daemon
    /usr/local/sbin/[vcmd, vnoded, coresendmsg, core-cleanup.sh]
    /usr/local/lib/core/*
    /usr/local/share/core/*
    /usr/local/lib/python2.6/dist-packages/core/*
    /usr/local/lib/python2.6/dist-packages/[netns,vcmd].so
    /etc/core/*
    /etc/init.d/core

See the manual for the software required for building CORE.

Building Documentation
======================

Being able to build documentation depends on help2man being installed.

Once that has been done you can run the following commands:

    ./bootstrap.sh
    ./configure
    make html

Running CORE
============

First start the CORE services:

    sudo /etc/init.d/core-daemon start

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.


Support
=======

If you have questions, comments, or trouble, please use the CORE mailing lists:

- `core-users`_ for general comments and questions

- `core-dev`_ for bugs, compile errors, and other development issues


.. _core-users: https://pf.itd.nrl.navy.mil/mailman/listinfo/core-users
.. _core-dev: https://pf.itd.nrl.navy.mil/mailman/listinfo/core-dev