.. fouriertransform documentation master file, created by
   sphinx-quickstart on Wed May 10 17:16:55 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the FourierTransform documentation
=============================================

``fouriertransform`` is a Python package for analyzing Fourier Transform Ion Cyclotron Resonance Mass Spectrometry (FT-ICR MS) data. ``fouriertransform`` is especially suited for assigning formulae raw MS peaks, categorizing formulae into compound classes according to elemental formula, and creating statistical correlations with environmental parameters.

This package was created by J.D. Hemingway, postdoctoral fellow, Harvard University.

Package Information
-------------------
:Authors:
  Jordon D. Hemingway (jordon_hemingway@harvard.edu)

:Version:
  0.0.8

:Release:
  25 May 2018

:License:
  GNU GPL v3 (or greater)

:url:
  http://github.com/FluvialSeds/fouriertransform

Bug Reports
-----------
This software is still in active deveopment. Please report any bugs directly to me.

How to Cite
-----------
When analyzing data with ``fouriertransform`` to be used in a peer-reviewed
journal, please cite this package as:

* J.D. Hemingway. *fouriertransform*: open-source tools for FT-ICR MS data analysis, 2017-, http://github.com/FluvialSeds/fouriertransform [online; accessed |date|]

Additionally, please cite the following peer-reviewed manuscript describing the deveopment of the package and data treatment:

* **to be added**

Package features
----------------
**to be added later**

Future Additions
~~~~~~~~~~~~~~~~
**to be added later**

License
-------
This product is licensed under the GNU GPL license, version 3 or greater.

Table of Contents
=================

.. toctree::
   :maxdepth: 2

   walkthrough
   package_reference

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`

.. |date| date::