Ran update-copyright.py

[hooke.git] / hooke / plugin / autopeak.py

diff --git a/hooke/plugin/autopeak.py b/hooke/plugin/autopeak.py
index ab6117e5c60c80a62eeabb3d1dd206267524b7bf..a575a1ab3d8e1337f6feeafd47954912b609302c 100644 (file)
--- a/hooke/plugin/autopeak.py
+++ b/hooke/plugin/autopeak.py
@@ -1,4 +1,27 @@
-# -*- coding: utf-8 -*-
+# Copyright (C) 2008-2012 Fabrizio Benedetti <fabrizio.benedetti.82@gmail.com>
+#                         Marco Brucale <marco.brucale@unibo.it>
+#                         Massimo Sandal <devicerandom@gmail.com>
+#                         W. Trevor King <wking@tremily.us>
+#
+# This file is part of Hooke.
+#
+# Hooke is free software: you can redistribute it and/or modify it under the
+# terms of the GNU Lesser General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# Hooke is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Hooke.  If not, see <http://www.gnu.org/licenses/>.
+
+"""The autopeak module provides :class:`Autopeak`, a
+:class:`hooke.plugin.Plugin` for automatically extracting force peaks
+(unfolding events) from force curves.
+"""
 
 from hooke.libhooke import WX_GOOD
 
@@ -19,7 +42,10 @@ warnings.simplefilter('ignore',np.RankWarning)
 
 class autopeakCommands(object):
     '''
-    TODO: autopeak docstring.
+    Autopeak carries out force curve fitting with a chosen model:
+        - WLC
+        - FJC
+        - FJC-PEG
     '''
     def do_autopeak(self, args):
         '''
@@ -331,3 +357,4 @@ class autopeakCommands(object):
 
         f.close()
         self.do_note('autopeak')
+