Commit 1fb8f0b7 authored by Simon Redman's avatar Simon Redman

Add documentation about

parent 86cfd485
......@@ -17,6 +17,11 @@ These instructions will be updated as the code is actually written
Before you will be able to run any commands, activate the virtual environment by running `source env/bin/activate`
`` automatically does everything required, and can be run directly on an Emulab node to parse
the on-node net information or can be fed a NetJSON NetGraph to configure. Please refer to `orchestrator --help`
## Library Documentation
#### 1.
This is both a program which can be run on its own, mostly for testing purposes, and a library which is used by the following programs to parse emulab's topology into [NetJSON]( NetworkGraph for usage with the NetworkX network graph library.
......@@ -71,7 +76,6 @@ The basic goal is to take all the scripts from <
1. Replace ``
2. Replace ``
3. Replace ``
4. Write top-level script which runs all previous scripts in an easy-to-use way
## NetworkGraph
For the most part, standard NetJSON NetworkGraph fields are used, and those are documented [here](
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment