Index: trunk/adcp/CREDITS.txt =================================================================== --- (revision ) +++ trunk/adcp/CREDITS.txt (revision 4) @@ -1,0 +1,4 @@ +Gregory P Dusek - original prototype +Sara M Haines - project management +Chris Calloway (cbcunc) - testing, release management +Harvey E Seim - chief science officer Index: trunk/adcp/HISTORY.txt =================================================================== --- (revision ) +++ trunk/adcp/HISTORY.txt (revision 4) @@ -1,0 +1,3 @@ +adcp 0.9 - code cleanup, version controlled, unreleased January 2007 + +splitter 0.1 - original prototype, unreleased, December 2006 Index: trunk/adcp/LICENSE.GPL =================================================================== --- (revision ) +++ trunk/adcp/LICENSE.GPL (revision 4) @@ -1,0 +1,280 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS Index: trunk/adcp/LICENSE.txt =================================================================== --- (revision ) +++ trunk/adcp/LICENSE.txt (revision 4) @@ -1,0 +1,14 @@ +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, +MA 02111-1307 USA. Index: trunk/adcp/TODO.txt =================================================================== --- (revision ) +++ trunk/adcp/TODO.txt (revision 4) @@ -1,0 +1,1 @@ +- refactor into PD0 class with methods like waves, currents, split, etc. Index: trunk/adcp/VERSION.txt =================================================================== --- (revision ) +++ trunk/adcp/VERSION.txt (revision 4) @@ -1,0 +1,1 @@ +0.9 Index: trunk/adcp/__init__.py =================================================================== --- (revision ) +++ trunk/adcp/__init__.py (revision 4) @@ -1,0 +1,6 @@ +""" +Modules for ADCP data + +adcp.pd0 - functions to handle PD0 files +""" +__all__ = ['pd0'] Index: trunk/adcp/pd0.py =================================================================== --- (revision ) +++ trunk/adcp/pd0.py (revision 4) @@ -1,0 +1,242 @@ +#!/usr/bin/python +"""Functions to handle Acoustic Doppler Current Profiler data. + +As a script (to split a raw PD0 file into waves and currents): + +python pd0.py [path] rawFile wavesFile currentsFile +python pd0.py [-p path] -r rawFile -w wavesFile -c currentsFile +python pd0.py [--path=path] \\ + --raw=rawFile \\ + --waves=wavesFile \\ + --currents=currentsFile + +where: + path is a path to prepend to the following + rawFile is path of raw PD0 format input file + wavesFile is path of waves PD0 format output file + currentsFile is path of currents PD0 format output file + +or (to run the test suite): + +python pd0.py -t +python pd0.py --test + +or (to see this help message): + +python pd0.py -h +python pd0.py --help + +As a module: + +import adcp.pd0 +adcp.pd0.split(rawFile,wavesFile,currentsFile) + +where: + rawFile is a file object representing the raw PD0 format input + wavesFile is a file object representing the waves PD0 format output + currentsFile is a file object representing the currents PD0 format output +""" + +import struct + +# +# The rawfile is assumed to be in PD0 format. +# +# PD0 format assumes the file is a succession of ensembles. +# +# Each ensemble starts with a two byte header identifying the type of data +# contained in the ensemble. +# +# Following the header is a two byte length field specifying the length of +# the header, length field, and data combined +# +# Following the length field is raw data for the number of bytes indicated by +# the length field +# +# Following the raw data is a checksum field which is the two least +# significant bytes of the sum of the byte values of the header, length field, +# and raw data. +# +def split(rawFile,wavesFile,currentsFile): + """Split PD0 format data into seperate waves and currents + + split()rawFile,wavesFile,currentsFile -> None + """ + + # header IDs + wavesId=0x797f + currentsId=0x7f7f + + # convenience function reused for header, length, and checksum + def __nextLittleEndianUnsignedShort(file): + """Get next little endian unsigned short from file""" + raw = file.read(2) + return (raw, struct.unpack('= 0,(firstWaves,firstCurrents))) + + #seeks to the first occurence of a waves or currents data + rawFile.seek(firstEnsemble) + + # loop through raw data + rawHeader, header = __nextLittleEndianUnsignedShort(rawFile) + + while (header == wavesId) or (header == currentsId): + # get ensemble length + rawLength, length = __nextLittleEndianUnsignedShort(rawFile) + # read up to the checksum + rawEnsemble = rawFile.read(length-4) + # get checksum + rawChecksum, checksum = __nextLittleEndianUnsignedShort(rawFile) + + computedChecksum = __computeChecksum(rawHeader, rawLength, rawEnsemble) + + if checksum != computedChecksum: + raise IOError, "Checksum error" + + # append to output stream + if header == wavesId: + wavesFile.write(rawHeader) + wavesFile.write(rawLength) + wavesFile.write(rawEnsemble) + wavesFile.write(rawChecksum) + elif header == currentsId: + currentsFile.write(rawHeader) + currentsFile.write(rawLength) + currentsFile.write(rawEnsemble) + currentsFile.write(rawChecksum) + + try: + rawHeader, header = __nextLittleEndianUnsignedShort(rawFile) + except struct.error: + break + + +def test(): + """Execute test suite""" + try: + import adcp.tests.runalltests as runalltests + except: + # possible if executed as script + import sys,os + sys.path.append(os.path.join(os.path.dirname(__file__),'tests')) + import runalltests + runalltests.runalltests(subset='pd0') + +class __TestException(Exception): + """Flow control for running as script""" + pass + +# wrapper function +def __test(): + """Execute test suite from command line""" + test() + raise __TestException, 'Wrapper function for command line testing only' + +def __main(): + """Process as script from command line""" + import getopt,os,sys + + # get the command line options and arguments + path = '' + rawName,wavesName,currentsName = 3*[None] + + try: + opts, args = getopt.gnu_getopt(sys.argv[1:], + 'htp:r:w:c:', + ['help', + 'test', + 'path=', + 'raw=', + 'waves=', + 'currents=']) + for opt,arg in opts: + if opt in ['-h','--help']: + raise getopt.GetoptError,'' + if opt in ['-t','--test']: + __test() + elif opt in ['-p','--path']: + path = arg + elif opt in ['-r','--raw']: + rawName = arg + elif opt in ['-w','--waves']: + wavesName = arg + elif opt in ['-c','--currents']: + currentsName = arg + else: + raise getopt.GetoptError,'' + if (rawName is None) or \ + (wavesName is None) or \ + (currentsName is None): + if len(args) not in [3, 4]: + raise getopt.GetoptError,'' + else: + if (rawName is not None) or \ + (wavesName is not None) or \ + (currentsName is not None): + raise getopt.GetoptError,'' + else: + if len(args) == 4: + path = args[0] + del args[0] + rawName = args[0] + wavesName = args[1] + currentsName = args[2] + elif len(args) != 0: + raise getopt.GetoptError,'' + except getopt.GetoptError: + print __doc__ + return + except __TestException: + return + + # split a raw PD0 file + rawName = os.path.join(path, rawName) + print 'Raw file path:', rawName + wavesName = os.path.join(path, wavesName) + print 'Waves file path:', wavesName + currentsName = os.path.join(path, currentsName) + print 'Currents file path:', currentsName + rawFile = open(rawName, 'rb') + try: + wavesFile = open(wavesName, 'wb') + try: + currentsFile = open(currentsName, 'wb') + try: + split(rawFile, wavesFile, currentsFile) + finally: + currentsFile.close() + finally: + wavesFile.close() + finally: + rawFile.close() + +if __name__ == "__main__": + __main() + Index: trunk/adcp/tests/__init__.py =================================================================== --- (revision ) +++ trunk/adcp/tests/__init__.py (revision 4) @@ -1,0 +1,3 @@ +""" +Unit test package for adcp package +""" Index: trunk/adcp/tests/runalltests.py =================================================================== --- (revision ) +++ trunk/adcp/tests/runalltests.py (revision 4) @@ -1,0 +1,16 @@ +import unittest,os,sys + +def runalltests(subset=''): + sys.path.append(os.path.dirname(__file__)) + testlist = os.listdir(os.path.dirname(__file__)) + tests = [test[:-3] for test in testlist if test.startswith('test'+subset) and test.endswith('.py')] + suite = unittest.TestSuite() + for test in tests: + testmod = __import__(test) + if hasattr(testmod, 'test_suite'): + suite.addTest(testmod.test_suite()) + TestRunner = unittest.TextTestRunner + TestRunner().run(suite) + +if __name__ == '__main__': + runalltests() Index: trunk/adcp/tests/testpd0split.py =================================================================== --- (revision ) +++ trunk/adcp/tests/testpd0split.py (revision 4) @@ -1,0 +1,61 @@ +import unittest + +class TestPd0Split(unittest.TestCase): + + def setUp(self): + import os + self.dataPath = os.path.join(os.path.dirname(__file__),'data') + try: + import adcp.pd0 as pd0 + self.pd0 = pd0 + except: + # possible if executed as script + import sys,os + sys.path.append(os.path.split(os.path.dirname(__file__))[0]) + import pd0 + self.pd0 = pd0 + + def testSimpleSplit(self): + import os,StringIO + wavesFile = StringIO.StringIO() + currentsFile = StringIO.StringIO() + rawFile = open(os.path.join(self.dataPath, + 'pd0Raw.in'), + 'rb') + try: + wavesTruthFile = open(os.path.join(self.dataPath, + 'pd0Waves.out'), + 'rb') + wavesTruthData = wavesTruthFile.read() + try: + currentsTruthFile = open(os.path.join(self.dataPath, + 'pd0Currents.out'), + 'rb') + currentsTruthData = currentsTruthFile.read() + try: + self.pd0.split(rawFile, wavesFile, currentsFile) + finally: + currentsTruthFile.close() + finally: + wavesTruthFile.close() + finally: + rawFile.close() + wavesData = wavesFile.getvalue() + currentsData = currentsFile.getvalue() + wavesFile.close() + currentsFile.close() + self.assertEqual(wavesData, + wavesTruthData, + 'Waves data is not truthed in raw PD0 split') + self.assertEqual(currentsData, + currentsTruthData, + 'Currents data is not truthed in raw PD0 split') + +def test_suite(): + suite = unittest.TestSuite() + suite.addTest(unittest.makeSuite(TestPd0Split)) + return suite + +if __name__ == '__main__': + TestRunner = unittest.TextTestRunner + TestRunner().run(test_suite())