Welcome to channelpack's documentation!
***************************************

A small Python library providing an object to hold a number of Numpy
arrays. The object is callable like a function and calls are made to
get at data.

A few factory functions to get a ChannelPack object from data files
are also provided.

Site contents:

.. toctree::
   :maxdepth: 1

   overview_examples
   api_reference
   changelog

Install
=======

To install channelpack, do the usual pip tango::

    $ pip install channelpack

A numpy (https://numpy.org/) installation is assumed and not installed
by channelpack.

Getting the source code
=======================

Get the source for the package::

    $ git clone https://github.com/tomnor/channelpack.git

License
=======

GPL

.. image:: pics/gplv3-127x51.png
   :target: https://www.gnu.org/licenses/gpl-3.0.en.html