Updated docs

safreita1 · Aug 21, 2022 · 0a8d9a6 · 0a8d9a6
1 parent 3b1fbff
commit 0a8d9a6
Show file tree

Hide file tree

Showing 68 changed files with 2,036 additions and 4,227 deletions.
diff --git a/docs/build/doctrees/attacks.doctree b/docs/build/doctrees/attacks.doctree
diff --git a/docs/build/doctrees/bibliography.doctree b/docs/build/doctrees/bibliography.doctree
diff --git a/docs/build/doctrees/cascading.doctree b/docs/build/doctrees/cascading.doctree
diff --git a/docs/build/doctrees/defenses.doctree b/docs/build/doctrees/defenses.doctree
diff --git a/docs/build/doctrees/diffusion.doctree b/docs/build/doctrees/diffusion.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/graphs.doctree b/docs/build/doctrees/graphs.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/intro.doctree b/docs/build/doctrees/intro.doctree
diff --git a/docs/build/doctrees/measures.doctree b/docs/build/doctrees/measures.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/doctrees/simulations.doctree b/docs/build/doctrees/simulations.doctree
diff --git a/docs/build/doctrees/tutorials/tutorial-1.doctree b/docs/build/doctrees/tutorials/tutorial-1.doctree
diff --git a/docs/build/doctrees/tutorials/tutorial-2.doctree b/docs/build/doctrees/tutorials/tutorial-2.doctree
diff --git a/docs/build/doctrees/tutorials/tutorial-3.doctree b/docs/build/doctrees/tutorials/tutorial-3.doctree
diff --git a/docs/build/doctrees/tutorials/tutorial-4.doctree b/docs/build/doctrees/tutorials/tutorial-4.doctree
diff --git a/docs/build/doctrees/tutorials/tutorial-5.doctree b/docs/build/doctrees/tutorials/tutorial-5.doctree
diff --git a/docs/build/doctrees/tutorials/tutorials.doctree b/docs/build/doctrees/tutorials/tutorials.doctree
diff --git a/docs/build/doctrees/utils.doctree b/docs/build/doctrees/utils.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9e145b46b235921e18164ac974e1a974
+config: 09bf1ce093294138f0057caa940231db
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_images/defense-comparison.jpg b/docs/build/html/_images/defense-comparison.jpg
diff --git a/docs/build/html/_sources/intro.rst.txt b/docs/build/html/_sources/intro.rst.txt
@@ -1,12 +1,28 @@
+:github_url: https://github.com/safreita1/TIGER
+
 Introduction
 ============
 
-``TIGER`` is a Python **T**\ oolbox for  evaluat\ **I**\ ing  **G**\ raph vuln\ **E**\ rability and **R**\ obustness that allows users to (1) measure graph vulnerability and robustness, (2) attack networks using a variety of offensive techniques, (3) defend a network using a variety of heuristic and optimization based defense techniques. ``TIGER`` is specifically designed to help users:
+.. figure:: ../../images/tiger-logo.jpg
+   :width: 100 %
+   :align: center
+
+
+``TIGER`` is a Python **T**\ oolbox for  evaluat\ **I**\ ing  **G**\ raph vuln\ **E**\ rability and **R**\ obustness.
+TIGER contains numerous state-of-the-art methods to help users conduct graph vulnerability and robustness analysis on
+graph structured data. Specifically, ``TIGER`` helps users:
+
+- **Quantify** network vulnerability and robustness.
+- **Simulate** a variety of network attacks, cascading failures and spread of dissemination of entities.
+- **Augment** a network's structure to resist attacks and recover from failure.
+- **Regulate** the dissemination of entities on a network (e.g., viruses, propaganda).
+
+For additional information, take a look at our paper:
+
+`Evaluating Graph Vulnerability and Robustness using TIGER <https://arxiv.org/pdf/2006.05648.pdf>`_.
+`Freitas, Scott <https://scottfreitas.com>`_, and Chau, Duen Horng.
+*arXiv, 2020.*
 
-- Quantify network vulnerability and robustness.
-- Simulate a variety of network attacks, cascading failures and spread of dissemination of entities.
-- Augment a network's structure to resist attacks and recover from failure.
-- Regulate the dissemination of entities on a network (e.g., viruses, propaganda).
 
 Background & Motivation
 ***********************
@@ -20,27 +36,27 @@ Unfortunately, the nature of cross-disciplinary research also comes with signifi
 
 Installation
 ************
-To quickly get started, install TIGER using pip
+To quickly get started, install TIGER using pip:
 
-```sh
-$ pip install graph-tiger
-```
+``pip install graph-tiger``
 
