Skip to content

Commit

Permalink
update release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jpjones76 committed Aug 27, 2020
1 parent e61d19c commit 5b719eb
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
39 changes: 20 additions & 19 deletions docs/ReleaseNotes/release_1.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ SeisIO v1.1.0 adds submodule `SeisIO.Nodal` for nodal data, plus initial support
## **SAC**
* SAC data files no longer track the LOC field of `:id`; thus, IDs `NN.SSSSS.LL.CCC` and `NN.SSSSS..CCC` will be written and read identically to/from SAC.
+ This change realigns SeisIO SAC handling with the [official format spec](http://ds.iris.edu/files/sac-manual/manual/file_format.html).
+ *Explanation*: Some data sources store the LOC field of `:id` in KHOLE (byte offset 464). We followed this convention through SeisIO v1.0.0. However, KHOLE is an event property, not a station property.
+ *Explanation*: Some data sources store the LOC field of `:id` in KHOLE (byte offset 464). We followed this convention through SeisIO v1.0.0. However, KHOLE is usually an event property.

## **SeedLink**
Functions *seedlink* and *seedlink!* now accept keyword *seq="* for starting sequence number, consistent with [SeisComp3 protocols](https://www.seiscomp3.org/doc/seattle/2012.279/apps/seedlink.html).
Functions *seedlink* and *seedlink!* now accept keyword *seq=* for starting sequence number, consistent with [SeisComp3 protocols](https://www.seiscomp3.org/doc/seattle/2012.279/apps/seedlink.html).

## **SEG Y**
A minor change to SEGY file support could break user work flows that depend on
Expand Down Expand Up @@ -57,22 +57,6 @@ Added SeisIO.Nodal for reading data files from nodal arrays
* ASDF groups and datasets are now always closed after reading with *read_hdf5*.
* In Julia v1.5+, calling `sizeof(R)` on an empty `MultiStageResp` object should no longer error.

## GitHub Issues Fixed
* #31 : *sync!* has been rewritten and optimized.
* #39 : tutorial updated.
* #42 : mini-SEED calibration blockettes parse correctly again.
* #43 : reading Steim-compressed mini-SEED into an existing channel with an empty Float64 data vector should no longer error.
+ `get_data` should no longer error when the first part of a segmented request includes no data from some channels.
* #48 : mini-SEED Blockette 100 should now be handled as in the IRIS mini-SEED C library.
* #49 : the read speed issue in HDF5.jl has been resolved.
* #50 : `resample!` now consistently allows upsampling.
* #51 : `resample!` now correctly updates `:t` of a gapless SeisChannel.
+ The new `resample!` consumes slightly more memory than the previous incarnation, but behavior should be nearly identical.
* #54 : `SeisIO.dtr!` now accepts `::AbstractArray{T,1}` in first positional argument
* #55 : added `read_nodal("segy")`
* #56 : implemented as part of initial SeisIO.Nodal release
* #57 : fixed by addition of KW `read_data("segy", ..., ll=U)`

## **SeisIO Test Scripts**
Fixed some rare bugs that could break automated tests.
* *test/TestHelpers/check_get_data.jl*: now uses a *try-catch* loop for *FDSNWS station* requests
Expand Down Expand Up @@ -126,4 +110,21 @@ Fixed some rare bugs that could break automated tests.
- *?get_pha!* once again describes the correct function
* Updated and expanded the Jupyter tutorial
* Updated and expanded the time API
* GitHub issues addressed by documentation fixes: #39, #44, #45

# **Index**: GitHub Issues Fixed
* #31 : *sync!* rewritten.
* #39 : tutorial updated.
* #42 : mini-SEED calibration blockettes of this type parse correctly again.
* #43 : reading Steim-compressed mini-SEED into an existing channel with an empty Float64 data vector should no longer error. `get_data` should no longer error when the first part of a segmented request includes no data from some channels.
* #44 : documentation updated.
* #45 : documentation updated.
* #48 : mini-SEED Blockette 100 handling should now match the IRIS mini-SEED C library.
* #49 : the read speed slowdown in HDF5.jl was fixed; SeisIO no longer requires HDF5 v0.12.3.
* #50 : `resample!` now consistently allows upsampling.
* #51 : `resample!` now correctly updates `:t` of a gapless SeisChannel.
* #54 : `SeisIO.dtr!` now accepts `::AbstractArray{T,1}` in first positional argument
* #55 : added `read_nodal("segy")`
* #56 : implemented as part of initial SeisIO.Nodal release
* #57 : fixed by addition of KW `ll=` to `read_data`

**Note**: This is a re-release of v1.1.0, originally released 2020-07-07, with updated content that we originally intended to name v1.2.0. Combining these into a re-release fixes an issue that prevented Julia from automatically registering the new version.
1 change: 0 additions & 1 deletion test/SampleFiles

This file was deleted.

2 comments on commit 5b719eb

@jpjones76
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/17624

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.1.0 -m "<description of version>" 5b719eb2987d3ef73bbd4a086e22a0eb64b47cc8
git push origin v1.1.0

Please sign in to comment.