zoom-cache-0.4.0.0: zoom-cache.cabal

-- zoom-cabal.cabal auto-generated by cabal init. For additional options,
-- see
-- http://www.haskell.org/cabal/release/cabal-latest/doc/users-guide/authors.html#pkg-descr.
-- The name of the package.
Name:                zoom-cache

-- The package version. See the Haskell package versioning policy
-- (http://www.haskell.org/haskellwiki/Package_versioning_policy) for
-- standards guiding when and how versions should be incremented.
Version:             0.4.0.0

-- A short (one-line) description of the package.
Synopsis:            A streamable, seekable, zoomable cache file format

-- A longer description of the package.
Description:
    zoom-cache is a fairly simple data file format for storing and summarizing
    streams of time-series data. The purpose of this format is to make it easy
    to quickly generate plots; /zooming/ refers to being able to render a
    window of data, and being able to quickly change the bounds of the window:
    to move around and to zoom in and out.
    .
    This library provides a monadic writing and an iteratee reading interface
    for zoom-cache files.
    .
    What's neat about this format and library? Glad you asked!
    .
        * Data can be stored at variable or constant rates. For variable rate
    data, a timestamp is explicitly written into the file for every value,
    which is useful for recording events that occur at unpredictable times.
    Constant rate is useful for regularly sampled data, like most digital
    audio and video recordings.
    .
        * While writing a file, summary blocks (such as minimum, maximum,
    mean and RMS values) are written out every n samples. The summary blocks
    are hierarchical, such that after two have been written, a new one
    containing a merged summary of those is written. After two of those Level
    1 summary blocks have been written, a new Level 2 summary block combining
    those is written, and so on.
    .
        * You can write your own zoom-cache codecs for custom data types, or
    to implement custom summary functions. In order to do so you provide a
    'Summary' data type, functions for encoding and decoding raw data values
    and summaries, and a function for merging 'Summary' blocks. For details,
    see "Data.ZoomCache.Codec".
    .
        * Writing of raw data blocks is optional, under control of the
    application. If you already have the raw data stored in an easily
    accessible format, your zoom-cache files may just contain the summary
    data. On the other hand, if your input data is the result of expensive
    calculations you may want to store it along with the summary data so that
    plots of any level of detail can be rendered from a single file.
    .
    When developing applications that read or write zoom-cache files, it should
    be sufficient to import only the module "Data.ZoomCache".
    .

-- The license under which the package is released.
License:             BSD3

-- The file containing the license text.
License-file:        LICENSE

-- The package author(s).
Author:              Conrad Parker

-- An email address to which users can send suggestions, bug reports,
-- and patches.
Maintainer:          conrad@metadecks.org

-- A copyright notice.
-- Copyright:           

-- Stability of the pakcage (experimental, provisional, stable...)
Stability:           Experimental

Category:            Development

Build-type:          Simple

-- Extra files to be distributed with the package, such as examples or
-- a README.
-- Extra-source-files:  

-- Constraint on the version of Cabal needed to build this package.
Cabal-version:       >=1.6


Library
  -- Modules exported by the library.
  Exposed-modules:     Blaze.ByteString.Builder.ZoomCache
                       Data.ZoomCache
                       Data.ZoomCache.Codec
                       Data.ZoomCache.Common
                       Data.ZoomCache.Double
                       Data.ZoomCache.Dump
                       Data.ZoomCache.Format
                       Data.ZoomCache.Int
                       Data.ZoomCache.Pretty
                       Data.ZoomCache.Types
                       Data.ZoomCache.Write
                       Data.Iteratee.ZoomCache
                       Data.Iteratee.ZoomCache.Utils

  Other-modules:       Blaze.ByteString.Builder.ZoomCache.Internal
                       Numeric.FloatMinMax
  
  -- Packages needed in order to build this package.
  -- Build-depends:       
  
  -- Modules not exported by this package.
  -- Other-modules:       
  
  -- Extra tools (e.g. alex, hsc2hs, ...) needed to build the source.
  -- Build-tools:         
  
Executable zoom-cache
  Main-is:             zoom-cache.hs
  Hs-Source-Dirs:      ., tools
  Build-Depends:       base < 5,
                       blaze-builder,
                       bytestring,
                       containers,
                       data-default,
                       iteratee >= 0.8.6.0,
                       MonadCatchIO-transformers,
                       mtl >= 2.0.0.0 && < 3,
                       ui-command

------------------------------------------------------------------------
-- Git repo
--
source-repository head
  type: git
  location: git://github.com/kfish/zoom-cache.git