Metadata-Version: 2.1
Name: e1
Version: 0.1.2
Summary: Python support for the e1 compression format.
Home-page: https://github.com/LANL-seismoacoustics/e1
Author: Jonathan MacCarthy
Author-email: jkmacc@lanl.gov
License: MIT
Download-URL: https://github.com/LANL-seismoacoustics/e1/tarball/0.1.0
Description: # e1.py
        
        Python support for the e1 seismic compression format.
        
        "e1" is a variable-length compression algorithm for int32 data.
        
        
        ## Installation
        
        ```python
        pip install e1
        ```
        
        ## Usage
        
        ### Decompress data from a file
        
        ```python
        import e1
        
        file_name = 'some_file.w'
        byte_offset = 0
        nsamples = 1000
        
        with open(file_name, 'rb') as f:
            f.seek(byte_offset)
            data = e1.decompress_file(f, nsamples)
        
        ```
        
        ### Decompress raw bytes
        
        ```python
        with open(file_name, 'rb') as f:
            # Read 5 times as many bytes as you expecte from nsamples x 4-byte values,
            # just to make sure all your nsamples are in it.  Though it may be more data
            # than you need, this gaurds against poorly-compressed data.  
            # In e1, you don't know a priori how many bytes it took to compress your data.
            nbytes = 5 * nsamples * 4
            byts = f.read(nbytes)
        
        data = decompress(byts, nsamples)
        ```
        
Keywords: seismology,geophysics
Platform: Mac OS X
Platform: Linux/Unix
Description-Content-Type: text/markdown
