📝 docs

GiulioRossetti · Jul 13, 2019 · 86df6eb · 86df6eb
1 parent 77ef874
commit 86df6eb
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 23 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -80,9 +80,9 @@ def __getattr__(cls, name):
 # built documents.
 #
 # The short X.Y version.
-version = u'4.0.0'
+version = u'5.0.0'
 # The full version, including alpha/beta/rc tags.
-release = u'4.0.0'
+release = u'5.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,21 +10,6 @@ NDlib - Network Diffusion Library
 |date|                   3.x         `Giulio Rossetti`_  `Source`_   `Distribution`_
 ================ =================== ==================  ==========  ===============
 
-.. raw:: html
-
-		<div style="text-align: center">
-        <object width="480" height="385" align="center"><param name="movie"
-        value="https://www.youtube.com/watch?v=tYHNOuKJwbE&t=2s"></param><param
-        name="allowFullScreen" value="true"></param><param
-        name="allowscriptaccess" value="always"></param><embed
-        src="https://www.youtube.com/watch?v=tYHNOuKJwbE&t=2s"
-        type="application/x-shockwave-flash" allowscriptaccess="always"
-        allowfullscreen="true" width="480"
-        height="385"></embed></object>
-        </div>
-        <br/><br/>
-
-
 
 If you use ``NDlib`` as support to your research consider citing:
 

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -25,7 +25,7 @@ Let's start importing the required libraries
 .. code:: python
 
     import networkx as nx
-    import ndlib.models.epidemics as ep
+    import ndlib.models.epidemics.SIRModel as sir
 
 Once imported the selected model, SIR, and the networkx library we can initialize the simulation:
 
@@ -35,7 +35,7 @@ Once imported the selected model, SIR, and the networkx library we can initializ
     g = nx.erdos_renyi_graph(1000, 0.1)
     
     # Model Selection
-    model = ep.SIRModel(g)
+    model = sir.SIRModel(g)
 
 ------------------------
 Configure the simulation
@@ -117,13 +117,15 @@ Multiplots - implemented only for the ``bokeh`` provider - are also useful to co
 
 .. code:: python
 
-	import ndlib.models.epidemics as ep
+	import ndlib.models.epidemics.SISModel as sis
+	import ndlib.models.epidemics.SIModel as si
+	import ndlib.models.epidemics.ThresholdModel as th
 
 	vm = MultiPlot()
 	vm.add_plot(p)
 
 	# SIS
-	sis_model = ep.SISModel(g)
+	sis_model = sis.SISModel(g)
 	config = mc.Configuration()
 	config.add_model_parameter('beta', 0.001)
 	config.add_model_parameter('lambda', 0.01)
@@ -137,7 +139,7 @@ Multiplots - implemented only for the ``bokeh`` provider - are also useful to co
 	vm.add_plot(p3)
 
 	# SI
-	si_model = ep.SIModel(g)
+	si_model = si.SIModel(g)
 	config = mc.Configuration()
 	config.add_model_parameter('beta', 0.001)
 	config.add_model_parameter("fraction_infected", 0.05)
@@ -150,7 +152,7 @@ Multiplots - implemented only for the ``bokeh`` provider - are also useful to co
 	vm.add_plot(p4)
 
 	# Threshold
-	th_model = ep.ThresholdModel(g)
+	th_model = th.ThresholdModel(g)
 	config = mc.Configuration()
 
 	# Set individual node threshold