bgen-reader


Namebgen-reader JSON
Version 4.0.9 PyPI version JSON
download
home_pageNone
SummaryBgen file format reader
upload_time2024-10-28 12:02:36
maintainerNone
docs_urlNone
authorDanilo Horta
requires_python<4.0,>=3.10
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # bgen-reader

A [bgen file format](http://www.well.ox.ac.uk/~gav/bgen_format/) reader.

Bgen is a file format for storing large genetic datasets.
It supports both unphased genotypes and phased haplotype data with variable
ploidy and number of alleles. It was designed to provides a compact data
representation without sacrificing variant access performance.

This python package is a wrapper around the [bgen library](https://github.com/limix/bgen),
a low-memory footprint reader that efficiently reads bgen files.
It fully supports the bgen format specifications: 1.2 and 1.3;
as well as their optional compressed formats.

## Install

It can be installed via [conda](https://conda.io/docs/)

```bash
conda install -c conda-forge bgen-reader
```

Or via pip

```bash
pip install bgen-reader
```

## Documentation

Please, refer to [https://bgen-reader.readthedocs.io](https://bgen-reader.readthedocs.io).


## Troubleshooting

### fatal error: bgen.h: No such file or directory

This means that bgen C library is not installed (or could not be found). Please,
follow the instructions in <https://github.com/limix/bgen> to install it, and try
installing bgen-reader again.

## Problems

If you encounter any issue, please, [submit it](https://github.com/limix/bgen-reader-py/issues/new).

## Authors

* [Danilo Horta](https://github.com/horta)

## License

This project is licensed under the [MIT License](https://raw.githubusercontent.com/limix/bgen-reader-py/main/LICENSE.md).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bgen-reader",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Danilo Horta",
    "author_email": "horta@ebi.ac.uk",
    "download_url": "https://files.pythonhosted.org/packages/c8/f6/d4a9f461b5b06d8d25b5b2d6511456b700e5cb68d53cac1c01f94f6c8722/bgen_reader-4.0.9.tar.gz",
    "platform": null,
    "description": "# bgen-reader\n\nA [bgen file format](http://www.well.ox.ac.uk/~gav/bgen_format/) reader.\n\nBgen is a file format for storing large genetic datasets.\nIt supports both unphased genotypes and phased haplotype data with variable\nploidy and number of alleles. It was designed to provides a compact data\nrepresentation without sacrificing variant access performance.\n\nThis python package is a wrapper around the [bgen library](https://github.com/limix/bgen),\na low-memory footprint reader that efficiently reads bgen files.\nIt fully supports the bgen format specifications: 1.2 and 1.3;\nas well as their optional compressed formats.\n\n## Install\n\nIt can be installed via [conda](https://conda.io/docs/)\n\n```bash\nconda install -c conda-forge bgen-reader\n```\n\nOr via pip\n\n```bash\npip install bgen-reader\n```\n\n## Documentation\n\nPlease, refer to [https://bgen-reader.readthedocs.io](https://bgen-reader.readthedocs.io).\n\n\n## Troubleshooting\n\n### fatal error: bgen.h: No such file or directory\n\nThis means that bgen C library is not installed (or could not be found). Please,\nfollow the instructions in <https://github.com/limix/bgen> to install it, and try\ninstalling bgen-reader again.\n\n## Problems\n\nIf you encounter any issue, please, [submit it](https://github.com/limix/bgen-reader-py/issues/new).\n\n## Authors\n\n* [Danilo Horta](https://github.com/horta)\n\n## License\n\nThis project is licensed under the [MIT License](https://raw.githubusercontent.com/limix/bgen-reader-py/main/LICENSE.md).\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Bgen file format reader",
    "version": "4.0.9",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "528e63fb2501ea08c80345ea4ab5bdef6128754bad029625704074716585051a",
                "md5": "010b657d9553b8c06169710f19efb61d",
                "sha256": "f32fc05dc83374eec1d150e51132768afa0d0556723dd35d88de23fabf2fb519"
            },
            "downloads": -1,
            "filename": "bgen_reader-4.0.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "010b657d9553b8c06169710f19efb61d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 44620,
            "upload_time": "2024-10-28T12:02:34",
            "upload_time_iso_8601": "2024-10-28T12:02:34.132853Z",
            "url": "https://files.pythonhosted.org/packages/52/8e/63fb2501ea08c80345ea4ab5bdef6128754bad029625704074716585051a/bgen_reader-4.0.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c8f6d4a9f461b5b06d8d25b5b2d6511456b700e5cb68d53cac1c01f94f6c8722",
                "md5": "5ee2605fef2c73f82d512181905738c6",
                "sha256": "20a9b48e3a41d3abd217570aa397b4bcdb3e5834c37aa1789507686d59fdf485"
            },
            "downloads": -1,
            "filename": "bgen_reader-4.0.9.tar.gz",
            "has_sig": false,
            "md5_digest": "5ee2605fef2c73f82d512181905738c6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 36426,
            "upload_time": "2024-10-28T12:02:36",
            "upload_time_iso_8601": "2024-10-28T12:02:36.189012Z",
            "url": "https://files.pythonhosted.org/packages/c8/f6/d4a9f461b5b06d8d25b5b2d6511456b700e5cb68d53cac1c01f94f6c8722/bgen_reader-4.0.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-28 12:02:36",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "bgen-reader"
}
        
Elapsed time: 9.10248s