Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 1.78 KB

README.md

File metadata and controls

62 lines (46 loc) · 1.78 KB

STAMP.jl

Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Latest Release MIT license Unit tests codecov

This project follows the semver pro forma and uses the git-flow branching model.

Description

Initially written to load GEM's default PFM output.

Inspired by FASTX.jl.

Installation

Install STAMP from the Julia REPL:

] clone https://github.com/CiaranOMara/STAMP.jl

Usage

Read records

using STAMP

reader = open(STAMP.Reader, file)
record = read(reader) #TODO: read all records.
using STAMP

reader = open(STAMP.Reader, file)
for record in reader
    # Do something
end
close(reader)
using STAMP

reader = open(STAMP.Reader, file)
record = STAMP.Record()
read!(reader, record))
# Do something
close(reader)
using STAMP

open(STAMP.Reader, file) do reader
    for record in reader
        # Do something
    end
end