-Alternatively, you can git clone [TIGER](https://github.com/safreita1/TIGER.git) and create a new Anaconda environment
-using the provided [YAML](environment.yml) file.
+Alternatively, you can git clone `TIGER <https://github.com/safreita1/TIGER.git>`_ and create a new Anaconda environment
+using the provided `YAML <https://github.com/safreita1/TIGER/blob/master/environment.yml>`_ file.
 
 
 Citing
 ******
 
-If you find **TIGER** useful in your research, please consider citing the following paper:
 
-@article{freitas2020evaluating,
-    title={Evaluating Graph Vulnerability and Robustness using TIGER},
-    author={Freitas, Scott and Chau, Duen Horng},
-    journal={arXiv preprint arXiv:2006.05648},
-    year={2020}
-}
+.. code-block:: latex
+
+   @article{freitas2020evaluating,
+             title = {Evaluating Graph Vulnerability and Robustness using TIGER},
+             author = {Freitas, Scott and Chau, Duen Horng},
+             journal={arXiv preprint arXiv:2006.05648},
+             year = {2020},
+    }
+
 
 
 Examples
@@ -133,28 +149,28 @@ In this example, we run a cascading failure simulation on a Barabasi Albert (BA)
    cascading.plot_results(results)
 
 
-.. figure:: ../../images/Cascading:step=0,l=0.8,r=0.2,k_a=30,attack=rb_node,k_d=0,defense=None.jpg
+.. figure:: ../../images/Cascading--step=0,l=0.8,r=0.2,k_a=30,attack=rb_node,k_d=0,defense=None.jpg
    :width: 100 %
    :align: center
 
    Time step 0: shows the network under normal operating conditions.
 
 
-.. figure:: ../../images/Cascading:step=6,l=0.8,r=0.2,k_a=30,attack=rb_node,k_d=0,defense=None.jpg
+.. figure:: ../../images/Cascading--step=6,l=0.8,r=0.2,k_a=30,attack=rb_node,k_d=0,defense=None.jpg
    :width: 100 %
    :align: center
 
    Step 5: we observe a series of failures across the network.
 
 
-.. figure:: ../../images/Cascading:step=99,l=0.8,r=0.2,k_a=30,attack=rb_node,k_d=0,defense=None.jpg
+.. figure:: ../../images/Cascading--step=99,l=0.8,r=0.2,k_a=30,attack=rb_node,k_d=0,defense=None.jpg
    :width: 100 %
    :align: center
 
    Step 99: most of the network has collapsed.
 
 
-.. figure:: ../../images/Cascading:step=100,l=0.8,r=0.2,k_a=30,attack=rb_node,k_d=0,defense=None_results.jpg
+.. figure:: ../../images/Cascading--step=100,l=0.8,r=0.2,k_a=30,attack=rb_node,k_d=0,defense=None_results.jpg
    :width: 100 %
    :align: center
 
@@ -204,28 +220,28 @@ In this example, we run a computer virus simulation (SIS infection model) on a B
 
 
 
-.. figure:: ../../images/SIS_epidemic:step=0,diffusion=min,method=ns_node,k=5.jpg
+.. figure:: ../../images/SIS_epidemic--step=0,diffusion=min,method=ns_node,k=5.jpg
    :width: 100 %
    :align: center
 
    Step 0: A highly infected network with 4 nodes "vaccinated" according to Netshield defense.
 
 
-.. figure:: ../../images/SIS_epidemic:step=80,diffusion=min,method=ns_node,k=5.jpg
+.. figure:: ../../images/SIS_epidemic--step=80,diffusion=min,method=ns_node,k=5.jpg
    :width: 100 %
    :align: center
 
    Step 80: The computer virus begins to remit.
 
 
-.. figure:: ../../images/SIS_epidemic:step=4999,diffusion=min,method=ns_node,k=5.jpg
+.. figure:: ../../images/SIS_epidemic--step=4999,diffusion=min,method=ns_node,k=5.jpg
    :width: 100 %
    :align: center
 
    Step 4999: The virus is nearly contained.
 
 
-.. figure:: ../../images/SIS_epidemic:step=5000,diffusion=min,method=ns_node,k=5_results.jpg
+.. figure:: ../../images/SIS_epidemic--step=5000,diffusion=min,method=ns_node,k=5_results.jpg
    :width: 100 %
    :align: center
 

diff --git a/docs/build/html/_sources/tutorials/tutorial-1.rst.txt b/docs/build/html/_sources/tutorials/tutorial-1.rst.txt
@@ -1,6 +1,7 @@
 Tutorial 1: Measuring Vulnerability and Robustness
 ********************************************************
 
+Robustness is defined as a measure of a network's ability to continue functioning when part of the network is naturally damaged or targeted for attack :cite`ellens2013graph,chan2016optimizing,beygelzimer2005improving`.
 TIGER contains numerous robustness measures, grouped into one of three categories depending on whether the measure uses the graph, adjacency, or Laplacian matrix. In the figure below, we show some common robustness measures from each category.
 
 .. _fig-coordsys-rect: