Commit 4ad25675 authored by Brad Covey's avatar Brad Covey

Added more usage documentation

parent ac16f976
# Requirements
* Python 2.7
# Installation & Command Line Usage
# Installation
1. Click "Download zip" on the GitLab page
2. Extract the archive somewhere, make note of the path to the files
3. Call the script by entering the following into the command line on your operating system(Called terminal on mac and linux, cmd on windows):
# Command Line Usage
## For a directory of files:
Call the script by entering the following into the command line on your operating system(Called terminal on mac and linux, cmd on windows):
`python 853toCSV.py raw_directory output_directory`
The path to the output directory can be appended with a partial filename which will be
included in the generated filenames. Example:
/path/to/output/directory/fname-part
output files:
* /path/to/output/directory/fname-part_header.csv
* /path/to/output/directory/fname-part_data.csv
sample usage:
`python 853toCSV.py /Users/brad/Documents/slocum_glider/slocum_data/echosounder/raw /Users/brad/Documents/slocum_glider/slocum_data/echosounder/out`
## For individual files:
Call the script by entering the following into the command line on your operating system(Called terminal on mac and linux, cmd on windows):
`python /path/to/files/imagenex853DataParser.py /path/to/853/file.853`
Note: if you have multiple versions of python installed python 2.7 can be called like this:
Note: if you have multiple versions of python installed python 2.7 can be called like this:
`python2 /path/to/files/imagenex853DataParser.py /path/to/853/file.853`
# Sample API usage:
......@@ -51,4 +65,4 @@ print header['pingNumber']
# The following line prints the diveType for the third ping:
print header['diveType'][3]
```
\ No newline at end of file
```
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment