[](https://github.com/kmlefran/subproptools/actions/workflows/ci.yml)
[](https://subproptools.readthedocs.io/en/latest/?badge=latest)
[](https://coveralls.io/github/kmlefran/subproptools?branch=main)
[](https://badge.fury.io/py/subproptools)
# Molecule Reorientation and .sum file handling
This package provides tools to extract data from .sum files (in the qtaimExtract module), and tools to reorient the molecule to defined coordinate systems (in the subreor module). The subreor module rotates to a defined coordinate system. First an atom is positioned at the origin. By convention, this is the atom of the group that is directly bonded to the rest of the molecule. The rest of the molecule is placed along the -x axis. The remaining axes are defined as follows:
* if there is one lone pair(VSCC), that point lies on the +y
* if there are two lone pairs, the average position of them lies on the +y
* if there are no lone pairs, map the BCPs of the atom at the origin to a reference. Identify the closest match to the reference to determine a BCP to set as +y
# Authors
Kevin Lefrancois-Gagnon
Robert C. Mawhinney
# Installation prior to distribution
```
pip install git+https://github.com/kmlefran/subproptools
```
# User Facing Functions:
## subreor
* rotate_sheet - performs rotations to the desired coordinate system for many molecules as defined in a csv file
* output_to_gjf - writes the reoreinted geometry to a .gjf file
* rotate_substituent - performs the defined rotation for an individual substituent
## qtaimExtract
* get_sub_di - gets delocalization index between a substituent and the rest of the molecule
* get bcp_properties - returns a dictionary of bcp properties for a given bcp
* get_atomic_props - returns dictionary of atomic properties for all atoms in molecule
* get_cc_props - returns dictionary of properties for all charge concentrations
* identify_vscc - returns only the VSCC from a set of charge concentrations
* get_sub_props - returns dictionary of one substituent's properties
* extract_sub_props - returns dictionary of atomic, group, bcp and vscc properties for a substituent
* sub_prop_frame - returns dictioanry of frames of group properties
* get_xyz - extracts a molecule's xyz geometry from sum file
Raw data
{
"_id": null,
"home_page": null,
"name": "subproptools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "qtaim, functional groups",
"author": null,
"author_email": "Kevin Lefrancois-Gagnon <kgagnon@lakeheadu.ca>, Robert Mawhinney <mawhinn@lakeheadu.ca>",
"download_url": "https://files.pythonhosted.org/packages/2b/32/5f02fd5e29f5c3ce84a34ae2bc05326cf39641556f4b40f5dbf0a022700e/subproptools-0.4.3.tar.gz",
"platform": null,
"description": "\n[](https://github.com/kmlefran/subproptools/actions/workflows/ci.yml)\n[](https://subproptools.readthedocs.io/en/latest/?badge=latest)\n[](https://coveralls.io/github/kmlefran/subproptools?branch=main)\n[](https://badge.fury.io/py/subproptools)\n# Molecule Reorientation and .sum file handling\n\nThis package provides tools to extract data from .sum files (in the qtaimExtract module), and tools to reorient the molecule to defined coordinate systems (in the subreor module). The subreor module rotates to a defined coordinate system. First an atom is positioned at the origin. By convention, this is the atom of the group that is directly bonded to the rest of the molecule. The rest of the molecule is placed along the -x axis. The remaining axes are defined as follows:\n* if there is one lone pair(VSCC), that point lies on the +y\n* if there are two lone pairs, the average position of them lies on the +y\n* if there are no lone pairs, map the BCPs of the atom at the origin to a reference. Identify the closest match to the reference to determine a BCP to set as +y\n\n# Authors\nKevin Lefrancois-Gagnon\nRobert C. Mawhinney\n\n# Installation prior to distribution\n```\npip install git+https://github.com/kmlefran/subproptools\n```\n\n# User Facing Functions:\n## subreor\n* rotate_sheet - performs rotations to the desired coordinate system for many molecules as defined in a csv file\n* output_to_gjf - writes the reoreinted geometry to a .gjf file\n* rotate_substituent - performs the defined rotation for an individual substituent\n\n## qtaimExtract\n* get_sub_di - gets delocalization index between a substituent and the rest of the molecule\n* get bcp_properties - returns a dictionary of bcp properties for a given bcp\n* get_atomic_props - returns dictionary of atomic properties for all atoms in molecule\n* get_cc_props - returns dictionary of properties for all charge concentrations\n* identify_vscc - returns only the VSCC from a set of charge concentrations\n* get_sub_props - returns dictionary of one substituent's properties\n* extract_sub_props - returns dictionary of atomic, group, bcp and vscc properties for a substituent\n* sub_prop_frame - returns dictioanry of frames of group properties\n* get_xyz - extracts a molecule's xyz geometry from sum file\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A plugin for extracting data from .sum files and manipuating them",
"version": "0.4.3",
"project_urls": {
"Source": "https://github.com/kmlefran/subproptools"
},
"split_keywords": [
"qtaim",
" functional groups"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac46e6c84f80ae88a48555928bba3976208cb136b4d04f64728265c5441449e1",
"md5": "d74f6235bd41b685d4462551e7919bb0",
"sha256": "7f1d20c45216ae5a083f60cc30a88efbc01fe67b759e116d2dcaa50ca6c4bdc8"
},
"downloads": -1,
"filename": "subproptools-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d74f6235bd41b685d4462551e7919bb0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 28053,
"upload_time": "2024-05-03T19:48:28",
"upload_time_iso_8601": "2024-05-03T19:48:28.029540Z",
"url": "https://files.pythonhosted.org/packages/ac/46/e6c84f80ae88a48555928bba3976208cb136b4d04f64728265c5441449e1/subproptools-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b325f02fd5e29f5c3ce84a34ae2bc05326cf39641556f4b40f5dbf0a022700e",
"md5": "b16c658fad8e5771b81f6277dfa97169",
"sha256": "29c7c62b47e287100ddf8c1e84825e9d16d0100d57ec9619fdd1da2e9c759ef0"
},
"downloads": -1,
"filename": "subproptools-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "b16c658fad8e5771b81f6277dfa97169",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 28292,
"upload_time": "2024-05-03T19:48:29",
"upload_time_iso_8601": "2024-05-03T19:48:29.501733Z",
"url": "https://files.pythonhosted.org/packages/2b/32/5f02fd5e29f5c3ce84a34ae2bc05326cf39641556f4b40f5dbf0a022700e/subproptools-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 19:48:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kmlefran",
"github_project": "subproptools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
}
],
"lcname": "subproptools"
}
JSON
