https://github.com/natir/cocktail

https://github.com/natir/cocktail

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/natir/cocktail
• Owner: natir
• License: mit
• Created: 2019-12-18T10:07:06.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T18:15:16.000Z (7 months ago)
• Last Synced: 2024-05-22T19:34:50.718Z (7 months ago)
• Language: Rust
• Size: 3.44 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/natir/cocktail/blob/master/LICENSE)

![CI](https://github.com/natir/cocktail/workflows/CI/badge.svg)

[![Documentation](https://github.com/natir/cocktail/workflows/Documentation/badge.svg)](https://natir.github.io/cocktail/cocktail)

[![CodeCov](https://codecov.io/gh/natir/cocktail/branch/master/graph/badge.svg)](https://codecov.io/gh/natir/cocktail)

# Cocktail  🧬 💻

Cocktail it's a rust crate, python module, c library, to convert DNA in kmer 2 bit representation and get is cannonical version.

**Warning this isn't stable, API can change any time**

- [Instalation](#instalation)

- [Usage](#usage)

- [Minimum supported Rust version](#minimum-supported-rust-version)

- [Citation](#citation)

## Instalation

## Rust

In `[dependencies]` section of your `Cargo.toml` add this:

```

cocktail = { git="https://github.com/natir/cocktail.git" }

```

## Python binding

Give this to pip:

```

git+https://github.com/natir/cocktail.git#egg=cocktail&subdirectory=dist/python

```

## C binding

```

git clone https://github.com/natir/cocktail.git

cd cocktail

cargo build --release

cbindgen --config cbindgen.toml --crate cocktail --output dist/c/cocktail.h

cd dist/c/

make

./test

```

Dynamic and static library is avaible her `target/release/libcocktail.{a|so}` header is her `dist/c/cocktail.h`. To build a C programe you need to add `-lpthread -lm -ldl` durring linking phase.

## Usage

Check [documentation](https://natir.github.io/cocktail/cocktail)

## Minimum supported Rust version

Currently the minimum supported Rust version is 1.74.

## Citation

WIP