search

CI-CMG / pyEcholab

pyEcholab is an open-source, Python-based toolkit for reading, processing, plotting and exporting fisheries acoustic echosounder data. The goal for this project is to become a community resource the grows through community involvement and contribution.
Other
37 stars 23 forks source link

Master branch status #31

Open Chuck-A opened 6 years ago

Chuck-A commented 6 years ago

This thread will be used to keep a running update of the master branch's status.

Chuck-A commented 6 years ago

As of this morning the file simple_ek_60_test.py works. I believe plot_single_ping.py also works but I have not tested it recently. I will test when I get to the office this morning and update this thread if there are issues with it. chuck_test.py is my version of simple_ek60_test.py. Only difference is I have copied over the optional arguments to the read_raw method so I can test calls with options set. The code is running against python 3.6 and 2.7.14. run_checks.py is Pamme code to test NMEA work under development and does not work. Also heave_compensation.py is new from Rick and has not yet been tested. again I will check it when I get to the office and update this thread.

We really need eyes on the EK60 class, base classes and methods to see if they make sense and work they way you all think they should. Please play around with simple_ek_60_test.py and give us feedback.

Lastly, let me know if you get this update. You should all receive an email but as originator, I do not.

Chuck-A commented 6 years ago

I have just merged in some bug fixes and Rick's latest code enhancements. All scripts in examples work except for chuck_test.py (my sandbox file) and run_checks.py (Pamme's sandbox). I've tested the code with both python 3.6.1. and 2.7.14.

There are several methods in the classes that are not tested by the example code so having people test other methods and give feedback on the existing API and processing is key. Go nuts. If you find a method that does not work properly, and the fix is not obvious and trivial, please open a issue in GitHub, label it appropriately (i.e.e bug, feature request, etc) and assign it to Rick and myself.

Have a great weekend!

Chuck-A commented 6 years ago

After a couple hours spent learning my way out of git merge hell, I've merged changes from my branch into master. New is the processing class AlignPing in processing/align_ping.py and a file to test it's functionality examples/align_ping_test.py The example references data in the NCEI_workflow/data/SH1507 directory. Those data files are on the project Google drive site

vmartinez-cu commented 6 years ago

Documentation for the classes and example scripts have been updated. This includes formatting comments according to the google style guide and adding doc strings to class methods. Some doc strings remain to be completed. Please remember to pull these changes when working on the code. Thanks!