This should be an overview of the project, what we are trying to do, and pointing people in the right direction for how to get started. Right now, it is just a few words.

Some branches that I don't think we are using anymore:

• libstructure_reset
• daniel
• dpolashenski-patch-1

Someone should double check that they are all good to be deleted and then delete from the remote repository.

Some of the dependencies that are currently listed might be unnecessary. We should double check all these and see if any of them can be removed. Once that is complete, and both the requirements.txt and setup.py files are updated accordingly, we should test the pip-installability of the library.

Lynn, Rodrigo, and Grace were contributing toward this during Hackweek. Ben moved one of their functions into a script at ./IS2_velocity/extract_alongtrack.py. This function will need some work to be incorporated into the current framework and tested.

This function seemed important, so Ben moved it to ./IS2_velocity/draft_functions.py to preserve it. Grace was the likely creator, so possibly she could pull what is useful from it and move it to a new script that is more easily identifiable?

We need to calculate uncertainties associated with our velocity estimate. This would be best done as a new function within the script ./IS2_velocity/correlation_processing.py either as a new function or added into the velocity function.

We talked about using the half-width of the correlation coefficient minimum as in Schroeder et al. (2016). This paper is about ice-penetrating radar attenuation, but I think the concept could apply for us as well.

We need to build out unit tests for:

• readers
• preprocessing
• velocity calculation
• other functionality as the library is expanded

For now, this work is being done on a branch called unit_testing

Add bandpass, lowpass, etc. filters to the filt function.

Please look into the setup.py and the existing files to help us dockerize this application to work instantly with jupyter notebooks.

Change 'velocity_old' to 'calculate_velocity_single_beam' and move that inside the loop.