sstadick / nimedlib

Nim wrapper for the Edlib library

nimedlib

A Nim wrapper for the Edlib library.

Synopsis

Edlib is an awesome library for doing non-affine-gap alignments. The venerable lh3 calls it very fast. I'm sure there is some smoothing to be done to make this more ergonimic (sic).

Install

This will be pushed to nimble once I've bombproofed it a bit.

git clone <this dir>
cd nimedlib
nimble install

Usage

import nimedlib

proc main() =
    var
        str1: cstring = "The dog bit the wall"
        str2: cstring = "The cat bit the wall"

    var result = edlibAlign(str1, cint(str1.len), str2, cint(str2.len),
            edlibDefaultAlignConfig())
    # May need to call edlibFreeAlignResult()
    echo result

when isMainModule:
    main()

Run with

nim cpp -r align_test.nim

Notes to future self

This was built with nimterop. It was very slick once I realized i needed to compile the nim programs that use the library with cpp. I initially started with a versino using nimgen, which can be found in the inital commit, and works if you run with cpp. 10/10, nim binding to C is a pleasure.

nimedlib's Issues

Suggestions for nimterop

Great work getting this to work with nimterop. Some suggestions:-

• Instead of using nimteropBuildDir(), would be better to have a path relative to your project using currentSourcePath.parentDir().
• Remove cDisableCaching() so that users of your lib don't have to regenerate it every time they compile their project. It only makes sense during dev. of the lib.
• You don't need either cAddStdDir("cpp") or cAddSearchDir(baseDir).