Changeset 624 for pvrrd/doc/source/index.rst

Timestamp:

Aug 21, 2011 3:15:37 PM (12 years ago)

Author:

jemian

Message:

converted documentation into initial sphinx documentation -- most code modules need better docstrings

File:

• pvrrd/doc/source/index.rst (modified) (1 diff)

pvrrd/doc/source/index.rst

@@ -4 +4 @@
 =================================
 
-TODO: words of introduction
+Logs EPICS numerical PVs into RRD files and maintains 
+a set of plots for WWW browsing.
+
+This tool records the value of an EPICS (numerical) 
+process variable and peridically records the value into 
+an `rrd <http://oss.oetiker.ch/rrdtool/>`_ database. 
+The database has been configured to present plots for the:
+
+* last hour
+* last day
+* last week
+* last month
+* last year
+* last decade. 
+
+A Python script monitors the PVs and updates the databases. 
+Each PV has its own database which simplifies the addition 
+or removal of PVs from interest. 
+
+A PHP page has been built to provide access to the 
+suite of databases from WWW clients. 
+The ``index.php`` page builds a list of available data 
+and presents that to the WWW client as a table and a 
+representative plot. A link from each PV will bring 
+up a page with plots of the six time spans described 
+for that PV. These pages are generated by CGI scripts, 
+with information pulled immediately from what is 
+available in the database. 
 
 Contents: