v3.0.0

We are pleased to announce an update to the Read Until API (v3.0). This update is available via our Github repo (https://github.com/nanoporetech/read_until_api ) and includes the following updates:

• Update of the API to be more easily used alongside the 20.06 release of MinKNOW
• Examples of using Guppy to call and Align Reads
• Improvement to the internal structure of the read until client to improve read until responses (in collaboration with Matt Loose and Alex Payne https://github.com/LooseLab/read_until_api_v2/blob/master/read_until_api_v2/read_cache.py)

v2.1.0

Bug fix and use-ability release

• Added a step-by-step install guide (contributed by @danarte).
• Make the client's .run() method non-blocking (and add a .reset() method); the client no longer needs to be given a run time upfront.
• Handle termination of the client gracefully.
• Allow the application time of the unblock voltage to be configured (per unblock).
• Add additional debugging and statistics to the basecall/alignment example.

A remaining issue of which we are aware is that the minimum chunk size functionality can cause errors in the gRPC stream when MinKNOW encounters chunks smaller than the requested minimum size. For this reason, the functionality has been disabled. Users should be aware that the read chunk size sent to the Read Until client is determined by the read detection settings internal to MinKNOW; chunks are typically around 1 second.

v2.0.0

Revamped Read Until Client for new gRPC (raw-data) interface

• Uses new gRPC interface to MinKNOW
• Client receives raw signal chunks, rather than events
• Elect not to receive further data from "good" reads, as well as unblock "bad" reads
• Handle queuing of read chunks, and expiration of old chunks
• Batteries included examples using basecalling and alignment to identify and reject reads