Reference Guide
===============

This page documents the public function and class library for the IRATE format 
tool package. These modules can be used by other programs or users to simplify 
various processing tasks relating to the IRATE format. The following modules are
present:

  * :mod:`~irate.core`
  
    General tools of use with the IRATE format, such as creating standard 
    sections or quickly extracting particles. Note that these functions should 
    be imported directly from the :mod:`irate` namespace.
    
  * :mod:`~irate.validate`
  
    Code for testing if a file obeys the IRATE format and tools for extending
    this process (see :doc:`validators`)
    
  * :mod:`~irate.ahf`
  * :mod:`~irate.gadget`
  * :mod:`~irate.enbid` 
  * :mod:`~irate.rockstar` 
  * :mod:`~irate.tipsy` 
  
    These modules all contain functions used by the :doc:`scripts` to convert 
    files in other formats from or to IRATE.  This documentation is provided
    to allow other programs to easily script such conversions without using
    the command line tools.


Not that the base :mod:`irate` module contains most of the :mod:`irate.core` 
functionality, as well as :attr:`__version__`, which contains a string with the
version of the IRATE tools, and :attr:`formatversion`, which contains an 
integer specifying the format version.


irate.core Module
-----------------
.. automodule:: irate.core
    :members:
    
irate.validate Module
---------------------
.. automodule:: irate.validate
    :members:
    
irate.ahf Module
----------------
.. automodule:: irate.ahf
    :members:
    
irate.gadget Module
-------------------
.. automodule:: irate.gadget
    :members:
    
irate.enbid Module
------------------
.. automodule:: irate.enbid
    :members:
    
irate.rockstar Module
---------------------
.. automodule:: irate.rockstar
    :members:
    
irate.tipsy Module
------------------
.. automodule:: irate.tipsy
    :members: