pyjellyfish


Namepyjellyfish JSON
Version 1.3.1 PyPI version JSON
download
home_pageNone
SummaryPython interface to the Jellfish DNA k-mer counter
upload_time2024-07-23 16:27:20
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseBSD-3-Clause
keywords k-mer dna rna
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            pyJellyfish : Python wrapper around Jellyfish
=============================================

[![Python version][py3.8-image]][py3.8-link]
[![Python version][py3.9-image]][py3.9-link]
[![Python version][py3.10-image]][py3.10-link]
[![Python version][py3.11-image]][py3.11-link]
[![Python version][py3.12-image]][py3.12-link]
[![PyPi version][pypi-image]][pypi-link]

Introduction
------------

This tool essentially serves as an installer for the k-mer counter Jellyfish
for use with Python. A small bundle of utilities is also included. A typical
use-case for this package would be km: <https://github.com/iric-soft/km>.

Citing
------

-   Guillaume Marcais and Carl Kingsford, A fast, lock-free approach for
    efficient parallel counting of occurrences of k-mers. Bioinformatics
    (2011) 27(6): 764-770; doi:
    <https://doi.org/10.1093/bioinformatics/btr011>

Install
-------

### With pip

``` {.sourceCode .shell}
python -m venv $HOME/.virtualenvs/km
source $HOME/.virtualenvs/km/bin/activate
pip install --upgrade pip
pip install .
```

### Options

Note that pyJellyfish has an option to manually specify which
Jellyfish version one wishes to build against. This can be done by
running pip install with specific arguments:

``` {.sourceCode .shell}
source $HOME/.virtualenvs/km/bin/activate
pip install . --config-settings="--build-option='--jf-version=2.3.0'"
```

For building pyJellyfish distributions, use the `build` command:

``` {.sourceCode .shell}
source $HOME/.virtualenvs/km/bin/activate
pip install build
python -m build --config-setting="--build-option='--jf-version=2.3.0'"
```

#### Requirements

-   Python 3.8.0 or later

[py3.8-image]: https://img.shields.io/badge/python-3.8-blue.svg
[py3.8-link]: https://www.python.org/downloads/release/python-380
[py3.9-image]: https://img.shields.io/badge/python-3.9-blue.svg
[py3.9-link]: https://www.python.org/downloads/release/python-390
[py3.10-image]: https://img.shields.io/badge/python-3.10-blue.svg
[py3.10-link]: https://www.python.org/downloads/release/python-3100
[py3.11-image]: https://img.shields.io/badge/python-3.11-blue.svg
[py3.11-link]: https://www.python.org/downloads/release/python-3110
[py3.12-image]: https://img.shields.io/badge/python-3.12-blue.svg
[py3.12-link]: https://www.python.org/downloads/release/python-3120

[pypi-image]: https://img.shields.io/pypi/v/pyjellyfish.svg
[pypi-link]: https://pypi.python.org/pypi/pyjellyfish

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyjellyfish",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "k-mer, DNA, RNA",
    "author": null,
    "author_email": "Albert Feghaly <albert.feghaly@umontreal.ca>",
    "download_url": "https://files.pythonhosted.org/packages/b4/5c/6d5ec10777e04f17ec35f3691e042925e34f2cabbea584f65de3e0c703be/pyjellyfish-1.3.1.tar.gz",
    "platform": null,
    "description": "pyJellyfish : Python wrapper around Jellyfish\n=============================================\n\n[![Python version][py3.8-image]][py3.8-link]\n[![Python version][py3.9-image]][py3.9-link]\n[![Python version][py3.10-image]][py3.10-link]\n[![Python version][py3.11-image]][py3.11-link]\n[![Python version][py3.12-image]][py3.12-link]\n[![PyPi version][pypi-image]][pypi-link]\n\nIntroduction\n------------\n\nThis tool essentially serves as an installer for the k-mer counter Jellyfish\nfor use with Python. A small bundle of utilities is also included. A typical\nuse-case for this package would be km: <https://github.com/iric-soft/km>.\n\nCiting\n------\n\n-   Guillaume Marcais and Carl Kingsford, A fast, lock-free approach for\n    efficient parallel counting of occurrences of k-mers. Bioinformatics\n    (2011) 27(6): 764-770; doi:\n    <https://doi.org/10.1093/bioinformatics/btr011>\n\nInstall\n-------\n\n### With pip\n\n``` {.sourceCode .shell}\npython -m venv $HOME/.virtualenvs/km\nsource $HOME/.virtualenvs/km/bin/activate\npip install --upgrade pip\npip install .\n```\n\n### Options\n\nNote that pyJellyfish has an option to manually specify which\nJellyfish version one wishes to build against. This can be done by\nrunning pip install with specific arguments:\n\n``` {.sourceCode .shell}\nsource $HOME/.virtualenvs/km/bin/activate\npip install . --config-settings=\"--build-option='--jf-version=2.3.0'\"\n```\n\nFor building pyJellyfish distributions, use the `build` command:\n\n``` {.sourceCode .shell}\nsource $HOME/.virtualenvs/km/bin/activate\npip install build\npython -m build --config-setting=\"--build-option='--jf-version=2.3.0'\"\n```\n\n#### Requirements\n\n-   Python 3.8.0 or later\n\n[py3.8-image]: https://img.shields.io/badge/python-3.8-blue.svg\n[py3.8-link]: https://www.python.org/downloads/release/python-380\n[py3.9-image]: https://img.shields.io/badge/python-3.9-blue.svg\n[py3.9-link]: https://www.python.org/downloads/release/python-390\n[py3.10-image]: https://img.shields.io/badge/python-3.10-blue.svg\n[py3.10-link]: https://www.python.org/downloads/release/python-3100\n[py3.11-image]: https://img.shields.io/badge/python-3.11-blue.svg\n[py3.11-link]: https://www.python.org/downloads/release/python-3110\n[py3.12-image]: https://img.shields.io/badge/python-3.12-blue.svg\n[py3.12-link]: https://www.python.org/downloads/release/python-3120\n\n[pypi-image]: https://img.shields.io/pypi/v/pyjellyfish.svg\n[pypi-link]: https://pypi.python.org/pypi/pyjellyfish\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Python interface to the Jellfish DNA k-mer counter",
    "version": "1.3.1",
    "project_urls": {
        "Repository": "https://github.com/iric-soft/pyJellyfish"
    },
    "split_keywords": [
        "k-mer",
        " dna",
        " rna"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b45c6d5ec10777e04f17ec35f3691e042925e34f2cabbea584f65de3e0c703be",
                "md5": "4d23daaf9e4b1915b84742b5ea7d3aa7",
                "sha256": "f9ec8f126b82f2fd85d717b7fb8c80ee8095958d8da748b35e7dcbba5b3fd5de"
            },
            "downloads": -1,
            "filename": "pyjellyfish-1.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4d23daaf9e4b1915b84742b5ea7d3aa7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 2947150,
            "upload_time": "2024-07-23T16:27:20",
            "upload_time_iso_8601": "2024-07-23T16:27:20.884409Z",
            "url": "https://files.pythonhosted.org/packages/b4/5c/6d5ec10777e04f17ec35f3691e042925e34f2cabbea584f65de3e0c703be/pyjellyfish-1.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-23 16:27:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "iric-soft",
    "github_project": "pyJellyfish",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pyjellyfish"
}
None
Elapsed time: 0.28217s