index.rst

.. ICARTT documentation master file, created by
   sphinx-quickstart on Thu Jul 27 15:24:17 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::

icartt
============================

icartt is an ICARTT file format reader and writer

.. contents::
   :local:
   :depth: 2

Installation
------------

.. include:: ../../icartt/INSTALL.rst

Example
------------

::

   import icartt

   # load a new dataset from an existing file
   ict = icartt.Dataset('path/to/example.ict')

   # list variable names
   ict.varnames
   # e.g. ['Fractional_Day', 'UTC', 'JDAY', 'INDEX', 'FLIGHT', 'LOCAL_SUN_TIME', ...

   # get data for variable 'UTC':
   ict['UTC']

   # some metadata
   ict.organization
   ict.dataSource
   ict.mission

   # write to (other) file:
   with open('path/to/output.ict', 'wb') as f:
      ict.write(f)

API
----

.. module:: icartt

Variable
^^^^^^^^^^

.. autoclass:: Variable


Dataset
^^^^^^^^^^

.. autoclass:: Dataset