From: W. Trevor King Date: Sun, 16 May 2010 11:18:31 +0000 (-0400) Subject: Updated copyright blurbs in all files to '# Copyright' X-Git-Url: http://git.tremily.us/?p=hooke.git;a=commitdiff_plain;h=8b12d7d77256982cf9a228901e1e9ed511b43d36 Updated copyright blurbs in all files to '# Copyright' This tag will be replaced by update_copyright.py with the full copyright blurb for each file. --- diff --git a/contrib/mfp_igor_scripts/FMjoin.py b/contrib/mfp_igor_scripts/FMjoin.py index 311892b..317d29c 100644 --- a/contrib/mfp_igor_scripts/FMjoin.py +++ b/contrib/mfp_igor_scripts/FMjoin.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python +# Copyright ''' FMjoin.py @@ -6,10 +6,6 @@ Copies all .ibw files contained in a folder and its subfolders into a single fol Usage: python FMjoin.py origindir destdir - - -Alberto Gomez-Casado (c) 2010, University of Twente (The Netherlands) -This program is released under the GNU General Public License version 2. ''' import os diff --git a/contrib/mfp_igor_scripts/h5export.py b/contrib/mfp_igor_scripts/h5export.py index f49b3a8..7ae05e6 100644 --- a/contrib/mfp_igor_scripts/h5export.py +++ b/contrib/mfp_igor_scripts/h5export.py @@ -1,3 +1,5 @@ +# Copyright + import h5py import numpy import os diff --git a/doc/generate-hooke-txt.py b/doc/generate-hooke-txt.py index 653c1a6..0dbd122 100644 --- a/doc/generate-hooke-txt.py +++ b/doc/generate-hooke-txt.py @@ -1,6 +1,6 @@ #!/usr/bin/python # -# COPYRIGHT +# Copyright """Auto-generate reStructuredText of the hooke module tree for Sphinx. diff --git a/hooke/__init__.py b/hooke/__init__.py index 283d0dd..ed8eb58 100644 --- a/hooke/__init__.py +++ b/hooke/__init__.py @@ -1,4 +1,4 @@ -# COPYRIGHT +# Copyright """The hooke module does all the legwork for Hooke_. diff --git a/hooke/command.py b/hooke/command.py index 1cdb56f..115c703 100644 --- a/hooke/command.py +++ b/hooke/command.py @@ -1,3 +1,5 @@ +# Copyright + """The `command` module provides :class:`Command`\s and :class:`Argument`\s for defining commands. diff --git a/hooke/compat/__init__.py b/hooke/compat/__init__.py new file mode 100644 index 0000000..b98f164 --- /dev/null +++ b/hooke/compat/__init__.py @@ -0,0 +1 @@ +# Copyright diff --git a/hooke/config.py b/hooke/config.py index 03da0c9..7218e5f 100644 --- a/hooke/config.py +++ b/hooke/config.py @@ -1,13 +1,8 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# Copyright -''' -config.py - -Configuration defaults, read/write, and template file creation for Hooke. - -COPYRIGHT -''' +"""Configuration defaults, read/write, and template file creation for +Hooke. +""" import ConfigParser as configparser import os.path diff --git a/hooke/curve.py b/hooke/curve.py index 2f8f14c..6619967 100644 --- a/hooke/curve.py +++ b/hooke/curve.py @@ -1,3 +1,5 @@ +# Copyright + """The `curve` module provides :class:`Curve` and :class:`Data` for storing force curves. """ diff --git a/hooke/driver/__init__.py b/hooke/driver/__init__.py index c8a85e7..82c028c 100644 --- a/hooke/driver/__init__.py +++ b/hooke/driver/__init__.py @@ -1,3 +1,5 @@ +# Copyright + """The driver module provides :class:`Driver`\s for identifying and reading data files. diff --git a/hooke/driver/csvdriver.py b/hooke/driver/csvdriver.py index 73232d2..5fff4c4 100644 --- a/hooke/driver/csvdriver.py +++ b/hooke/driver/csvdriver.py @@ -1,16 +1,13 @@ -''' -csvdriver.py +# Copyright -Simple driver to read general comma-separated values in Hooke +"""Simple driver to read general comma-separated values in Hooke Columns are read this way: X1 , Y1 , X2 , Y2 , X3 , Y3 ... If the number of columns is odd, the last column is ignored. - -(c)Massimo Sandal, 2008 -''' +""" from .. import curve as lhc from .. import libhooke as lh diff --git a/hooke/driver/hdf5.py b/hooke/driver/hdf5.py index e9d2a41..f3f4dbc 100644 --- a/hooke/driver/hdf5.py +++ b/hooke/driver/hdf5.py @@ -1,13 +1,7 @@ -#!/usr/bin/env python +# Copyright -''' -hdf5.py - -Driver for text-exported HDF5 files from Igor pro - -Alberto Gomez-Casado (c) 2010 -Massimo Sandal (c) 2009 -''' +"""Driver for text-exported HDF5 files from Igor pro +""" from .. import curve as lhc from .. import libhooke as lh diff --git a/hooke/driver/hemingclamp.py b/hooke/driver/hemingclamp.py index 6be0b45..3017113 100644 --- a/hooke/driver/hemingclamp.py +++ b/hooke/driver/hemingclamp.py @@ -1,12 +1,7 @@ -''' -libhemingclamp.py - -Library for interpreting Hemingway force spectroscopy files. +# Copyright -Copyright (C) 2008 Massimo Sandal, Marco Brucale (University of Bologna, Italy) - -This program is released under the GNU General Public License version 2. -''' +"""Library for interpreting Hemingway force spectroscopy files. +""" __version__='2007_02_15_devel' __changelog__=''' diff --git a/hooke/driver/jpk.py b/hooke/driver/jpk.py index 2888778..96d6e00 100644 --- a/hooke/driver/jpk.py +++ b/hooke/driver/jpk.py @@ -1,3 +1,5 @@ +# Copyright + import string from .. import curve as lhc diff --git a/hooke/driver/mcs.py b/hooke/driver/mcs.py index 2d7c419..9d17903 100644 --- a/hooke/driver/mcs.py +++ b/hooke/driver/mcs.py @@ -1,10 +1,7 @@ -''' -mcs.py +# Copyright -driver for mcs fluorescence files - -Massimo Sandal, Allen Chen (c) 2009 -''' +"""Driver for mcs fluorescence files +""" from .. import curve as lhc from .. import libhooke as lh diff --git a/hooke/driver/mfp1dexport.py b/hooke/driver/mfp1dexport.py index 8239fc3..9e03a6b 100644 --- a/hooke/driver/mfp1dexport.py +++ b/hooke/driver/mfp1dexport.py @@ -1,10 +1,7 @@ -''' -mfp1dexport.py +# Copyright -Driver for text-exported MFP 1D files - -Massimo Sandal (c) 2009 -''' +"""Driver for text-exported MFP 1D files +""" import os diff --git a/hooke/driver/mfp3d.py b/hooke/driver/mfp3d.py index f182df5..20bc7b2 100644 --- a/hooke/driver/mfp3d.py +++ b/hooke/driver/mfp3d.py @@ -1,18 +1,14 @@ -#!/usr/bin/env python +# Copyright -''' -mfp3d.py +"""Driver for MFP-3D files. -Driver for MFP-3D files. +This driver reads Igor binary waves. -Copyright 2010 by Dr. Rolf Schmidt (Concordia University, Canada) -This driver is based on the work of R. Naud and A. Seeholzer (see below) -to read Igor binary waves. Code used with permission. - -Modified for usage with Hooke CLI by Alberto Gomez-Casado (University of Twente, The Netherlands) - -This program is released under the GNU General Public License version 2. -''' +AUTHORS: +Matlab version: Richard Naud August 2008 (http://lcn.epfl.ch/~naud/) +Python port: A. Seeholzer October 2008 +Hooke submission: Rolf Schmidt, Alberto Gomez-Casado 2009 +""" # DEFINITION: # Reads Igor's (Wavemetric) binary wave format, .ibw, files. @@ -22,10 +18,6 @@ This program is released under the GNU General Public License version 2. # http://mirror.optus.net.au/pub/wavemetrics/IgorPro/Technical_Notes/) and data # type 2 or 4 (non complex, single or double precision vector, real values). # -# AUTHORS: -# Matlab version: R. Naud August 2008 (http://lcn.epfl.ch/~naud/Home.html) -# Python port: A. Seeholzer October 2008 -# # VERSION: 0.1 # # COMMENTS: diff --git a/hooke/driver/picoforce.py b/hooke/driver/picoforce.py index 170fc9f..7e96e04 100644 --- a/hooke/driver/picoforce.py +++ b/hooke/driver/picoforce.py @@ -1,12 +1,7 @@ -''' -libpicoforce.py +# Copyright -Library for interpreting Picoforce force spectroscopy files. - -Copyright (C) 2006 Massimo Sandal (University of Bologna, Italy). - -This program is released under the GNU General Public License version 2. -''' +"""Library for interpreting Picoforce force spectroscopy files. +""" import re import struct diff --git a/hooke/driver/picoforcealt.py b/hooke/driver/picoforcealt.py index 8f7a494..904cabc 100644 --- a/hooke/driver/picoforcealt.py +++ b/hooke/driver/picoforcealt.py @@ -1,13 +1,9 @@ -''' -libpicoforce.py +# Copyright -Library for interpreting Picoforce force spectroscopy files. Alternate version +"""Library for interpreting Picoforce force spectroscopy files. -Copyright (C) 2006 Massimo Sandal (University of Bologna, Italy). -Copyright (C) 2008 Alberto Gomez-Casado (University of Twente, Netherlands). - -This program is released under the GNU General Public License version 2. -''' +An alternave implementation of :mod:`hooke.driver.picoforce`. +""" import re, struct from scipy import arange diff --git a/hooke/driver/tutorial.py b/hooke/driver/tutorial.py index 0081224..a8b59cd 100644 --- a/hooke/driver/tutorial.py +++ b/hooke/driver/tutorial.py @@ -1,5 +1,4 @@ -# Copyright (c) 2008 Massimo Sandal -# 2010 W. Trevor King +# Copyright """Tutorial driver for Hooke. diff --git a/hooke/engine.py b/hooke/engine.py index c70ee6b..f5f6d05 100644 --- a/hooke/engine.py +++ b/hooke/engine.py @@ -1,3 +1,5 @@ +# Copyright + """The `engine` module provides :class:`CommandEngine` for executing :class:`hooke.command.Command`\s. """ diff --git a/hooke/experiment.py b/hooke/experiment.py index e9bf27b..22a9af3 100644 --- a/hooke/experiment.py +++ b/hooke/experiment.py @@ -1,3 +1,5 @@ +# Copyright + """Define :class:`Experiment` and assorted subclasses. This allows :class:`hooke.plugin.Plugin`\s to specify the types of diff --git a/hooke/hooke.py b/hooke/hooke.py index 60449a1..b2b5998 100644 --- a/hooke/hooke.py +++ b/hooke/hooke.py @@ -1,12 +1,7 @@ -#!/usr/bin/env python +# Copyright -''' -Hooke - A force spectroscopy review & analysis tool. - -A free, open source data analysis platform - -COPYRIGHT -''' +"""Hooke - A force spectroscopy review & analysis tool. +""" import multiprocessing import optparse diff --git a/hooke/interaction.py b/hooke/interaction.py index 0f91d6a..b0055e7 100644 --- a/hooke/interaction.py +++ b/hooke/interaction.py @@ -1,3 +1,5 @@ +# Copyright + """The `interaction` module provides :class:`Request`, :class:`Response`, an related classes for handling user interaction through the diff --git a/hooke/playlist.py b/hooke/playlist.py index 1d5e994..87fc073 100644 --- a/hooke/playlist.py +++ b/hooke/playlist.py @@ -1,3 +1,5 @@ +# Copyright + """The `playlist` module provides a :class:`Playlist` and its subclass :class:`FilePlaylist` for manipulating lists of :class:`hooke.curve.Curve`\s. diff --git a/hooke/plugin/__init__.py b/hooke/plugin/__init__.py index 98862c6..65835a7 100644 --- a/hooke/plugin/__init__.py +++ b/hooke/plugin/__init__.py @@ -1,3 +1,5 @@ +# Copyright + """The `plugin` module provides optional submodules that add new Hooke commands. diff --git a/hooke/plugin/autopeak.py b/hooke/plugin/autopeak.py index dee9e88..e6c4c27 100644 --- a/hooke/plugin/autopeak.py +++ b/hooke/plugin/autopeak.py @@ -1,5 +1,4 @@ -# -*- coding: utf-8 -*- -# COPYRIGHT +# Copyright """The autopeak module provides :class:`Autopeak`, a :class:`hooke.plugin.Plugin` for automatically extracting force peaks diff --git a/hooke/plugin/config.py b/hooke/plugin/config.py index 594ffa9..a4af140 100644 --- a/hooke/plugin/config.py +++ b/hooke/plugin/config.py @@ -1,3 +1,5 @@ +# Copyright + """The `config` module provides :class:`ConfigPlugin` and several associated :class:`hooke.command.Command`\s for handling :mod:`hooke.config` classes. diff --git a/hooke/plugin/curvetools.py b/hooke/plugin/curvetools.py index f760cb8..8f3ec36 100755 --- a/hooke/plugin/curvetools.py +++ b/hooke/plugin/curvetools.py @@ -1,4 +1,5 @@ -# -*- coding: utf-8 -*- +# Copyright + from ..libhooke import WX_GOOD, ClickedPoint import wxversion diff --git a/hooke/plugin/cut.py b/hooke/plugin/cut.py index 369cfcc..18aa4af 100644 --- a/hooke/plugin/cut.py +++ b/hooke/plugin/cut.py @@ -1,3 +1,5 @@ +# Copyright + """The `cut` module provides :class:`CutPlugin` and :class:`CutCommand`. """ diff --git a/hooke/plugin/debug.py b/hooke/plugin/debug.py index c44ba03..405fdde 100644 --- a/hooke/plugin/debug.py +++ b/hooke/plugin/debug.py @@ -1,3 +1,5 @@ +# Copyright + """The `debug` module provides :class:`DebugPlugin` and associated :class:`hooke.command.Command`\s which provide useful debugging information. diff --git a/hooke/plugin/fit.py b/hooke/plugin/fit.py index 767110e..7646694 100644 --- a/hooke/plugin/fit.py +++ b/hooke/plugin/fit.py @@ -1,15 +1,11 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# Copyright -''' -FIT - -Force spectroscopy curves basic fitting plugin. -Licensed under the GNU GPL version 2 +"""Force spectroscopy curves basic fitting plugin. Non-standard Dependencies: procplots.py (plot processing plugin) -''' +""" + from ..libhooke import WX_GOOD, ClickedPoint import wxversion diff --git a/hooke/plugin/flatfilts-rolf.py b/hooke/plugin/flatfilts-rolf.py index 0aa34f0..2738cef 100644 --- a/hooke/plugin/flatfilts-rolf.py +++ b/hooke/plugin/flatfilts-rolf.py @@ -1,14 +1,10 @@ -#!/usr/bin/env python +# Copyright -''' -FLATFILTS - -Force spectroscopy curves filtering of flat curves -Licensed under the GNU LGPL version 2 +"""Force spectroscopy curves filtering of flat curves Other plugin dependencies: procplots.py (plot processing plugin) -''' +""" import xml.dom.minidom diff --git a/hooke/plugin/flatfilts.py b/hooke/plugin/flatfilts.py index 2b5a79b..156531b 100644 --- a/hooke/plugin/flatfilts.py +++ b/hooke/plugin/flatfilts.py @@ -1,15 +1,10 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# Copyright -''' -FLATFILTS - -Force spectroscopy curves filtering of flat curves -Licensed under the GNU LGPL version 2 +"""Force spectroscopy curves filtering of flat curves Other plugin dependencies: procplots.py (plot processing plugin) -''' +""" from hooke.libhooke import WX_GOOD diff --git a/hooke/plugin/generalclamp.py b/hooke/plugin/generalclamp.py index 0ac2164..0f99be9 100644 --- a/hooke/plugin/generalclamp.py +++ b/hooke/plugin/generalclamp.py @@ -1,8 +1,8 @@ -''' -GENERALCLAMP.py +# Copyright + +"""Plugin regarding general force clamp measurements +""" -Plugin regarding general force clamp measurements -''' from hooke.libhooke import WX_GOOD, ClickedPoint import wxversion diff --git a/hooke/plugin/generaltccd.py b/hooke/plugin/generaltccd.py index 395da08..cc47121 100644 --- a/hooke/plugin/generaltccd.py +++ b/hooke/plugin/generaltccd.py @@ -1,8 +1,7 @@ -''' -generaltccd.py +# Copyright -General utilities for TCCD stuff -''' +"""General utilities for TCCD stuff +""" class generaltccdCommands(object): diff --git a/hooke/plugin/generalvclamp.py b/hooke/plugin/generalvclamp.py index ef644c0..c16821a 100644 --- a/hooke/plugin/generalvclamp.py +++ b/hooke/plugin/generalvclamp.py @@ -1,11 +1,7 @@ -#!/usr/bin/env python -# -*- coding: iso-8859-1 -*- +# Copyright -''' -generalvclamp.py - -Plugin regarding general velocity clamp measurements -''' +"""Plugin regarding general velocity clamp measurements +""" from hooke.libhooke import WX_GOOD, ClickedPoint import wxversion diff --git a/hooke/plugin/jumpstat.py b/hooke/plugin/jumpstat.py index 9175b5c..d8885d1 100755 --- a/hooke/plugin/jumpstat.py +++ b/hooke/plugin/jumpstat.py @@ -1,4 +1,5 @@ -# -*- coding: utf-8 -*- +# Copyright + from ..libhooke import WX_GOOD, ClickedPoint import wxversion wxversion.select(WX_GOOD) diff --git a/hooke/plugin/macro.py b/hooke/plugin/macro.py index d2f92d4..a08c787 100644 --- a/hooke/plugin/macro.py +++ b/hooke/plugin/macro.py @@ -1,9 +1,7 @@ -''' -COMMAND MACRO PLUGIN FOR HOOKE +# Copyright -Records, saves and executes batches of commands -(c)Alberto Gomez-Casado 2008 -''' +"""Records, saves and executes batches of commands +""" import os.path import string diff --git a/hooke/plugin/massanalysis.py b/hooke/plugin/massanalysis.py index 74e4836..be09c9f 100644 --- a/hooke/plugin/massanalysis.py +++ b/hooke/plugin/massanalysis.py @@ -1,12 +1,11 @@ -''' -massanalysis.py +# Copyright -Global analysis of force curves with various parameters +"""Global analysis of force curves with various parameters Requires: libpeakspot.py flatfilts.py -''' +""" import numpy as np import csv diff --git a/hooke/plugin/multidistance.py b/hooke/plugin/multidistance.py index e2370b6..fb4482b 100644 --- a/hooke/plugin/multidistance.py +++ b/hooke/plugin/multidistance.py @@ -1,4 +1,5 @@ -# -*- coding: utf-8 -*- +# Copyright + from hooke.libhooke import WX_GOOD, ClickedPoint import wxversion diff --git a/hooke/plugin/multifit.py b/hooke/plugin/multifit.py index 2e620fd..26440e9 100644 --- a/hooke/plugin/multifit.py +++ b/hooke/plugin/multifit.py @@ -1,11 +1,4 @@ -#!/usr/bin/env python - -''' -multifit.py - -Alberto Gomez-Casado, (c) 2010, University of Twente (The Netherlands) -Licensed under GNU GPL v2 -''' +# Copyright #FIXME clean this, probably some dependencies are not needed diff --git a/hooke/plugin/note.py b/hooke/plugin/note.py index 4808a3b..1da2dc0 100644 --- a/hooke/plugin/note.py +++ b/hooke/plugin/note.py @@ -1,3 +1,5 @@ +# Copyright + """The `note` module provides :class:`NotePlugin` the associated :class:`hooke.command.Command`\s for annotating several Hooke classes (:mod:`hooke.playlist.Playlist`, :mod:`hooke.curve.Curve`, ...). diff --git a/hooke/plugin/pcluster.py b/hooke/plugin/pcluster.py index 479c71c..54f24d3 100644 --- a/hooke/plugin/pcluster.py +++ b/hooke/plugin/pcluster.py @@ -1,5 +1,5 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# Copyright + from ..libhooke import WX_GOOD, ClickedPoint, config_file_path from mdp import pca diff --git a/hooke/plugin/peakspot.py b/hooke/plugin/peakspot.py index a81112d..bb0fc87 100644 --- a/hooke/plugin/peakspot.py +++ b/hooke/plugin/peakspot.py @@ -1,8 +1,8 @@ -''' -a library of helping functions for spotting force spectroscopy peaks +# Copyright + +"""a library of helping functions for spotting force spectroscopy peaks. +""" -(c)Fabrizio Benedetti and Massimo Sandal , 2007 -''' import numpy as np def conv_dx(data,vect): diff --git a/hooke/plugin/playlist.py b/hooke/plugin/playlist.py index 2e94382..33ff5e6 100644 --- a/hooke/plugin/playlist.py +++ b/hooke/plugin/playlist.py @@ -1,3 +1,5 @@ +# Copyright + """The `playlist` module provides :class:`PlaylistPlugin` several associated :class:`hooke.command.Command`\s for handling :mod:`hooke.playlist` classes. diff --git a/hooke/plugin/procplots.py b/hooke/plugin/procplots.py index c7ac871..066eee3 100644 --- a/hooke/plugin/procplots.py +++ b/hooke/plugin/procplots.py @@ -1,9 +1,8 @@ -''' -PROCPLOTS -Processed plots plugin for force curves. +# Copyright + +"""Processed plots plugin for force curves. +""" -Licensed under the GNU GPL version 2 -''' from ..libhooke import WX_GOOD import wxversion wxversion.select(WX_GOOD) diff --git a/hooke/plugin/review.py b/hooke/plugin/review.py index 715a4a3..e19be0c 100644 --- a/hooke/plugin/review.py +++ b/hooke/plugin/review.py @@ -1,8 +1,4 @@ -#!/usr/bin/env python - -'''review.py -Alberto Gomez-Casado (c) 2010 University of Twente -''' +# Copyright from ..libhooke import WX_GOOD import wxversion diff --git a/hooke/plugin/showconvoluted.py b/hooke/plugin/showconvoluted.py index 719f980..ad76521 100644 --- a/hooke/plugin/showconvoluted.py +++ b/hooke/plugin/showconvoluted.py @@ -1,11 +1,7 @@ -#!/usr/bin/env python +# Copyright -''' -SHOW CONVOLUTED CURVE PLUGIN FOR HOOKE - -This plugin contains a plotmanipulator to show the convoluted curve. -(c) Dr. Rolf Schmidt, 2009 -''' +"""This plugin contains a plotmanipulator to show the convoluted curve. +""" import libpeakspot diff --git a/hooke/plugin/superimpose.py b/hooke/plugin/superimpose.py index 708cafd..c3d619b 100644 --- a/hooke/plugin/superimpose.py +++ b/hooke/plugin/superimpose.py @@ -1,3 +1,5 @@ +# Copyright + from ..libhooke import WX_GOOD import wxversion wxversion.select(WX_GOOD) diff --git a/hooke/plugin/system.py b/hooke/plugin/system.py index 5a56ded..7f49036 100644 --- a/hooke/plugin/system.py +++ b/hooke/plugin/system.py @@ -1,3 +1,5 @@ +# Copyright + """The `system` module provides :class:`SystemPlugin` and several associated :class:`hooke.command.Command`\s for interacting with the operating system and execution environment. diff --git a/hooke/plugin/tutorial.py b/hooke/plugin/tutorial.py index fde2a9f..349118e 100644 --- a/hooke/plugin/tutorial.py +++ b/hooke/plugin/tutorial.py @@ -1,10 +1,8 @@ -''' -TUTORIAL PLUGIN FOR HOOKE +# Copyright -This plugin contains example commands to teach how to write an Hooke plugin, including description of main Hooke -internals. -(c)Massimo Sandal 2007 -''' +"""This plugin contains example commands to teach how to write an +Hooke plugin, including description of main Hooke internals. +""" import numpy as np diff --git a/hooke/ui/__init__.py b/hooke/ui/__init__.py index 1f2bd4e..8805aa9 100644 --- a/hooke/ui/__init__.py +++ b/hooke/ui/__init__.py @@ -1,3 +1,5 @@ +# Copyright + """The `ui` module provides :class:`UserInterface` and various subclasses. """ diff --git a/hooke/ui/commandline.py b/hooke/ui/commandline.py index 9b2effe..7d090a3 100644 --- a/hooke/ui/commandline.py +++ b/hooke/ui/commandline.py @@ -1,3 +1,5 @@ +# Copyright + """Defines :class:`CommandLine` for driving Hooke from the command line. """ diff --git a/hooke/ui/gui/driver.py b/hooke/ui/gui/driver.py index 57d6b18..0e60ae6 100644 --- a/hooke/ui/gui/driver.py +++ b/hooke/ui/gui/driver.py @@ -1,3 +1,5 @@ +# Copyright + def _generate_vectors(self): """ diff --git a/hooke/ui/gui/export.py b/hooke/ui/gui/export.py index 3f5b4a7..ffc96bc 100644 --- a/hooke/ui/gui/export.py +++ b/hooke/ui/gui/export.py @@ -1,3 +1,5 @@ +# Copyright + #PLOT EXPORT AND MANIPULATION COMMANDS def help_export(self): print ''' diff --git a/hooke/ui/gui/formatter.py b/hooke/ui/gui/formatter.py index 9297d10..d810d19 100644 --- a/hooke/ui/gui/formatter.py +++ b/hooke/ui/gui/formatter.py @@ -1,16 +1,7 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- +# Copyright -''' -formatter.py - -Number formatting utilities for Hooke. - -Copyright (C) 2006 Massimo Sandal (University of Bologna, Italy). -With algorithms contributed by Francesco Musiani (University of Bologna, Italy) - -This program is released under the GNU General Public License version 2. -''' +"""A number formatting utilities for Hooke. +""" from matplotlib.ticker import ScalarFormatter diff --git a/hooke/ui/gui/hookeplaylist.py b/hooke/ui/gui/hookeplaylist.py index 2646316..e01d456 100644 --- a/hooke/ui/gui/hookeplaylist.py +++ b/hooke/ui/gui/hookeplaylist.py @@ -1,3 +1,5 @@ +# Copyright + #import os #import os.path import wx diff --git a/hooke/ui/gui/hookepropertyeditor.py b/hooke/ui/gui/hookepropertyeditor.py index 402b6f3..78bd7bd 100644 --- a/hooke/ui/gui/hookepropertyeditor.py +++ b/hooke/ui/gui/hookepropertyeditor.py @@ -1,3 +1,5 @@ +# Copyright + import sys import time import math diff --git a/hooke/ui/gui/hookeresults.py b/hooke/ui/gui/hookeresults.py index ecf71f0..246407a 100644 --- a/hooke/ui/gui/hookeresults.py +++ b/hooke/ui/gui/hookeresults.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python +# Copyright import sys import wx diff --git a/hooke/ui/gui/plot.py b/hooke/ui/gui/plot.py index 23c64a1..76b3662 100644 --- a/hooke/ui/gui/plot.py +++ b/hooke/ui/gui/plot.py @@ -1,3 +1,5 @@ +# Copyright + class PlotObject(object): def __init__(self): diff --git a/hooke/ui/gui/plotcommands.py b/hooke/ui/gui/plotcommands.py index 7dd67d6..7e5579b 100644 --- a/hooke/ui/gui/plotcommands.py +++ b/hooke/ui/gui/plotcommands.py @@ -1,3 +1,5 @@ +# Copyright + #PLOT INTERACTION COMMANDS #------------------------------- def help_plot(self): diff --git a/hooke/ui/gui/point_request.py b/hooke/ui/gui/point_request.py index f0813c7..0c25083 100644 --- a/hooke/ui/gui/point_request.py +++ b/hooke/ui/gui/point_request.py @@ -1,3 +1,5 @@ +# Copyright + class ClickedPoint(object): ''' this class defines what a clicked point on the curve plot is diff --git a/hooke/ui/gui/prettyformat.py b/hooke/ui/gui/prettyformat.py index 32ee405..0b6c984 100644 --- a/hooke/ui/gui/prettyformat.py +++ b/hooke/ui/gui/prettyformat.py @@ -1,18 +1,14 @@ -''' -// -// prettyformat.py - simple Python function to format values with nice prefixes -// Version 1.0.1 -// -// History -// 2009 07 16: added negative number support -// added decimal-formatted output -// -// Copyright (c) 2009 Rolf Schmidt, Montreal -// rschmidt@alcor.concordia.ca -// -// This procedure is released under the GNU General Public License version 2 -// -''' +# Copyright + +"""Format values with nice prefixes. +History: + +* 2009 07 16: + + * added negative number support + * added decimal-formatted output +""" +__version__ = "1.0.1" import math from numpy import isnan @@ -138,4 +134,4 @@ iDecimals=3 for aValue in scaleValues: print decimalFormat(aValue/iMultiplier, iDecimals), #print the scale label using the value at iIndex print '\n'+get_prefix(scaleValues[iIndex])+'N' -''' \ No newline at end of file +''' diff --git a/hooke/ui/gui/results.py b/hooke/ui/gui/results.py index c79b3be..3baf493 100644 --- a/hooke/ui/gui/results.py +++ b/hooke/ui/gui/results.py @@ -1,3 +1,5 @@ +# Copyright + import prettyformat DEFAULT_COLOR = 'orange' diff --git a/hooke/util/__init__.py b/hooke/util/__init__.py index 8b1bf74..ab17e10 100644 --- a/hooke/util/__init__.py +++ b/hooke/util/__init__.py @@ -1,4 +1,4 @@ -# COPYRIGHT +# Copyright """The util module contains assorted utilities not directly associated with Hooke functionality. diff --git a/hooke/util/graph.py b/hooke/util/graph.py index c2302e0..227acce 100644 --- a/hooke/util/graph.py +++ b/hooke/util/graph.py @@ -1,4 +1,4 @@ -# COPYRIGHT +# Copyright """Define :class:`Graph`, a directed, acyclic graph structure. :class:`Graph`\s are composed of :class:`Node`\s, also defined by this diff --git a/hooke/util/pluggable.py b/hooke/util/pluggable.py index 4f595c0..92d1f28 100644 --- a/hooke/util/pluggable.py +++ b/hooke/util/pluggable.py @@ -1,3 +1,5 @@ +# Copyright + """`pluggable` """ diff --git a/setup.py b/setup.py index db44e7c..4e41355 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,5 @@ +# Copyright + """Hooke: tools for analyzing force spectroscopy data. Mercurial repository: diff --git a/test/__init__.py b/test/__init__.py index 9c4c13d..66a267b 100644 --- a/test/__init__.py +++ b/test/__init__.py @@ -1,3 +1,5 @@ +# Copyright + """Hooke integration tests. Besides the unittests embedded in the Hooke code, we also want to diff --git a/test/load_playlist.py b/test/load_playlist.py index 9f57285..49373ee 100644 --- a/test/load_playlist.py +++ b/test/load_playlist.py @@ -1,3 +1,5 @@ +# Copyright + """ >>> from hooke.hooke import Hooke >>> h = Hooke()