0.0.12 "Brodie"

This version of readgssi (called Brodie) adds bug fixes for #10 and #11 as well as the ability to ability to manually set samples per meter using the -d <float> parameter.

Version 0.0.12 "Brodie" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

changes since 0.0.11

• fixed bug that prevented reading NMEA RMC-only DZG files. now fully compatible with DZGs created with gpx2dzg
• added -d flag documentation to help text and readme
• updated docstring formatting
• added PyPI downloads badge
• added ability to manually set samples per meter using -d <float> flag
• added support and badge for travis-ci in anticipation of test suite
• -V or --version outputs version string
• fixed bug (#10) which read NMEA GGA strings incorrectly from DZGs that don't contain NMEA RMC
• fixed bug (#11) which prevented SIR-20 files with antenna code GSSI from being read correctly

Changes to previous versions can be found in the changelog.

0.0.11 "Everett"

This version of readgssi (called Everett) adds the ability to change the units of horizontal and vertical scale bars between scans/samples, time, and distance/depth. It builds on the ability of the previous version, called Prospect, to distance-normalize arrays, and continues to improve the header structure which powers much of the unit conversions. Everett also adds support for several antennas including synthetic files with antennas created in gprMax.

Version 0.0.11 "Everett" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

changes since 0.0.10

• addresses #7 to add support for DZT files created with gprMax
• added explicit support several antenna codes specific to SIR-3000 units and before
• added the ability to label radargram axes with distance and time units
• created readthedocs support files in anticipation of more full documentation and a future stable version release

Changes to previous versions can be found in the changelog.

0.0.10 "Prospect"

This version of readgssi adds the ability to distance-normalize a radar profile using NMEA strings in a DZG file, as well as the ability to export to .npy and export header values to .json. This update also allows GPR profiles to be read backwards, handles unknown antenna frequencies better, and fixes some bugs from previous versions.

Version 0.0.10 "Prospect" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

changes since 0.0.9

• a patch was added that includes several important bug fixes
  • added support for the 400MHz antenna type
  • fixed a bug that affected the stacking routine
  • fixed a bug with the time zero variable not being available when implementing the naming scheme
• fixed a bug with plotting that resulted from a key error in the header variable
• moved dzt reading-related functions to dzt.py
• changed tab spacing aesthetics in two plotting routines
• fixed a bug that caused errors reading multi-channel files
• script has more degrees of freedom while handling unknown antenna types
  • script should handle unknown antennas gracefully
  • script will try to extract frequency information from antenna name (harder than it sounds given GSSI naming inconsistency)
• added ability to reverse radargram (i.e. flip horizontal left to right)
• fixed bug with command line autostack
• changed command line verbose messages
• added ability to distance-normalize profile using GPS records
  • currently can read .DZG GPS records only, but plan to add ability to read .csv (lat, long, time) and NMEA GGA/RMC textfiles
• changed naming scheme to be "more readable"
  • changed filename differentiator from frequency to channel number (makes sense because theoretically, a user can have the same frequency antenna on two different channels, which would result in a naming conflict)
• fixed a bug in normalization caused by an errant format string
• stacking algorithm now uses reduce function to create copy array
• normalization will now automatically set traces per meter value of header['rhf_spm']
• added export numpy binary file (.npy)
• added header export to json
• added export to gprpy (.npy & .json) per this discussion

0.0.9-3 "Equinox"

This version of readgssi adds the ability to distance-normalize a radar profile using NMEA strings in a DZG file, as well as the ability to read profiles backwards (i.e. flip horizontally). This update also improves the naming scheme. Additionally, this version adds bug fixes for the autostacking function and clarity improvements to the help text.

Version 0.0.9 "Equinox" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

changes since 0.0.9

• a patch was added that includes several important bug fixes
  • added support for the 400MHz antenna type
  • fixed a bug that affected the stacking routine
  • fixed a bug with the time zero variable not being available when implementing the naming scheme
• fixed a bug with plotting that resulted from a key error in the header variable
• moved dzt reading-related functions to dzt.py
• changed tab spacing aesthetics in two plotting routines
• fixed a bug that caused errors reading multi-channel files
• script has more degrees of freedom while handling unknown antenna types
  • script should handle unknown antennas gracefully
  • script will try to extract frequency information from antenna name (harder than it sounds given GSSI naming inconsistency)
• added ability to reverse radargram (i.e. flip horizontal left to right)
• fixed bug with command line autostack
• changed command line verbose messages
• added ability to distance-normalize profile using GPS records
  • currently can read .DZG GPS records only, but plan to add ability to read .csv (lat, long, time) and NMEA GGA/RMC textfiles
• changed naming scheme to be "more readable"
  • changed filename differentiator from frequency to channel number (makes sense because theoretically, a user can have the same frequency antenna on two different channels, which would result in a naming conflict)

0.0.9-2 "Equinox"

This version of readgssi further breaks out component functions to their respective modules, and adds significant script flow improvements. This fixed a longstanding bug that prevented channel-specific CSV files from exporting correctly. This update also makes significant, useful improvements to the histogram, which is now called independently of other plot functions. The new script structure is a significant step towards being able to host a GUI-based layer picking function.

Version 0.0.9 "Equinox" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

changes since 0.0.9

• a patch was added that includes several important bug fixes
  • added support for the 400MHz antenna type
  • fixed a bug that affected the stacking routine
  • fixed a bug with the time zero variable not being available when implementing the naming scheme
• fixed a bug with plotting that resulted from a key error in the header variable
• moved dzt reading-related functions to dzt.py
• changed tab spacing aesthetics in two plotting routines

0.0.9-1 "Equinox"

This version of readgssi further breaks out component functions to their respective modules, and adds significant script flow improvements. This fixed a longstanding bug that prevented channel-specific CSV files from exporting correctly. This update also makes significant, useful improvements to the histogram, which is now called independently of other plot functions. The new script structure is a significant step towards being able to host a GUI-based layer picking function.

Version 0.0.9 "Equinox" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

0.0.9-1

• a patch was added that includes several important bug fixes

changes since 0.0.8

• moved plotting routines to new module plot.py
• moved translations to new module translate.py
• moved gps reading to new module gps.py
• moved geophysical and GSSI constants to new module constants.py
• moved stacking algorithm to filtering.py
• significantly improved layout of main processing function readgssi.readgssi()
  • script flow is so much more natural now
  • made way for future additions like interactive picking
• csv output improvements
  • added the ability to filter prior to csv export (duh?)
  • added the ability to export multiple csv files when more than one radar channel is present
• improved histogram plotting
• improved array handling when passing to functions
• changed the way files are named if no output file is passed (the Seth Campbell Honorary Naming Scheme)

0.0.9 "Equinox"

This version of readgssi further breaks out component functions to their respective modules, and adds significant script flow improvements. This fixed a longstanding bug that prevented channel-specific CSV files from exporting correctly. This update also makes significant, useful improvements to the histogram, which is now called independently of other plot functions. The new script structure is a significant step towards being able to host a GUI-based layer picking function.

Version 0.0.9 "Equinox" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

0.0.9-1

• a patch was added that includes several important bug fixes

changes since 0.0.8

• moved plotting routines to new module plot.py
• moved translations to new module translate.py
• moved gps reading to new module gps.py
• moved geophysical and GSSI constants to new module constants.py
• moved stacking algorithm to filtering.py
• significantly improved layout of main processing function readgssi.readgssi()
  • script flow is so much more natural now
  • made way for future additions like interactive picking
• csv output improvements
  • added the ability to filter prior to csv export (duh?)
  • added the ability to export multiple csv files when more than one radar channel is present
• improved histogram plotting
• improved array handling when passing to functions
• changed the way files are named if no output file is passed (the Seth Campbell Honorary Naming Scheme)

0.0.8 "Berlin"

This version of readgssi adds the ability to properly read date and timestamps from DZT files, further breaks routines out into standalone modules, and increases the usefulness of output regarding both the process of reading files and the process of reading radar files.

Version 0.0.8 "Berlin" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

changes since 0.0.7

• moved filtering routines to new module filtering.py
• added a way to call readgssi.__version__
• moved some config stuff to config.py
• bitwise datetime read works properly now!! this was a longstanding bug that took me forever to figure out. the bit structure was not at all intuitive and the script kind of ends up using brute force to decode them to datetime objects, but it works. dates and times of file creation and modification should now match those in RADAN.
• changed to verbose by default and quiet if -q / --quiet flag is set
• changed print statement to output date and timestamp (helpful for tracking date and time of things when, for example, processing a whole survey data folder full of radar files)

0.0.7 "Greylock"

changes since 0.0.6

• added ability to install via PyPI using anaconda dependencies
  • setuptools integrated command line script creation (i.e. readgssi instead of python readgssi.py)
• broke out several routines into individual functions

Fitch

0.0.6-1 "Fitch"

This is the first major non-beta version.

changes since 0.0.5

• now define time zero point manually (time zero is the moment when the direct wave begins to pass the receiver. previously, i used an unreliable calculation using header values to determine the time zero point)
  • in the future, i will add a signal processing algorithm to detect the time zero point automatically
• added bandpass filter (requires obspy)
• significantly optimized background removal and dewow algorithms
• added example code and plots
• fixed a bug that caused both plots of dual-channel radar files to be written out to one file
• fixed a bug that caused manually-created output file names to be ignored when plotting
• added basic background removal and dewow capability (#5 from @fxsimon)
• added support for the D50800/D50300 antenna
  • added plotting support for dual-channel radar devices
  • merged #3 from @fxsimon which fixed a bug that caused multi-channel file traces to be read in a 121212 sequence instead of 111222
• updated the workings of the plotting algorithm's colormap
• changed the way files are saved (bug in 0.0.5 mangled some filenames)
• added the ability to specify colormap and whether to draw a colorbar and a histogram
• added an automatic figsize option (leaves figsize up to Matplotlib)
• added ability to apply gain
• fixed bug that caused gain to be applied incorrectly
• script now tries to automatically calculate timezero using (nsamp*range)/position

known bugs:

• translation to anything but csv is broken (hope to have time to at least fix HDF5 output soon)
  • csv translation does not work for dual-channel radar devices (exports to file but channels are merged end-to-end)
• color bar shows up too large on some plots (no known fix yet)
• dewow doesn't work on all files
• histogram only shows pre-gain data distribution