Metadata-Version: 1.0
Name: PythonicGRIB
Version: 0.1.0
Summary: A Pythonic interface for the ECMWF's GRIB API
Home-page: https://github.com/erget/PythonicGRIB
Author: Daniel Lee
Author-email: Lee.Daniel.1986@gmail.com
License: Apache
Description: ============
        PythonicGrib
        ============
        
        PythonicGrib is a Python wrapper for the ECMWF's GRIB API which allows
        interaction with GRIB messagese in a pythonic way.
        
        Working with GRIB files in a context manager like this::
        
            >>> with GribFile(filename) as grib:
            ...     # Print number of messages in file
            ...     len(grib)
            ...     # Open all messages in file
            ...     for msg in grib:
            ...         print(msg["shortName"])
            ...     len(grib.open_messages)
            >>> # When the file is closed, any open messages are closed
            >>> len(grib.open_messages)
        
        Treat messages as a key-value pair::
        
            >>> with GribFile(filename) as grib:
            ...     # Access shortNames of all messages
            ...     for msg in grib:
            ...         print(msg["shortName"])
            ...     # Report number of keys in message
            ...     len(msg)
            ...     # Report message size in bytes
            ...     msg.size
            ...     # Report keys in message
            ...     msg.keys()
            ...     # Check if value is missing
            ...     msg.missing("scaleFactorOfSecondFixedSurface")
            ...     # Set scalar value
            ...     msg["scaleFactorOfSecondFixedSurface"] = 5
            ...     # Check key's value
            ...     msg["scaleFactorOfSecondFixedSurface"]
            ...     # Set value to missing
            ...     msg.set_missing("scaleFactorOfSecondFixedSurface")
            ...     # Missing values raise exception when read with dict notation
            ...     msg["scaleFactorOfSecondFixedSurface"]
            ...     # Array values are set transparently
            ...     msg["values"] = [1, 2, 3]
            ...     # Messages can be written to file
            ...     with open(testfile, "w") as test:
            ...         msg.write(test)
            ...     # Messages can be cloned from other messages
            ...     msg2 = msg.clone()
            ...     # If desired, messages can be closed manually or used in with
            ...     msg.close()
                
        Let indexes worry about taking care of themselves::
        
            >>> # Create index from file with keys
            >>> with GribIndex(filename, keys) as idx:
            ...     # Write index to file
            ...     idx.write(index_file)
            >>> # Read index from file
            >>> with GribIndex(file_index=index_file) as idx:
            ...     # Add new file to index
            ...     idx.add(other_filename)
            ...     # Report number of unique values for given key
            ...     idx.size(key)
            ...     # Report unique values indexed by key
            ...     idx.values(key)
                
        Install with::
        
            python setup.py install
        
        Author: `Daniel Lee <Lee.Daniel.1986@gmail.com>`_
        
Platform: UNKNOWN
