linketurbidity 0.0.6
A python library that simplify the access to the linketurbidity index.
License: MIT

linketurbidity
==============

|Gitter|

|License| |Downloads| |Build Status| |Coverage Status| |Code Health|
|PyPI version| |Stories in Ready|

A python library that simplifies the access to the linke turbidity
index.

Requirements
============

If you want to use this library on any GNU/Linux or OSX system you just
need to execute:

::

    $ pip install linketurbidity

If you want to improve this library, you should download the `github
repository <https://github.com/gersolar/linketurbidity>`__ and execute:

::

    $ make deploy

On Ubuntu Desktop there are some other libraries not installed by
default (zlibc libbz2-dev) which may need to be installed to use these
library. Use the next command to automate the installation of the
additional C libraries:

::

    $ make ubuntu deploy

Testing
=======

To test all the project you should use the command:

::

    $ make test

If you want to help us or report an issue join to us through the `GitHub
issue tracker <https://github.com/gersolar/linketurbidity/issues>`__.

Example
=======

There are 3 methods to obtain the linke turbidity matrix:

1. obtain
2. obtain\_to
3. persist

The **obtain** method needs a datetime object:

.. code:: python

        from linketurbidity import instrument
        from datetime import datetime

        linke_matrix = instrument.obtain(datetime(2014, 11, 10))

Next, the **obtain\_to** method needs a standard NOAA CLASS netcdf
filename to parse:

.. code:: python

        from linketurbidity import instrument
        from datetime import datetime

        linke_matrix = instrument.obtain_to('data/goes13.2014.124.123422.BAND_01.nc')

Last, the **persist** method needs a standard NOAA CLASS netcdf filename
to save the variables:

.. code:: python

        from linketurbidity import instrument
        from datetime import datetime
        from netcdf import netcdf as nc

        instrument.persist('data/goes13.2014.124.123422.BAND_01.nc')
        with nc.loader('data/goes13.2014.124.123422.BAND_01.nc') as root:
            print nc.getvar(root, 'linke')[:]

About
=====

This software is developed by
`GERSolar <http://www.gersol.unlu.edu.ar/>`__. You can contact us to
gersolar.dev@gmail.com.

.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
   :target: https://gitter.im/gersolar/linketurbidity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |License| image:: https://img.shields.io/pypi/l/linketurbidity.svg
   :target: https://raw.githubusercontent.com/limiear/linketurbidity/master/LICENSE
.. |Downloads| image:: https://img.shields.io/pypi/dm/linketurbidity.svg
   :target: https://pypi.python.org/pypi/linketurbidity/
.. |Build Status| image:: https://travis-ci.org/gersolar/linketurbidity.svg?branch=master
   :target: https://travis-ci.org/gersolar/linketurbidity
.. |Coverage Status| image:: https://coveralls.io/repos/gersolar/linketurbidity/badge.png
   :target: https://coveralls.io/r/gersolar/linketurbidity
.. |Code Health| image:: https://landscape.io/github/gersolar/linketurbidity/master/landscape.png
   :target: https://landscape.io/github/gersolar/linketurbidity/master
.. |PyPI version| image:: https://badge.fury.io/py/linketurbidity.svg
   :target: http://badge.fury.io/py/linketurbidity
.. |Stories in Ready| image:: https://badge.waffle.io/gersolar/linketurbidity.png?label=ready&title=Ready
   :target: https://waffle.io/gersolar/linketurbidity