fgutils


Namefgutils JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryLibrary to get functional groups from molecular graphs.
upload_time2025-02-03 06:48:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords
VCS
bugtrack_url
requirements numpy networkx rdkit torch torch_geometric
Travis-CI No Travis.
coveralls test coverage
            FGUtils is a collection of utility functions for querying functional groups in
molecules from their molecular graph representation.

## Dependencies
- Python (>= 3.11)
- numpy (>= 1.26.4)
- networkx (>= 3.2.1)
- rdkit (>= 2023.09.4 optional)

Additional module dependencies.
| Module | Dependency |
| ------ | ---------- |
| fgutils.torch | [torch](https://pypi.org/project/torch/)>=2.5 |

## Installation
You can install [FGUtils](https://pypi.org/project/fgutils/) using pip.
```
pip install fgutils
```

## Getting Started
For a comprehensive description of FGUtils features read through the
[documentation](https://klausweinbauer.github.io/FGUtils/). However, querying
the functional groups for a molecule like acetylsalicylic acid is as simple as
running the following:
```
>>> from fgutils import FGQuery
>>> 
>>> smiles = "O=C(C)Oc1ccccc1C(=O)O" # acetylsalicylic acid
>>> query = FGQuery()
>>> query.get(smiles)
[('ester', [0, 1, 3]), ('carboxylic_acid', [10, 11, 12])]
```

The output is a list of tuples containing the functional group name and the
corresponding atom indices.

## Acknowledgment
This project has received funding from the European Unions Horizon Europe Doctoral Network programme under the Marie-Skłodowska-Curie grant agreement No 101072930 (TACsy -- Training Alliance for Computational)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fgutils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Klaus Weinbauer <klaus@bioinf.uni-leipzig.de>",
    "download_url": "https://files.pythonhosted.org/packages/35/7b/40bd396ec01318a1d79acca0980bd555617b83717f3fdc64ef0d1fef6e6e/fgutils-0.2.0.tar.gz",
    "platform": null,
    "description": "FGUtils is a collection of utility functions for querying functional groups in\nmolecules from their molecular graph representation.\n\n## Dependencies\n- Python (>= 3.11)\n- numpy (>= 1.26.4)\n- networkx (>= 3.2.1)\n- rdkit (>= 2023.09.4 optional)\n\nAdditional module dependencies.\n| Module | Dependency |\n| ------ | ---------- |\n| fgutils.torch | [torch](https://pypi.org/project/torch/)>=2.5 |\n\n## Installation\nYou can install [FGUtils](https://pypi.org/project/fgutils/) using pip.\n```\npip install fgutils\n```\n\n## Getting Started\nFor a comprehensive description of FGUtils features read through the\n[documentation](https://klausweinbauer.github.io/FGUtils/). However, querying\nthe functional groups for a molecule like acetylsalicylic acid is as simple as\nrunning the following:\n```\n>>> from fgutils import FGQuery\n>>> \n>>> smiles = \"O=C(C)Oc1ccccc1C(=O)O\" # acetylsalicylic acid\n>>> query = FGQuery()\n>>> query.get(smiles)\n[('ester', [0, 1, 3]), ('carboxylic_acid', [10, 11, 12])]\n```\n\nThe output is a list of tuples containing the functional group name and the\ncorresponding atom indices.\n\n## Acknowledgment\nThis project has received funding from the European Unions Horizon Europe Doctoral Network programme under the Marie-Sk\u0142odowska-Curie grant agreement No 101072930 (TACsy -- Training Alliance for Computational)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Library to get functional groups from molecular graphs.",
    "version": "0.2.0",
    "project_urls": {
        "homepage": "https://github.com/klausweinbauer/FGUtils",
        "issues": "https://github.com/klausweinbauer/FGUtils/issues",
        "source": "https://github.com/klausweinbauer/FGUtils"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7ac8df76e24e2f8075546687481a05daec46c4685072a6648a3e5505b91cb4f5",
                "md5": "34e9eca15d5f89813dd55b12827ab327",
                "sha256": "567c122fd11f5d65e649124f6dd4dff72734eb6b4ac1268b725a6f49b9e7f9b1"
            },
            "downloads": -1,
            "filename": "fgutils-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "34e9eca15d5f89813dd55b12827ab327",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 45931,
            "upload_time": "2025-02-03T06:48:37",
            "upload_time_iso_8601": "2025-02-03T06:48:37.424108Z",
            "url": "https://files.pythonhosted.org/packages/7a/c8/df76e24e2f8075546687481a05daec46c4685072a6648a3e5505b91cb4f5/fgutils-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "357b40bd396ec01318a1d79acca0980bd555617b83717f3fdc64ef0d1fef6e6e",
                "md5": "5f89a808003975f48a2b9c608180848c",
                "sha256": "50f5f495d06416fcea3505984ee7c0115b989a07519aa4c4cab9c10d328298be"
            },
            "downloads": -1,
            "filename": "fgutils-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "5f89a808003975f48a2b9c608180848c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 3208316,
            "upload_time": "2025-02-03T06:48:39",
            "upload_time_iso_8601": "2025-02-03T06:48:39.933648Z",
            "url": "https://files.pythonhosted.org/packages/35/7b/40bd396ec01318a1d79acca0980bd555617b83717f3fdc64ef0d1fef6e6e/fgutils-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-03 06:48:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "klausweinbauer",
    "github_project": "FGUtils",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "numpy",
            "specs": [
                [
                    "<",
                    "2.0.0"
                ],
                [
                    ">=",
                    "1.26.3"
                ]
            ]
        },
        {
            "name": "networkx",
            "specs": [
                [
                    ">=",
                    "3.2"
                ]
            ]
        },
        {
            "name": "rdkit",
            "specs": [
                [
                    ">=",
                    "2023.9.4"
                ]
            ]
        },
        {
            "name": "torch",
            "specs": [
                [
                    ">=",
                    "2.5"
                ]
            ]
        },
        {
            "name": "torch_geometric",
            "specs": [
                [
                    ">=",
                    "2.6"
                ]
            ]
        }
    ],
    "lcname": "fgutils"
}
        
Elapsed time: 2.30484s