1 # Copyright (C) 2010 W. Trevor King <wking@drexel.edu>
3 # This file is part of Hooke.
5 # Hooke is free software: you can redistribute it and/or modify it
6 # under the terms of the GNU Lesser General Public License as
7 # published by the Free Software Foundation, either version 3 of the
8 # License, or (at your option) any later version.
10 # Hooke is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
13 # Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with Hooke. If not, see
17 # <http://www.gnu.org/licenses/>.
19 """Tutorial driver for Hooke.
21 This example driver explains driver construction.
25 Here we define a simple file format that is read by this driver. The
26 file format is as following::
61 that is, two plots with two datasets each.
66 # The following are relative imports. See PEP 328 for details
67 # http://www.python.org/dev/peps/pep-0328/
68 from .. import curve as curve # this module defines data containers.
69 from .. import experiment as experiment # this module defines expt. types
70 from ..config import Setting # configurable setting class
71 from . import Driver as Driver # this is the Driver base class
73 # The driver must inherit from the parent
74 # :class:`hooke.driver.Driver` (which we have imported as `Driver`).
75 class TutorialDriver (Driver):
76 """Handle simple text data as an example Driver.
79 """YOU MUST OVERRIDE Driver.__init__.
81 Here you set a value for `name` to identify your driver. It
82 should match the module name.
84 super(TutorialDriver, self).__init__(name='tutorial')
86 def default_settings(self):
87 """Return a list of any configurable settings for your driver.
89 If your driver does not have any configurable settings, there
90 is no need to override this method.
93 Setting(section=self.setting_section, help=self.__doc__),
94 Setting(section=self.setting_section, option='x units', value='nm',
95 help='Set the units used for the x data.'),
98 def is_me(self, path):
99 """YOU MUST OVERRIDE Driver.is_me.
101 RETURNS: Boolean (`True` or `False`)
103 This method is a heuristic that looks at the file content and
104 decides if the file can be opened by the driver itself. It
105 returns `True` if the file opened can be interpreted by the
106 current driver, `False` otherwise. Defining this method allows
107 Hooke to understand what kind of files we're looking at
110 if os.path.isdir(path):
114 header = f.readline() # we only need the first line
117 """Our "magic fingerprint" is the TUTORIAL_FILE header. Of
118 course, depending on the data file, you can have interesting
119 headers, or patterns, etc. that you can use to guess the data
120 format. What matters is successful recognition and the boolean
123 if header.startswith('TUTORIAL_FILE'):
127 def read(self, path, info=None):
128 f = open(path,'r') # open the file for reading
129 """In this case, we have a data format that is just a list of
130 ASCII values, so we can just divide that in rows, and generate
131 a list with each item being a row. Of course if your data
132 files are binary, or follow a different approach, do whatever
135 self.data = list(self.filedata)
136 f.close() # remember to close the file
139 info = {'filetype':'tutorial', 'experiment':experiment.Experiment()}