biobb-structure-utils


Namebiobb-structure-utils JSON
Version 5.0.0 PyPI version JSON
download
home_pagehttps://github.com/bioexcel/biobb_structure_utils
Summarybiobb_structure_utils is the Biobb module collection to perform basic manipulations on 3d structures.
upload_time2024-11-21 09:09:57
maintainerNone
docs_urlNone
authorBiobb developers
requires_python>=3.9
licenseNone
keywords bioinformatics workflows bioexcel compatibility
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![](https://img.shields.io/github/v/tag/bioexcel/biobb_structure_utils?label=Version)](https://GitHub.com/bioexcel/biobb_structure_utils/tags/)
[![](https://img.shields.io/pypi/v/biobb-structure-utils.svg?label=Pypi)](https://pypi.python.org/pypi/biobb-structure-utils/)
[![](https://img.shields.io/conda/vn/bioconda/biobb_structure_utils?label=Conda)](https://anaconda.org/bioconda/biobb_structure_utils)
[![](https://img.shields.io/conda/dn/bioconda/biobb_structure_utils?label=Conda%20Downloads)](https://anaconda.org/bioconda/biobb_structure_utils)
[![](https://img.shields.io/badge/Docker-Quay.io-blue)](https://quay.io/repository/biocontainers/biobb_structure_utils?tab=tags)
[![](https://img.shields.io/badge/Singularity-GalaxyProject-blue)](https://depot.galaxyproject.org/singularity/biobb_structure_utils:5.0.0--pyhdfd78af_0)

[![](https://img.shields.io/badge/OS-Unix%20%7C%20MacOS-blue)](https://github.com/bioexcel/biobb_structure_utils)
[![](https://img.shields.io/pypi/pyversions/biobb-structure-utils.svg?label=Python%20Versions)](https://pypi.org/project/biobb-structure-utils/)
[![](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![](https://img.shields.io/badge/Open%20Source%3f-Yes!-blue)](https://github.com/bioexcel/biobb_structure_utils)

[![](https://readthedocs.org/projects/biobb-structure-utils/badge/?version=latest&label=Docs)](https://biobb-structure-utils.readthedocs.io/en/latest/?badge=latest)
[![](https://img.shields.io/website?down_message=Offline&label=Biobb%20Website&up_message=Online&url=https%3A%2F%2Fmmb.irbbarcelona.org%2Fbiobb%2F)]()
[![](https://img.shields.io/badge/Youtube-tutorials-blue?logo=youtube&logoColor=red)](https://www.youtube.com/@BioExcelCoE/search?query=biobb)
[![](https://zenodo.org/badge/DOI/10.1038/s41597-019-0177-4.svg)](https://doi.org/10.1038/s41597-019-0177-4)
[![](https://img.shields.io/endpoint?color=brightgreen&url=https%3A%2F%2Fapi.juleskreuer.eu%2Fcitation-badge.php%3Fshield%26doi%3D10.1038%2Fs41597-019-0177-4)](https://www.nature.com/articles/s41597-019-0177-4#citeas)

[![](https://docs.bioexcel.eu/biobb_structure_utils/junit/testsbadge.svg)](https://docs.bioexcel.eu/biobb_structure_utils/junit/report.html)
[![](https://docs.bioexcel.eu/biobb_structure_utils/coverage/coveragebadge.svg)](https://docs.bioexcel.eu/biobb_structure_utils/coverage/)
[![](https://docs.bioexcel.eu/biobb_structure_utils/flake8/flake8badge.svg)](https://docs.bioexcel.eu/biobb_structure_utils/flake8/)
[![](https://img.shields.io/github/last-commit/bioexcel/biobb_structure_utils?label=Last%20Commit)](https://github.com/bioexcel/biobb_structure_utils/commits/master)
[![](https://img.shields.io/github/issues/bioexcel/biobb_structure_utils.svg?color=brightgreen&label=Issues)](https://GitHub.com/bioexcel/biobb_structure_utils/issues/)

[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu)
[![](https://www.bestpractices.dev/projects/8847/badge)](https://www.bestpractices.dev/projects/8847)

[](https://bestpractices.coreinfrastructure.org/projects/8847/badge)

[//]: # (The previous line invisible link is for compatibility with the howfairis script https://github.com/fair-software/howfairis-github-action/tree/main wich uses the old bestpractices URL)

# biobb_structure_utils

### Introduction
Biobb_structure_utils is the Biobb module collection to modify or extract information from a PDB structure file, such as pulling out a particular model or chain, removing water molecules or ligands, or renumbering or sorting atoms or residues. Biobb (BioExcel building blocks) packages are Python building blocks that create new layer of compatibility and interoperability over popular bioinformatics tools. The latest documentation of this package can be found in our readthedocs site:
[latest API documentation](https://biobb-structure-utils.readthedocs.io/en/latest/).

### Version
v5.0.0 2024.2

### Installation

Using PIP:

> **Important:** PIP only installs the package. All the dependencies must be installed separately. To perform a complete installation, please use ANACONDA, DOCKER or SINGULARITY.

* Installation:


        pip install "biobb_structure_utils>=5.0.0"


* Usage: [Python API documentation](https://biobb-structure-utils.readthedocs.io/en/latest/modules.html)

Using ANACONDA:

* Installation:


        conda install -c bioconda "biobb_structure_utils>=5.0.0"


* Usage: With conda installation BioBBs can be used with the [Python API documentation](https://biobb-structure-utils.readthedocs.io/en/latest/modules.html) and the [Command Line documentation](https://biobb-structure-utils.readthedocs.io/en/latest/command_line.html)

Using DOCKER:

* Installation:


        docker pull quay.io/biocontainers/biobb_structure_utils:5.0.0--pyhdfd78af_0


* Usage:


        docker run quay.io/biocontainers/biobb_structure_utils:5.0.0--pyhdfd78af_0 <command>

Using SINGULARITY:

**MacOS users**: it's strongly recommended to avoid Singularity and use **Docker** as containerization system.

* Installation:


        singularity pull --name biobb_structure_utils.sif https://depot.galaxyproject.org/singularity/biobb_structure_utils:5.0.0--pyhdfd78af_0


* Usage:


        singularity exec biobb_structure_utils.sif <command>



The command list and specification can be found at the [Command Line documentation](https://biobb-structure-utils.readthedocs.io/en/latest/command_line.html).

### Copyright & Licensing
This software has been developed in the [MMB group](http://mmb.irbbarcelona.org) at the [BSC](http://www.bsc.es/) & [IRB](https://www.irbbarcelona.org/) for the [European BioExcel](http://bioexcel.eu/), funded by the European Commission (EU H2020 [823830](http://cordis.europa.eu/projects/823830), EU H2020 [675728](http://cordis.europa.eu/projects/675728)).

* (c) 2015-2024 [Barcelona Supercomputing Center](https://www.bsc.es/)
* (c) 2015-2024 [Institute for Research in Biomedicine](https://www.irbbarcelona.org/)

Licensed under the
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file LICENSE for details.

### Acknolegements
This software uses functions to read and modify GRO files based in the [GROPY](https://github.com/caizkun/gropy) library created by Zhikun Cai (caizkun@gmail.com) under the [MIT](https://github.com/caizkun/gropy/blob/master/LICENSE). In this project [GROPY](https://github.com/caizkun/gropy) has been adapted to Python 3 and our own needs.

![](https://bioexcel.eu/wp-content/uploads/2019/04/Bioexcell_logo_1080px_transp.png "Bioexcel")

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/bioexcel/biobb_structure_utils",
    "name": "biobb-structure-utils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "Bioinformatics Workflows BioExcel Compatibility",
    "author": "Biobb developers",
    "author_email": "pau.andrio@bsc.es",
    "download_url": "https://files.pythonhosted.org/packages/30/ee/dec06bdb41b4e6dc5b9319689bde3b974020be8365699efc0445679004c8/biobb_structure_utils-5.0.0.tar.gz",
    "platform": null,
    "description": "[![](https://img.shields.io/github/v/tag/bioexcel/biobb_structure_utils?label=Version)](https://GitHub.com/bioexcel/biobb_structure_utils/tags/)\n[![](https://img.shields.io/pypi/v/biobb-structure-utils.svg?label=Pypi)](https://pypi.python.org/pypi/biobb-structure-utils/)\n[![](https://img.shields.io/conda/vn/bioconda/biobb_structure_utils?label=Conda)](https://anaconda.org/bioconda/biobb_structure_utils)\n[![](https://img.shields.io/conda/dn/bioconda/biobb_structure_utils?label=Conda%20Downloads)](https://anaconda.org/bioconda/biobb_structure_utils)\n[![](https://img.shields.io/badge/Docker-Quay.io-blue)](https://quay.io/repository/biocontainers/biobb_structure_utils?tab=tags)\n[![](https://img.shields.io/badge/Singularity-GalaxyProject-blue)](https://depot.galaxyproject.org/singularity/biobb_structure_utils:5.0.0--pyhdfd78af_0)\n\n[![](https://img.shields.io/badge/OS-Unix%20%7C%20MacOS-blue)](https://github.com/bioexcel/biobb_structure_utils)\n[![](https://img.shields.io/pypi/pyversions/biobb-structure-utils.svg?label=Python%20Versions)](https://pypi.org/project/biobb-structure-utils/)\n[![](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![](https://img.shields.io/badge/Open%20Source%3f-Yes!-blue)](https://github.com/bioexcel/biobb_structure_utils)\n\n[![](https://readthedocs.org/projects/biobb-structure-utils/badge/?version=latest&label=Docs)](https://biobb-structure-utils.readthedocs.io/en/latest/?badge=latest)\n[![](https://img.shields.io/website?down_message=Offline&label=Biobb%20Website&up_message=Online&url=https%3A%2F%2Fmmb.irbbarcelona.org%2Fbiobb%2F)]()\n[![](https://img.shields.io/badge/Youtube-tutorials-blue?logo=youtube&logoColor=red)](https://www.youtube.com/@BioExcelCoE/search?query=biobb)\n[![](https://zenodo.org/badge/DOI/10.1038/s41597-019-0177-4.svg)](https://doi.org/10.1038/s41597-019-0177-4)\n[![](https://img.shields.io/endpoint?color=brightgreen&url=https%3A%2F%2Fapi.juleskreuer.eu%2Fcitation-badge.php%3Fshield%26doi%3D10.1038%2Fs41597-019-0177-4)](https://www.nature.com/articles/s41597-019-0177-4#citeas)\n\n[![](https://docs.bioexcel.eu/biobb_structure_utils/junit/testsbadge.svg)](https://docs.bioexcel.eu/biobb_structure_utils/junit/report.html)\n[![](https://docs.bioexcel.eu/biobb_structure_utils/coverage/coveragebadge.svg)](https://docs.bioexcel.eu/biobb_structure_utils/coverage/)\n[![](https://docs.bioexcel.eu/biobb_structure_utils/flake8/flake8badge.svg)](https://docs.bioexcel.eu/biobb_structure_utils/flake8/)\n[![](https://img.shields.io/github/last-commit/bioexcel/biobb_structure_utils?label=Last%20Commit)](https://github.com/bioexcel/biobb_structure_utils/commits/master)\n[![](https://img.shields.io/github/issues/bioexcel/biobb_structure_utils.svg?color=brightgreen&label=Issues)](https://GitHub.com/bioexcel/biobb_structure_utils/issues/)\n\n[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu)\n[![](https://www.bestpractices.dev/projects/8847/badge)](https://www.bestpractices.dev/projects/8847)\n\n[](https://bestpractices.coreinfrastructure.org/projects/8847/badge)\n\n[//]: # (The previous line invisible link is for compatibility with the howfairis script https://github.com/fair-software/howfairis-github-action/tree/main wich uses the old bestpractices URL)\n\n# biobb_structure_utils\n\n### Introduction\nBiobb_structure_utils is the Biobb module collection to modify or extract information from a PDB structure file, such as pulling out a particular model or chain, removing water molecules or ligands, or renumbering or sorting atoms or residues. Biobb (BioExcel building blocks) packages are Python building blocks that create new layer of compatibility and interoperability over popular bioinformatics tools. The latest documentation of this package can be found in our readthedocs site:\n[latest API documentation](https://biobb-structure-utils.readthedocs.io/en/latest/).\n\n### Version\nv5.0.0 2024.2\n\n### Installation\n\nUsing PIP:\n\n> **Important:** PIP only installs the package. All the dependencies must be installed separately. To perform a complete installation, please use ANACONDA, DOCKER or SINGULARITY.\n\n* Installation:\n\n\n        pip install \"biobb_structure_utils>=5.0.0\"\n\n\n* Usage: [Python API documentation](https://biobb-structure-utils.readthedocs.io/en/latest/modules.html)\n\nUsing ANACONDA:\n\n* Installation:\n\n\n        conda install -c bioconda \"biobb_structure_utils>=5.0.0\"\n\n\n* Usage: With conda installation BioBBs can be used with the [Python API documentation](https://biobb-structure-utils.readthedocs.io/en/latest/modules.html) and the [Command Line documentation](https://biobb-structure-utils.readthedocs.io/en/latest/command_line.html)\n\nUsing DOCKER:\n\n* Installation:\n\n\n        docker pull quay.io/biocontainers/biobb_structure_utils:5.0.0--pyhdfd78af_0\n\n\n* Usage:\n\n\n        docker run quay.io/biocontainers/biobb_structure_utils:5.0.0--pyhdfd78af_0 <command>\n\nUsing SINGULARITY:\n\n**MacOS users**: it's strongly recommended to avoid Singularity and use **Docker** as containerization system.\n\n* Installation:\n\n\n        singularity pull --name biobb_structure_utils.sif https://depot.galaxyproject.org/singularity/biobb_structure_utils:5.0.0--pyhdfd78af_0\n\n\n* Usage:\n\n\n        singularity exec biobb_structure_utils.sif <command>\n\n\n\nThe command list and specification can be found at the [Command Line documentation](https://biobb-structure-utils.readthedocs.io/en/latest/command_line.html).\n\n### Copyright & Licensing\nThis software has been developed in the [MMB group](http://mmb.irbbarcelona.org) at the [BSC](http://www.bsc.es/) & [IRB](https://www.irbbarcelona.org/) for the [European BioExcel](http://bioexcel.eu/), funded by the European Commission (EU H2020 [823830](http://cordis.europa.eu/projects/823830), EU H2020 [675728](http://cordis.europa.eu/projects/675728)).\n\n* (c) 2015-2024 [Barcelona Supercomputing Center](https://www.bsc.es/)\n* (c) 2015-2024 [Institute for Research in Biomedicine](https://www.irbbarcelona.org/)\n\nLicensed under the\n[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0), see the file LICENSE for details.\n\n### Acknolegements\nThis software uses functions to read and modify GRO files based in the [GROPY](https://github.com/caizkun/gropy) library created by Zhikun Cai (caizkun@gmail.com) under the [MIT](https://github.com/caizkun/gropy/blob/master/LICENSE). In this project [GROPY](https://github.com/caizkun/gropy) has been adapted to Python 3 and our own needs.\n\n![](https://bioexcel.eu/wp-content/uploads/2019/04/Bioexcell_logo_1080px_transp.png \"Bioexcel\")\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "biobb_structure_utils is the Biobb module collection to perform basic manipulations on 3d structures.",
    "version": "5.0.0",
    "project_urls": {
        "Bioexcel": "https://bioexcel.eu/",
        "Documentation": "http://biobb-structure-utils.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/bioexcel/biobb_structure_utils"
    },
    "split_keywords": [
        "bioinformatics",
        "workflows",
        "bioexcel",
        "compatibility"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1d3b8af1f25bed795592c94c7b0c674754cf03965f1b601220fe68302d63d2d8",
                "md5": "60366ade290f63000d888a69299dd7f4",
                "sha256": "b93e485df26cf7de7b08973985ff29c742c7c78e98f70c1e172f379f4ebef2b1"
            },
            "downloads": -1,
            "filename": "biobb_structure_utils-5.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "60366ade290f63000d888a69299dd7f4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 54219,
            "upload_time": "2024-11-21T09:09:56",
            "upload_time_iso_8601": "2024-11-21T09:09:56.030284Z",
            "url": "https://files.pythonhosted.org/packages/1d/3b/8af1f25bed795592c94c7b0c674754cf03965f1b601220fe68302d63d2d8/biobb_structure_utils-5.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "30eedec06bdb41b4e6dc5b9319689bde3b974020be8365699efc0445679004c8",
                "md5": "9993633af44f6a316efdf547630b2a30",
                "sha256": "6a29a511bd7e1e94b2f4c65dd10c24dda86366fbffd1359fab2ec3434ddd0be7"
            },
            "downloads": -1,
            "filename": "biobb_structure_utils-5.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "9993633af44f6a316efdf547630b2a30",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 28838,
            "upload_time": "2024-11-21T09:09:57",
            "upload_time_iso_8601": "2024-11-21T09:09:57.732961Z",
            "url": "https://files.pythonhosted.org/packages/30/ee/dec06bdb41b4e6dc5b9319689bde3b974020be8365699efc0445679004c8/biobb_structure_utils-5.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-21 09:09:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bioexcel",
    "github_project": "biobb_structure_utils",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "biobb-structure-utils"
}
        
Elapsed time: 0.41774s