0.0.21 "Stony Ledge"

This version of readgssi (called Stony Ledge) adds a bug fix and a minor new feature.

Version 0.0.21 "Stony Ledge" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts (US) area.

changes since 0.0.20

• changed file naming convention (outfile parameter is no longer clobbered by the naming function)
• changed main python function to accept user-specified velocity threshold for pause correction function call

0.0.20 "Monroe"

This version of readgssi (called Monroe) adds bug fixes and support for several antennas.

Version 0.0.20 "Monroe" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts (US) area.

changes since 0.0.19

• added support for the "42000S" antenna name (#34 from @GGDRriedel)
• added support for the "1.5/1.6GHz" antenna name (#39)
• corrected a misuse of a great circle distance calculation using geopy (#38 from @felippehsk)
• allow for graceful handling of empty GGA strings (#38 from @felippehsk)
• added support for the "4105NR" antenna name (#21 from @eyoabz)
• added limited support for the "300/800D" antenna name (#33 from @alecomunian). GSSI bug prevents this combination of antennas from full support, as the second antenna is named 'none' in this case, but all readgssi functionality should still work
• fixed a previously unknown bug that did not separate multi-channel outputs into separate files (addresses #33 from @alecomunian and #37 from @h2maa)
• changed license from AGPLv3 to GPLv3 as standard GPLv3 fits the purpose better

Major Contributions

• #38 by @felippehsk in #40
• Added 42000S to constants by @GGDRriedel in #34

New Contributors

• @felippehsk made their first contribution in #40
• @GGDRriedel made their first contribution in #34

Full Changelog: 0.0.19...0.0.20

0.0.19 "Taconic"

This version of readgssi (called Taconic) adds the ability to output to any supported matplotlib format, small bug fixes, and documentation updates.

Version 0.0.19 "Taconic" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts (US) area.

changes since 0.0.18

• fixed a problem that led to errors creating a conda skeleton
• explicitly specify base e (numpy.e) in SymLogNorm call in readgssi:plot.radargram
• added the ability to output to any supported matplotlib format
• fixed docs/make_plots.sh and branched a docs/make_readme_plots.sh for README figure creation
• corrected docs text and docs/_static images that incorrectly applied FIR and BGR (or didn't apply them at all)
• added an example plot demonstrating the absolute value of gradient (-A -c gray_r) method

0.0.18.post1 "Jiminy"

This is an intermediate version of 0.0.18 meant to correct errors with the creation of a conda skeleton. It is functionally the same as version 0.0.18.

---

This version of readgssi (called Stratton) adds the ability to output DZT files, small bug fixes, and documentation updates. It also now supports installation via anaconda.

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

changes since 0.0.17

• fixed the read of the byte that contains rh_system and rh_version in the header (#26)
• fixed sampling depth interpretation (#28)
• added DZT file output (#29)
• added documentation for displaying absolute value of down-trace gradient in plots
• fixed a bug that incorrectly displayed long axis units on stacked arrays
• added conda installation method and streamlined installation documentation
• switched version handling to file (_version.py)
• fixed a bug that did not handle rhf_depth == 0 cases correctly
• added support for the 3102 antenna (500 MHz)
• fixed a bug that incorrectly plotted TWTT
• updated examples in Readme and fixed the autogen script (make_plots.sh)
• corrected an error with how setup.py got the version number, which prevented the creation of a conda skeleton

0.0.18 "Jiminy"

This version of readgssi (called Jiminy) adds the ability to output DZT files, small bug fixes, and documentation updates. It also now supports installation via anaconda.

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

changes since 0.0.17

• fixed the read of the byte that contains rh_system and rh_version in the header (#26)
• fixed sampling depth interpretation (#28)
• added DZT file output (#29)
• added documentation for displaying absolute value of down-trace gradient in plots
• fixed a bug that incorrectly displayed long axis units on stacked arrays
• added conda installation method and streamlined installation documentation
• switched version handling to file (_version.py)
• fixed a bug that did not handle rhf_depth == 0 cases correctly
• added support for the 3102 antenna (500 MHz)
• fixed a bug that incorrectly plotted TWTT
• updated examples in Readme and fixed the autogen script (make_plots.sh)

0.0.17 "Bromley"

This version of readgssi (called Bromley) adds several major features and bug fixes. The most significant of these are support for the StructureScan XT, improved handling of multiple antenna frequencies, improved faint layer plotting (tested on cold-based blue ice data), improved handling of GSSI's pauses (which misalign GPS epochs and radar trace numbers after a user-initiated pause), and the ability to add vertical user marks to plot output.

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

changes since 0.0.16

• merged #19 from teshaw which allows the user to specify partial read parameters for DZT files
• reintroduced a testing feature which creates CSV files from DZG records, in order to easily import location information to GIS
• added support for the StructureScan Mini XT which suffered from the unfortunate fate of having an antenna named 'none'
• improved handling of multiple user-specified frequencies
• adding the ability to plot the absolute value of the down-trace gradient, which can increase faint layer visibility at the cost of wave front resolution
• now use rf_top to correct depths, a major bug in previous versions
• limited distance normalization console output to one message every ten chunks (in the future, this will be controlled with a \r statement)
• added pause correction function to fix DZG/DZT trace number offset when collection is paused and GPS is active
• added ability to plot user marks as vertical lines (similar to the output on the controller itself)
• corrected module call documentation for plotting (#23)

0.0.16 "Pine Cobble"

This version of readgssi (called Pine Cobble) fixes the colormap which previously reversed polarity (issue #18), as well as command line control of DPI, fixes the sampling frequency calculations using epsr (epsilon sub r or relative permittivity) for user-specified epsr, and other small fixes. Significantly, this version adds full documentation, hosted at https://readgssi.readthedocs.org/ (issue #9).

Version 0.0.16 "Pine Cobble" continues the naming scheme based on names of mountain peaks in the Williamstown, Massachusetts area.

changes since 0.0.15

• fixed #14 which incorrectly asserted that user-set samples per meter was negative when it was not (sign was flipped) but processed the file correctly regardless
• moved zoom calculation and automatic file naming to their own functions
• added sphinx autodoc descriptions to some functions, in order to work towards solving #9
• added comments to datetime parsing function
• fixed sampling frequency calculations to the value of epsr set in the header, which will prevent perceived frequency wander in frequency-based filters if the user sets epsr
• changed the behavior of the readdzt script to automatically search for a DZG file of the same name, and load that data if possible. this should allow python users to read all three variables (header, arrays, gps) if GPS exists.
• fixed command line control of DPI
• switched to "gray" colormap from "Greys". "Greys" rendered opposite polarity #18

0.0.15 "October"

This version of readgssi (called October) adds many improvements and bug fixes. This release adds support for the 5103 and 350HS antennas, fixes several bugs, outputs better figures, and contains improves horizontal and vertical filtering routines. Added the ability to timezero differently for multi-channel files. Figure changes include: 300 dpi (instead of 150), programmable zoom with the -e x1,x2,z2,z1 flag, a tight bounding box for figure exports, and a patch that calculates two-way time properly.

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

changes since 0.0.14

• added support for the 5103 400 MHz antenna, and an antenna called CUSTOM in the header, for which center frequency is not known but is likely adjustable
• added support for the 350 HS hyperstacking antenna
• fixed a bug that created an extra matplotlib axis
• added rounding to epsilon_r value on y-axis depth-type display
• added a patch for #12 to improve axis sizing and tight_layout() handling
• changed background removal (BGR) function to operate similar to RADAN boxcar function
  • this change means that you can no longer simply specify -r for full-width background removal. new nomenclature for full-width BGR flag is -r 0. -r 100 will apply a 100-trace rolling boxcar BGR (after normalization and stacking)
  • this is done with the scipy.ndimage.filters.uniform_filter1d() function and means that scipy is now explicitly required
  • function will automatically filter out low-frequency washout noise caused by bgr, using obspy's implementation of scipy's butterworth bandpass from 0.1*f to 10*f, where f is antenna frequency. nyquist is automatically accounted for by obspy.
  • BGR value is displayed in title if set > 0, or as "full" if BGR is full-width (i.e. -r 0)
• added zerophase vertical triangular FIR filter, and changed default filter from butterworth to triangular to attempt to match that in RADAN. butterworth is no longer used (but kept for posterity).
  • this function uses the scipy.signal.firwin() filter design and scipy.signal.lfilter() implementation
• added ability to suppress plot title using -T or --titleoff from the command line or title=False in main python function
• changed ns_per_zsample in header to read data shape from header rather than array size
• added a bug fix for filtering that caused the sample rate to be set too high
• significantly improved triangular bandpass filter, so that it nearly matches RADAN
• when Z axis value is set to "samples", the zeroed samples are taken into account. so, if the array had 150 samples sliced off, the plot axis will now start at 150 instead of 0
• added per-channel handling of timezero. you can pass a list with -Z 233,150,92 (or zero=[233,150,92,None] in python). defaults to -Z 2 (zero=[2,None,None,None])
• added programmable zoom with -e left,right,up,down flag and list
• cleaned up some dangling floats
• updated help text and README help text
• added automatic tight bbox axes for savefig
• changed from 150 to 300 dpi for easier poster printing measurements
• fixed calculation for two-way time (previously per #17, calculation erroneously displayed one-way time)

Changes to previous versions can be found in the changelog.

0.0.14 "Ragged"

This version of readgssi (called Ragged) adds a bug fix for #16 (distance normalization incorrectly applied) and updates to README examples.

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

changes since 0.0.13

• updated examples in README
• fixed #16 which incorrectly applied GPS array values for normalization

Changes to previous versions can be found in the changelog.

0.0.13 "Monument"

This version of readgssi (called Monument) adds bug fixes for #13 (adds support for the StructureScan Mini antenna) and #15 (distance normalization is now broken into chunks to save memory) as well as a bug fix with a pandas iat call when reading DZG files with NMEA sentences in a particular order.

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

changes since 0.0.12

• fixed #13 by adding SS MINI to list of recognized antenna codes
• fixed bug (#15) which caused runaway memory usage when distance-normalizing large files. files are now distance normalized in chunks.
• fixed a bug that caused a read failure on DZG files with RMC strings before GGA (iat function didn't like my slicing)

Changes to previous versions can be found in the changelog.