[](https://doi.org/10.5281/zenodo.5908678)
[](https://python-modelcif.readthedocs.org/)
[](https://anaconda.org/conda-forge/modelcif)
[](https://badge.fury.io/py/modelcif)
[](https://github.com/ihmwg/python-modelcif/actions?query=workflow%3Abuild)
[](https://ci.appveyor.com/project/benmwebb/python-modelcif)
[](https://codecov.io/gh/ihmwg/python-modelcif)
This is a Python package to assist in handling [mmCIF](http://mmcif.wwpdb.org/)
and [BinaryCIF](https://github.com/dsehnal/BinaryCIF) files compliant with the
[ModelCIF](https://mmcif.wwpdb.org/dictionaries/mmcif_ma.dic/Index/)
extension. It works with Python 2.7 or Python 3.
Please [see the documentation](https://python-modelcif.readthedocs.org/) or some
[worked examples](https://github.com/ihmwg/python-modelcif/tree/main/examples)
for more details.
# Installation with conda or pip
If you are using [Anaconda Python](https://www.anaconda.com/), install with
```
conda install -c conda-forge modelcif
```
On a Fedora or RedHat Enterprise Linux box, install with
```
dnf copr enable salilab/salilab; dnf install python3-modelcif
```
Alternatively, install with pip:
```
pip install modelcif
```
# Installation from source code
To build and install from a clone of the GitHub repository,
first build and install version 1.7 or later of the
[python-ihm](https://github.com/ihmwg/python-ihm) module. Then run:
```
python setup.py build
python setup.py install
```
If you want to read or write [BinaryCIF](https://github.com/dsehnal/BinaryCIF)
files, you will also need the
Python [msgpack](https://github.com/msgpack/msgpack-python) package.
# Testing
There are a number of testcases in the `test` directory. Each one can be run
like a normal Python script to test the library. They can also be all run at
once using [nose](https://nose.readthedocs.io/en/latest/)
or [pytest](https://docs.pytest.org/en/latest/).
Raw data
{
"_id": null,
"home_page": "https://github.com/ihmwg/python-modelcif",
"name": "modelcif",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Ben Webb",
"author_email": "ben@salilab.org",
"download_url": "https://files.pythonhosted.org/packages/25/e5/b1596a04070d7ac975534fef4e6e5f924a166b90558521f1912827906a87/modelcif-1.2.tar.gz",
"platform": null,
"description": "[](https://doi.org/10.5281/zenodo.5908678)\n[](https://python-modelcif.readthedocs.org/)\n[](https://anaconda.org/conda-forge/modelcif)\n[](https://badge.fury.io/py/modelcif)\n[](https://github.com/ihmwg/python-modelcif/actions?query=workflow%3Abuild)\n[](https://ci.appveyor.com/project/benmwebb/python-modelcif)\n[](https://codecov.io/gh/ihmwg/python-modelcif)\n\nThis is a Python package to assist in handling [mmCIF](http://mmcif.wwpdb.org/)\nand [BinaryCIF](https://github.com/dsehnal/BinaryCIF) files compliant with the\n[ModelCIF](https://mmcif.wwpdb.org/dictionaries/mmcif_ma.dic/Index/)\nextension. It works with Python 2.7 or Python 3.\n\nPlease [see the documentation](https://python-modelcif.readthedocs.org/) or some\n[worked examples](https://github.com/ihmwg/python-modelcif/tree/main/examples)\nfor more details.\n\n# Installation with conda or pip\n\nIf you are using [Anaconda Python](https://www.anaconda.com/), install with\n\n```\nconda install -c conda-forge modelcif\n```\n\nOn a Fedora or RedHat Enterprise Linux box, install with\n\n```\ndnf copr enable salilab/salilab; dnf install python3-modelcif\n```\n\nAlternatively, install with pip:\n\n```\npip install modelcif\n```\n\n# Installation from source code\n\nTo build and install from a clone of the GitHub repository,\nfirst build and install version 1.7 or later of the\n[python-ihm](https://github.com/ihmwg/python-ihm) module. Then run:\n\n```\npython setup.py build\npython setup.py install\n```\n\nIf you want to read or write [BinaryCIF](https://github.com/dsehnal/BinaryCIF)\nfiles, you will also need the\nPython [msgpack](https://github.com/msgpack/msgpack-python) package.\n\n# Testing\n\nThere are a number of testcases in the `test` directory. Each one can be run\nlike a normal Python script to test the library. They can also be all run at\nonce using [nose](https://nose.readthedocs.io/en/latest/)\nor [pytest](https://docs.pytest.org/en/latest/).\n",
"bugtrack_url": null,
"license": null,
"summary": "Package for handling ModelCIF mmCIF and BinaryCIF files",
"version": "1.2",
"project_urls": {
"Homepage": "https://github.com/ihmwg/python-modelcif"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25e5b1596a04070d7ac975534fef4e6e5f924a166b90558521f1912827906a87",
"md5": "26abc67820b6106857cac0209dc77b59",
"sha256": "517d2a7be67c96fd56dcc3b50cf7bb0b130958c325653d9925f9a5dbfe151d78"
},
"downloads": -1,
"filename": "modelcif-1.2.tar.gz",
"has_sig": false,
"md5_digest": "26abc67820b6106857cac0209dc77b59",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 66794,
"upload_time": "2024-10-23T22:57:59",
"upload_time_iso_8601": "2024-10-23T22:57:59.657558Z",
"url": "https://files.pythonhosted.org/packages/25/e5/b1596a04070d7ac975534fef4e6e5f924a166b90558521f1912827906a87/modelcif-1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 22:57:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ihmwg",
"github_project": "python-modelcif",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"requirements": [],
"lcname": "modelcif"
}
JSON
