|
Last change
on this file since 624 was
624,
checked in by jemian, 12 years ago
|
|
converted documentation into initial sphinx documentation -- most code modules need better docstrings
|
|
File size:
1.1 KB
|
| Line | |
|---|
| 1 | .. $Id$ |
|---|
| 2 | |
|---|
| 3 | Welcome to pvrrd's documentation! |
|---|
| 4 | ================================= |
|---|
| 5 | |
|---|
| 6 | Logs EPICS numerical PVs into RRD files and maintains |
|---|
| 7 | a set of plots for WWW browsing. |
|---|
| 8 | |
|---|
| 9 | This tool records the value of an EPICS (numerical) |
|---|
| 10 | process variable and peridically records the value into |
|---|
| 11 | an `rrd <http://oss.oetiker.ch/rrdtool/>`_ database. |
|---|
| 12 | The database has been configured to present plots for the: |
|---|
| 13 | |
|---|
| 14 | * last hour |
|---|
| 15 | * last day |
|---|
| 16 | * last week |
|---|
| 17 | * last month |
|---|
| 18 | * last year |
|---|
| 19 | * last decade. |
|---|
| 20 | |
|---|
| 21 | A Python script monitors the PVs and updates the databases. |
|---|
| 22 | Each PV has its own database which simplifies the addition |
|---|
| 23 | or removal of PVs from interest. |
|---|
| 24 | |
|---|
| 25 | A PHP page has been built to provide access to the |
|---|
| 26 | suite of databases from WWW clients. |
|---|
| 27 | The ``index.php`` page builds a list of available data |
|---|
| 28 | and presents that to the WWW client as a table and a |
|---|
| 29 | representative plot. A link from each PV will bring |
|---|
| 30 | up a page with plots of the six time spans described |
|---|
| 31 | for that PV. These pages are generated by CGI scripts, |
|---|
| 32 | with information pulled immediately from what is |
|---|
| 33 | available in the database. |
|---|
| 34 | |
|---|
| 35 | Contents: |
|---|
| 36 | |
|---|
| 37 | .. toctree:: |
|---|
| 38 | :maxdepth: 1 |
|---|
| 39 | |
|---|
| 40 | toc |
|---|
Note: See
TracBrowser
for help on using the repository browser.
