aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAnthony LaTorre <telatorre@gmail.com>2011-08-17 14:40:25 -0400
committerAnthony LaTorre <telatorre@gmail.com>2011-08-17 14:40:25 -0400
commitf8a87ff1069d7fab7031804da2d66773be8695a6 (patch)
treebc9807263b3f57f48c1fb2ce28c4bb0920e8a423 /README
parent9cb86aba279caf86769448df877a727f54ebb786 (diff)
downloadlecrunch-f8a87ff1069d7fab7031804da2d66773be8695a6.tar.gz
lecrunch-f8a87ff1069d7fab7031804da2d66773be8695a6.tar.bz2
lecrunch-f8a87ff1069d7fab7031804da2d66773be8695a6.zip
documentation update and open hdf5 files in read only mode in draw.py
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 7 insertions, 2 deletions
diff --git a/README b/README
index 3c59521..03ecf30 100644
--- a/README
+++ b/README
@@ -83,8 +83,13 @@ Turn on sequence mode!
Be aware that as you turn up the number of segments the scope will take
longer to process a single acquisition. The default timeout value for the
socket connection in sock.py is set to 2 seconds; therefore, if an acquisition
-takes longer than 2 seconds, the socket object will raise a timeout exception
-when you request a waveform.
+takes longer than 2 seconds, the socket object may raise a timeout exception
+when you attempt to readout a waveform.
+
+How to Analyze the Waveforms
+----------------------------
+
+Example code to read the waveforms from an hdf5 file is coming soon.
Documentation
-------------