refactoring with reduction of scope

Author: Andrey Golovanov

README.md

@@ -6,40 +6,9 @@
 
 ## Introduction
 
-NetSim is planned to become a toolkit that could help network engineers (my friends and myself included) to better reason about the network designs.
+NetSim is a discrete event simulator toolkit adapted for network simulation use-cases.
 
-Types of problems we want this toolkit to help solving (eventually):
+Types of problems this toolkit can help solving:
 
-* Flow analysis of a network graph with simulated failures
+* Simulation of failures in a network graph
 * Simulation of routing protocol behavior in stochastic environment
-
-From a high level standpoint the system consists of few components:
-
-* Workflow instructions
-* Simple graph library
-* Tool to build network graphs from their definitions
-* Discrete event simulator
-
-## How to use
-
-1. Clone this repo (or download as ZIP archive)
-1. Build docker image:
-
-    ```text
-    docker build -t netsim .
-    ```
-
-1. Run a container:
-
-    ```text
-    docker run -it --rm --hostname netsim --name netsim-running -p 8888:8888 netsim
-    ```
-
-1. Upon startup your container started a Jupyter Notebook Server that printed a bunch of text. There should be a URL looking similar to:
-
-    ```text
-    http://127.0.0.1:8888/?token=553ef7c73f079ac51936b542f64cf58b7ea8da6561499350
-    ```
-
-1. Copy/paste the URL into your browser. It should open Jupyter Notebook App window.
-1. Pick any example and run it.

dev/build.sh

@@ -7,8 +7,9 @@ IMAGE_ID=$(docker images --format "{{.ID}}" $IMAGE_TAG)
 
 USAGE="Usage: $0 COMMAND IMAGE_TAG\n"
 USAGE+="    COMMAND is what you expect script to do:\n"
-USAGE+="        run - Runs a ubuildenv container.\n"
-USAGE+="        killall - Stops and removes all running ubuildenv containers.\n"
+USAGE+="        build - Builds an image from a Dockerfile.\n"
+USAGE+="        run - Runs a container.\n"
+USAGE+="        killall - Stops and removes all running containers.\n"
 USAGE+="        forcecleanall - Clean-up Docker.\n"
 
 if [[ $# -lt 1 ]]; then
@@ -19,6 +20,15 @@ fi
 
 [[ $(uname) -eq "Darwin" ]] && MODHACK="-v /lib/modules:/lib/modules:ro" || MODHACK=""
 
+function build {
+    echo "Building docker container"
+    docker build ./dev -t $IMAGE_TAG
+
+    IMAGE_ID=$(docker images --format "{{.ID}}" $IMAGE_TAG)
+    echo "Container image id: $IMAGE_ID"
+    return 0
+}
+
 function run {
     name=$(basename "`pwd`")
     echo "Starting a container with the name $name using $IMAGE_TAG image..."
@@ -48,6 +58,11 @@ function forcecleanall {
 }
 
 case $1 in
+    build)
+        echo "Executing BUILD command..."
+        build "$@"
+        ;;
+
     run)
         echo "Executing RUN command..."
         run "$@"

dev/buildenv.sh

@@ -1,3 +1,4 @@
+ngraph
 pyyaml
 schema
 jq