2018-10-12 19:30:03 +01:00
|
|
|
# CORE [![Codacy Badge](https://api.codacy.com/project/badge/Grade/d94eb0244ade4510a106b4af76077a92)](https://www.codacy.com/app/blakeharnden/core?utm_source=github.com&utm_medium=referral&utm_content=coreemu/core&utm_campaign=Badge_Grade)
|
2013-08-29 15:21:13 +01:00
|
|
|
|
|
|
|
CORE: Common Open Research Emulator
|
2016-10-23 02:14:16 +01:00
|
|
|
|
2019-05-24 00:01:47 +01:00
|
|
|
Copyright (c)2005-2019 the Boeing Company.
|
2016-10-23 02:14:16 +01:00
|
|
|
|
2013-08-29 15:21:13 +01:00
|
|
|
See the LICENSE file included in this distribution.
|
|
|
|
|
2018-05-02 16:50:38 +01:00
|
|
|
## About
|
2016-10-23 02:14:16 +01:00
|
|
|
|
2018-05-02 16:50:38 +01:00
|
|
|
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.
|
2013-08-29 15:21:13 +01:00
|
|
|
|
2018-05-02 16:50:38 +01:00
|
|
|
## Documentation and Examples
|
2013-08-29 15:21:13 +01:00
|
|
|
|
2018-05-02 16:50:38 +01:00
|
|
|
* Documentation hosted on GitHub
|
2018-10-12 05:22:57 +01:00
|
|
|
* <http://coreemu.github.io/core/>
|
2018-05-02 16:50:38 +01:00
|
|
|
* Basic Script Examples
|
|
|
|
* [Examples](daemon/examples/api)
|
|
|
|
* Custom Service Example
|
|
|
|
* [sample.py](daemon/examples/myservices/sample.py)
|
|
|
|
* Custom Emane Model Example
|
|
|
|
* [examplemodel.py](daemon/examples/myemane/examplemodel.py)
|
2013-08-29 15:21:13 +01:00
|
|
|
|
2018-05-02 16:50:38 +01:00
|
|
|
## 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.
|
2018-10-12 05:22:57 +01:00
|
|
|
<https://discord.gg/AKd7kmP>
|
2018-05-02 16:50:38 +01:00
|
|
|
|
|
|
|
## Building CORE
|
2013-08-29 15:21:13 +01:00
|
|
|
|
2018-10-18 19:32:33 +01:00
|
|
|
See [CORE Installation](http://coreemu.github.io/core/install.html) for detailed build instructions.
|
2018-01-11 19:21:56 +00:00
|
|
|
|
2018-10-12 05:22:57 +01:00
|
|
|
### Running CORE
|
2013-08-29 15:21:13 +01:00
|
|
|
|
2018-10-18 19:32:33 +01:00
|
|
|
See [Using the CORE GUI](http://coreemu.github.io/core/usage.html) for more details on running CORE.
|