add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _sources / index.txt
1 .. Nepi documentation master file, created by
2    sphinx-quickstart on Tue Mar 26 11:36:35 2013.
3    You can adapt this file completely to your liking, but it should at least
4    contain the root `toctree` directive.
5
6 NEPI modules 
7 ============
8
9 This page documents the NEPI source code. It presents the NEPI core modules, the Platform resource modules (i.e. drivers to manage platforms), and other miscellaneous classes.
10
11 Core modules
12 ------------
13
14   * ExperimentController API
15
16     * :mod:`ExperimentController <nepi.execution.ec>`
17
18   * ResourceManager API
19
20     * :mod:`ResourceManager <nepi.execution.resource>`
21   
22   * Attribute module
23     
24     * :mod:`Attribute <nepi.execution.attribute>`
25   
26   * Trace module
27     
28     * :mod:`Trace <nepi.execution.trace>`
29   
30   * Runner module
31
32     * :mod:`ExperimentRunner <nepi.execution.runner>`
33   
34   * Scheduler module
35
36     * :mod:`Scheduler <nepi.execution.scheduler>`
37
38
39
40 Platform modules
41 ----------------
42
43   * Live Experiments
44
45     * Linux testbeds
46
47       * :mod:`Linux <nepi.resources.linux>`
48
49     * PlanetLab testbeds
50  
51       * :mod:`PlanetLab <nepi.resources.planetlab>`
52
53     * OMF testbed
54
55       * :mod:`OMF <nepi.resources.omf>`
56
57   * Simulated Experiments
58
59     * ns-3 simulator
60
61       * :mod:`ns-3 <nepi.resources.ns3>`    
62
63       * :mod:`ns-3 in Linux hosts <nepi.resources.linux.ns3>`    
64   
65   * Emulated Experiments
66
67     * DCE emulation extension
68
69       * :mod:`DCE Application <nepi.resources.ns3.ns3dceapplication>`    
70
71       * :mod:`DCE Linux Application <nepi.resources.linux.ns3.ns3dceapplication>`    
72     
73     * NetNS emulator
74
75       * :mod:`NetNS <nepi.resources.netns>`    
76
77 Miscellaneous modules
78 ---------------------
79
80       * :mod:`Util <nepi.util>`    
81
82 .. toctree::
83
84
85 Indices and tables
86 ==================
87
88 * :ref:`genindex`
89 * :ref:`modindex`
90 * :ref:`search`
91