dcFBA


NamedcFBA JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/SystemsBioinformatics/dynamic-community-fba
SummaryPython package for Dynamic Community FBA
upload_time2023-11-13 15:51:12
maintainer
docs_urlNone
authorSteven Wijnen, Francesco Moro, Brett Olivier
requires_python<3.11,>=3.8
licenseMIT License Copyright (c) 2023 Steven Wijnen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords microbial community systems biology dynamic fba genome scale models
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Dynamic Community FBA

Welcome to Dynamic Community FBA (dcFBA): The Python package that makes modeling Microbial Communities dynamically a breeze!

This project is licensed under the MIT License - please refer to the [LICENSE](LICENSE) file for more details.

## About

Dynamic Community FBA (dcFBA) is a versatile tool designed for modeling microbial communities as single organisms using Genome Scale Metabolic Models (GSMMs). This package builds upon the solid foundation of [cbmpy](https://github.com/SystemsBioinformatics/cbmpy) and seamlessly integrates with SBML and COBRApy models. dcFBA empowers users with three distinct dynamic modeling methods:

1. **Dynamic Joint FBA** - Incrementally updates the concentrations of biomass and metabolites within the combined stoichiometric matrix of the provided models.

2. **Dynamic Parallel FBA** - Simultaneously updates the concentrations of biomass and metabolites while performing FBA on individual models.

3. **EndPointFBA** - Duplicates the CommunityMatrix N times and performs FBA on the community's time-dependent stoichiometric matrix.

For a comprehensive understanding of these methods and their underlying mathematics, please consult [^1].

Whether you're exploring parasitic interactions or investigating costly cross-feeding behaviors in microbial communities, dcFBA offers an elegant and efficient solution.

## Installation

### Prerequisites

Before installing dcFBA, make sure you have the following prerequisites in place:

- Python >= 3.8, < 3.11
- [cbmpy](https://github.com/SystemsBioinformatics/cbmpy)
- [cplex](https://www.ibm.com/products/ilog-cplex-optimization-studio)

### Installation Steps

To install dcFBA, follow these simple steps:

1. Install using pip:

    ```bash
    pip install dcFBA
    ```

## Usage

For basic usage examples and detailed documentation on both [cbmpy](https://pythonhosted.org/cbmpy/modules_doc.html) and [dcFBA](https://dynamic-community-fba.readthedocs.io/en/latest), please refer to their respective documentation pages.

[^1]: [Cite paper.]

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/SystemsBioinformatics/dynamic-community-fba",
    "name": "dcFBA",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<3.11,>=3.8",
    "maintainer_email": "",
    "keywords": "Microbial Community,Systems Biology,Dynamic FBA,Genome Scale Models",
    "author": "Steven Wijnen, Francesco Moro, Brett Olivier",
    "author_email": "Steven Wijnen <steven.wijnen@icloud.com>, Francesco Moro <f.moro@vu.nl>, Brett Olivier <b.g.olivier@vu.nl>",
    "download_url": "https://files.pythonhosted.org/packages/8a/ed/1dac75ebceea165ea70178df4e109559c36691e8a3b722a5a47159701dbc/dcFBA-0.1.2.tar.gz",
    "platform": null,
    "description": "# Dynamic Community FBA\n\nWelcome to Dynamic Community FBA (dcFBA): The Python package that makes modeling Microbial Communities dynamically a breeze!\n\nThis project is licensed under the MIT License - please refer to the [LICENSE](LICENSE) file for more details.\n\n## About\n\nDynamic Community FBA (dcFBA) is a versatile tool designed for modeling microbial communities as single organisms using Genome Scale Metabolic Models (GSMMs). This package builds upon the solid foundation of [cbmpy](https://github.com/SystemsBioinformatics/cbmpy) and seamlessly integrates with SBML and COBRApy models. dcFBA empowers users with three distinct dynamic modeling methods:\n\n1. **Dynamic Joint FBA** - Incrementally updates the concentrations of biomass and metabolites within the combined stoichiometric matrix of the provided models.\n\n2. **Dynamic Parallel FBA** - Simultaneously updates the concentrations of biomass and metabolites while performing FBA on individual models.\n\n3. **EndPointFBA** - Duplicates the CommunityMatrix N times and performs FBA on the community's time-dependent stoichiometric matrix.\n\nFor a comprehensive understanding of these methods and their underlying mathematics, please consult [^1].\n\nWhether you're exploring parasitic interactions or investigating costly cross-feeding behaviors in microbial communities, dcFBA offers an elegant and efficient solution.\n\n## Installation\n\n### Prerequisites\n\nBefore installing dcFBA, make sure you have the following prerequisites in place:\n\n- Python >= 3.8, < 3.11\n- [cbmpy](https://github.com/SystemsBioinformatics/cbmpy)\n- [cplex](https://www.ibm.com/products/ilog-cplex-optimization-studio)\n\n### Installation Steps\n\nTo install dcFBA, follow these simple steps:\n\n1. Install using pip:\n\n    ```bash\n    pip install dcFBA\n    ```\n\n## Usage\n\nFor basic usage examples and detailed documentation on both [cbmpy](https://pythonhosted.org/cbmpy/modules_doc.html) and [dcFBA](https://dynamic-community-fba.readthedocs.io/en/latest), please refer to their respective documentation pages.\n\n[^1]: [Cite paper.]\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Steven Wijnen  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Python package for Dynamic Community FBA",
    "version": "0.1.2",
    "project_urls": {
        "Homepage": "https://github.com/SystemsBioinformatics/dynamic-community-fba",
        "bug-tracker": "https://github.com/SystemsBioinformatics/dynamic-community-fba/issues",
        "docs": "https://dynamic-community-fba.readthedocs.io/en/latest/index.html"
    },
    "split_keywords": [
        "microbial community",
        "systems biology",
        "dynamic fba",
        "genome scale models"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "436a6e58af06e48d25088db0a41484f1172af876b0bb50370740d0b7271d3faf",
                "md5": "2fa1be6fbf668beb03936edd15c9b9e6",
                "sha256": "b1b3a53f47cd3f60fe7ec2b904ed0798a4c0962570931155cbab588576c9c2f3"
            },
            "downloads": -1,
            "filename": "dcFBA-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2fa1be6fbf668beb03936edd15c9b9e6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.11,>=3.8",
            "size": 133423,
            "upload_time": "2023-11-13T15:51:10",
            "upload_time_iso_8601": "2023-11-13T15:51:10.512888Z",
            "url": "https://files.pythonhosted.org/packages/43/6a/6e58af06e48d25088db0a41484f1172af876b0bb50370740d0b7271d3faf/dcFBA-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8aed1dac75ebceea165ea70178df4e109559c36691e8a3b722a5a47159701dbc",
                "md5": "7d1288110e1a78ceba3ebdedaafeedb9",
                "sha256": "2788b41581e58868e1cc9927c68bce8d22e1f6976181fbccfa7d2f7a74a09c43"
            },
            "downloads": -1,
            "filename": "dcFBA-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7d1288110e1a78ceba3ebdedaafeedb9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.11,>=3.8",
            "size": 115106,
            "upload_time": "2023-11-13T15:51:12",
            "upload_time_iso_8601": "2023-11-13T15:51:12.874877Z",
            "url": "https://files.pythonhosted.org/packages/8a/ed/1dac75ebceea165ea70178df4e109559c36691e8a3b722a5a47159701dbc/dcFBA-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-13 15:51:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SystemsBioinformatics",
    "github_project": "dynamic-community-fba",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "lcname": "dcfba"
}
        
Elapsed time: 0.13792s