# GlyCONFORMER
**GlyCONFORMERS** is a Python package that assigns labels to glycan conformers, based on their torsion angle values, in order to differentiate various 3D-structures of one single glycan. It enables the automated assignment of the GlyCONFORMER string that was introduced in:
**Grothaus et al. 2022, Exploration, Representation, and Rationalization of the Conformational Phase Space of N-Glycans, J. Chem. Inf. Model. 2022, 62, 20, 4992–5008** https://pubs.acs.org/doi/full/10.1021/acs.jcim.2c01049 for N-glycans.
Check the paper or tutorial for a detailed explanation of the GlyCONFORMER string generation. The workflow is not exclusivly designed for N-glycans, but can also be applyied to any other glycan type there is.
## Installation
To use GlyCONFORMER, first install it using pip:
$ pip install GlyCONFORMER
## Tutorial
The tutorial juypter notebook should be run from within the GlyCONFORMER package folder or you have to change the path directing to the TUTORIAL folder.
The tutorial includes different N-glycan types and different complexity levels of how to obtain a GlyCONFORMER label string for custom glycan types and their recorded torsion angle values. The minimum example is given by the high-mannose type N-glycan M5, where only the file **M5_angles.dat** with torsion angle values is used as input:
It is used by the glyconformer package, whereas remaining necessary information are read from the LIBRARY_GLYCANS folder by specifying the **glycantype = "M5**":
```
conformer = glyconformer(inputfile = "TUTORIAL/M5_example/M5_angles.dat", glycantype = "M5")
```
When executing the run command:
```
binary, population = conformer.run()
```
a **binary** dataframe is produced, where the torsion angles have been converted to letters corresponding to their values and associate them to a certain minima of the free energy profile along that torsion angle.
Additionally, the occurance of each conformer string is counted and outputted to the **population** dataframe:
The obtained information can also be used to plot a histogram, displaying the conformer distribution by:
```
conformer.plot()
```
Conformer labels are given on the x-axis and deviations from the most populated conformer indicated by explicit letters, where dots are used when no change in that torsion angle could be detected.
For more elaborate examples and a detailed explanation of how free energy profiles of each torsion angle are classified, check out the **Tutorial_GlyCONFORMER.ipynb** notebook.
## Documentation
See documentation https://glyconformer.readthedocs.io/en/latest/index.html
Raw data
{
"_id": null,
"home_page": "https://github.com/IsabellGrothaus/GlyCONFORMER",
"name": "GlyCONFORMER",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "glycan,conformer,classification,sugar,carbohydrates",
"author": "Isabell Grothaus",
"author_email": "grothaus@uni-bremen.de",
"download_url": "https://files.pythonhosted.org/packages/32/9d/d0c0ada7139159980431f0c9c640945373bc26d0717ce88108acc37f1813/GlyCONFORMER-1.0.0.tar.gz",
"platform": null,
"description": "# GlyCONFORMER\n\n**GlyCONFORMERS** is a Python package that assigns labels to glycan conformers, based on their torsion angle values, in order to differentiate various 3D-structures of one single glycan. It enables the automated assignment of the GlyCONFORMER string that was introduced in:\n\n **Grothaus et al. 2022, Exploration, Representation, and Rationalization of the Conformational Phase Space of N-Glycans, J. Chem. Inf. Model. 2022, 62, 20, 4992\u20135008** https://pubs.acs.org/doi/full/10.1021/acs.jcim.2c01049 for N-glycans. \n\n\n\nCheck the paper or tutorial for a detailed explanation of the GlyCONFORMER string generation. The workflow is not exclusivly designed for N-glycans, but can also be applyied to any other glycan type there is. \n\n## Installation\n\nTo use GlyCONFORMER, first install it using pip:\n\n$ pip install GlyCONFORMER\n \n## Tutorial\n\nThe tutorial juypter notebook should be run from within the GlyCONFORMER package folder or you have to change the path directing to the TUTORIAL folder.\n\nThe tutorial includes different N-glycan types and different complexity levels of how to obtain a GlyCONFORMER label string for custom glycan types and their recorded torsion angle values. The minimum example is given by the high-mannose type N-glycan M5, where only the file **M5_angles.dat** with torsion angle values is used as input:\n\n\n\nIt is used by the glyconformer package, whereas remaining necessary information are read from the LIBRARY_GLYCANS folder by specifying the **glycantype = \"M5**\": \n\n```\nconformer = glyconformer(inputfile = \"TUTORIAL/M5_example/M5_angles.dat\", glycantype = \"M5\")\n```\n\nWhen executing the run command:\n\n```\nbinary, population = conformer.run()\n```\n\na **binary** dataframe is produced, where the torsion angles have been converted to letters corresponding to their values and associate them to a certain minima of the free energy profile along that torsion angle. \n\n\n\nAdditionally, the occurance of each conformer string is counted and outputted to the **population** dataframe:\n\n\n\nThe obtained information can also be used to plot a histogram, displaying the conformer distribution by:\n\n``` \nconformer.plot()\n```\n\nConformer labels are given on the x-axis and deviations from the most populated conformer indicated by explicit letters, where dots are used when no change in that torsion angle could be detected. \n\n\n\nFor more elaborate examples and a detailed explanation of how free energy profiles of each torsion angle are classified, check out the **Tutorial_GlyCONFORMER.ipynb** notebook. \n\n## Documentation\n\nSee documentation https://glyconformer.readthedocs.io/en/latest/index.html\n",
"bugtrack_url": null,
"license": "GPL-3.0 license",
"summary": "GlyCONFORMERS is a Python package that assigns conformer strings to N-glycan conformers, based on their torsion angle values.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/IsabellGrothaus/GlyCONFORMER"
},
"split_keywords": [
"glycan",
"conformer",
"classification",
"sugar",
"carbohydrates"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5e1588dfe7d5f27f500796948b6aad57e1e8385d3250776c5fb74615e936bf01",
"md5": "dcd22196830cbd7ba259fc31725733a4",
"sha256": "96d7f887c90abf7fd5963e7095effb1047d6879e9f9485398d88b3f945239181"
},
"downloads": -1,
"filename": "GlyCONFORMER-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dcd22196830cbd7ba259fc31725733a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 140238,
"upload_time": "2023-06-14T09:47:12",
"upload_time_iso_8601": "2023-06-14T09:47:12.172188Z",
"url": "https://files.pythonhosted.org/packages/5e/15/88dfe7d5f27f500796948b6aad57e1e8385d3250776c5fb74615e936bf01/GlyCONFORMER-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "329dd0c0ada7139159980431f0c9c640945373bc26d0717ce88108acc37f1813",
"md5": "f988f70a704f934f772c89ffdfa40719",
"sha256": "e42fbd04ef170076a237b43a00b2c3891034583949a3f2dc3f7537a432e153cf"
},
"downloads": -1,
"filename": "GlyCONFORMER-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f988f70a704f934f772c89ffdfa40719",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 98019,
"upload_time": "2023-06-14T09:47:13",
"upload_time_iso_8601": "2023-06-14T09:47:13.983372Z",
"url": "https://files.pythonhosted.org/packages/32/9d/d0c0ada7139159980431f0c9c640945373bc26d0717ce88108acc37f1813/GlyCONFORMER-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-14 09:47:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IsabellGrothaus",
"github_project": "GlyCONFORMER",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "glyconformer"
}
JSON
