https://github.com/kojix2/read_until
https://github.com/kojix2/read_until
adaptive-sampling crystal-lang minknow nanopore oxford-nanopore
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kojix2/read_until
- Owner: kojix2
- License: other
- Created: 2026-04-19T01:59:03.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-06-19T00:39:55.000Z (about 1 month ago)
- Last Synced: 2026-06-19T02:18:02.723Z (about 1 month ago)
- Topics: adaptive-sampling, crystal-lang, minknow, nanopore, oxford-nanopore
- Language: Crystal
- Homepage: https://kojix2.github.io/read_until/
- Size: 181 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# read_until.cr
[](https://github.com/kojix2/read_until/actions/workflows/test.yml)
[](https://tokei.kojix2.net/github/kojix2/read_until)
🕳️⚡ Oxford Nanopore [Read Until](https://github.com/nanoporetech/read_until_api) - for [Crystal](https://crystal-lang.org/)
## Installation
Add the dependency to your shard.yml:
```yaml
dependencies:
read_until:
github: kojix2/read_until
```
Run `shards install`
## Usage
```crystal
require "read_until"
```
Run example:
```sh
crystal run examples/basic.cr
```
Minimal streaming shape:
```crystal
client = ReadUntil::Client.new(connection)
client.open(
channels: 1..512,
mode: ReadUntil::StreamMode::OneChunk,
prefilter: ReadUntil::Prefilter.strand_like(:strand, :adapter),
) do |session|
session.each_read(batch_size: 16) do |read|
signal = read.signal(Int16)
if reject?(signal)
session.unblock(read, for: 100.milliseconds)
end
end
end
```
## Development
- Your contributions and feedback are welcome
- This library was generated by an AI agent based on human instructions.
## License
This project is distributed under the Mozilla Public License 2.0 (MPL-2.0).
It includes a Crystal port of Oxford Nanopore's Python `read_until_api` and
inherits the upstream license requirements for derived source files.
- Project license: [LICENSE](LICENSE)
- Upstream project: https://github.com/nanoporetech/read_until_api
- Upstream license text: https://github.com/nanoporetech/read_until_api/blob/release/LICENSE.md