From b325e054f6dea6885ca6557336d074b11b1b9cdc Mon Sep 17 00:00:00 2001 From: Eric Engle Date: Wed, 12 Feb 2020 13:55:52 -0500 Subject: [PATCH] Update index.html --- docs/pytdlpack/index.html | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/pytdlpack/index.html b/docs/pytdlpack/index.html index 343427a..18d7c16 100644 --- a/docs/pytdlpack/index.html +++ b/docs/pytdlpack/index.html @@ -1222,7 +1222,7 @@

1) Creating/Opening/Closing a TDLPACK file.

>>> f = pytdlpack.open('test.sq') >>> type(f) <class 'pytdlpack._pytdlpack.TdlpackFile'> ->>> print f +>>> f byte_order = > data_type = eof = False @@ -1247,7 +1247,7 @@

2) Reading a TDLPACK file.

only 1 record is returned and the TDLPACK indentification sections are unpacked.

Example: Reading a gridded TDLPACK record.

>>> x = f.read()
->>> print x
+>>> x
 grid_length = 2539.703
 id = [223254166         0         6         0]
 ioctet = 998656
@@ -1335,7 +1335,7 @@ 
4) Creating a TDLPACK Station Record.

 be a single call letter string, list, tuple, or comma-delimited string of station call letter records.

 
>>> import pytdlpack
 >>> stations = pytdlpack.TdlpackStationRecord(['KBWI','KDCA','KIAD'])
->>> print stations
+>>> stations
 ccall = ['KBWI', 'KDCA', 'KIAD']
 id = [400001000         0         0         0]
 ioctet = 0
@@ -1574,7 +1574,7 @@ 
Static methods

             
   

     

-    
def read(
self, all=False, unpack=True, id=None)

+    
def read(
self, all=False, unpack=True, id=[9999, 0, 0, 0])

     

     
 
@@ -1588,7 +1588,8 @@ 
Parameters

 
Unpack TDLPACK identification sections.  Note that data are not unpacked.  The default is True.

 
id : array_like or list, optional

 
Provide an ID to search for. This can be either a Numpy.int32 array with shape (4,) or list 
-with length 4.

+with length 4.  The default is [9999,0,0,0] which will signal the random access IO reader
+to sequentially read the file.

 
Returns

 
record [records] : instance [list]

 
An instance of list of instances contaning TdlpackStationRecord,