xyz2graph


Namexyz2graph JSON
Version 3.5.0 PyPI version JSON
download
home_pageNone
SummaryPackage for reading of .xyz files and constructing of molecular graphs from atomic coordinates.
upload_time2025-02-27 16:01:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseISC License Copyright (c) 2018 Mykola Zotko Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
keywords chemistry molecular-graphs visualization xyz-files
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # xyz2graph

[![PyPI version](https://img.shields.io/pypi/v/xyz2graph.svg)](https://pypi.org/project/xyz2graph/)
[![Python Version](https://img.shields.io/pypi/pyversions/xyz2graph.svg)](https://pypi.org/project/xyz2graph/)
[![License](https://img.shields.io/github/license/zotko/xyz2graph.svg)](https://github.com/zotko/xyz2graph/blob/master/LICENSE)
[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue)](https://zotko.github.io/xyz2graph)
[![DOI](https://zenodo.org/badge/144382005.svg)](https://doi.org/10.5281/zenodo.14569337)

[![PyPI Downloads](https://static.pepy.tech/badge/xyz2graph/month)](https://pepy.tech/projects/xyz2graph)
[![GitHub Stars](https://img.shields.io/github/stars/zotko/xyz2graph)](https://github.com/zotko/xyz2graph/stargazers)
[![GitHub Forks](https://img.shields.io/github/forks/zotko/xyz2graph)](https://github.com/zotko/xyz2graph/network/members)

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)

A Python package to convert XYZ molecular files into NetworkX graphs with interactive 3D visualization using Plotly.

<a href="https://zotko.github.io/xyz2graph/demo" target="_blank">Try it live 🚀</a>

## Features

- Interactive 3D molecular visualization using Plotly
- NetworkX graph conversion for analysis
- Command-line interface

## Installation

```bash
pip install xyz2graph
```

## Requirements

- Python 3.8+
- Dependencies: NumPy, Plotly, NetworkX

## Quick Start

```python
from xyz2graph import MolGraph

# Create molecular graph and read XYZ file
mg = MolGraph()
mg.read_xyz('molecule.xyz')

# Convert to NetworkX graph
G = mg.to_networkx()

# Generate interactive 3D visualization
fig = mg.to_plotly()
fig.show()
```

## Command Line

```bash
# Save visualization as HTML
xyz2graph molecule.xyz

# Specify output file
xyz2graph molecule.xyz --output viz.html

# Open directly in browser
xyz2graph molecule.xyz --browser
```

## Documentation

Read the [documentation](https://zotko.github.io/xyz2graph) for guides, API reference, and examples.

## Help & Discussion

🪲 [Report a bug](https://github.com/zotko/xyz2graph/issues)  
✨ [Request a feature](https://github.com/zotko/xyz2graph/discussions)

## Contributing

Contributions are welcome! Please see the [Contributing Guide](https://github.com/zotko/xyz2graph/tree/main/CONTRIBUTING.md) for guidelines.

## Citation

If you use xyz2graph in your research, please cite:

```bibtex
@misc{zotko2018xyz2graph,
  author       = {Zotko, Mykola},
  title        = {xyz2graph: Molecular Structure Visualization},
  year         = {2018},
  publisher    = {GitHub},
  url          = {https://github.com/zotko/xyz2graph}
}
```

<p align="center">
  <a href="https://www.buymeacoffee.com/mykola_zotko">
    <img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee">
  </a>
</p>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "xyz2graph",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "chemistry, molecular-graphs, visualization, xyz-files",
    "author": null,
    "author_email": "Mykola Zotko <dev.zotko@outlook.de>",
    "download_url": "https://files.pythonhosted.org/packages/a0/29/643b099df2e290ea3ef9aec1f8a1b9949d72547527a93d46549d730067d7/xyz2graph-3.5.0.tar.gz",
    "platform": null,
    "description": "# xyz2graph\n\n[![PyPI version](https://img.shields.io/pypi/v/xyz2graph.svg)](https://pypi.org/project/xyz2graph/)\n[![Python Version](https://img.shields.io/pypi/pyversions/xyz2graph.svg)](https://pypi.org/project/xyz2graph/)\n[![License](https://img.shields.io/github/license/zotko/xyz2graph.svg)](https://github.com/zotko/xyz2graph/blob/master/LICENSE)\n[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue)](https://zotko.github.io/xyz2graph)\n[![DOI](https://zenodo.org/badge/144382005.svg)](https://doi.org/10.5281/zenodo.14569337)\n\n[![PyPI Downloads](https://static.pepy.tech/badge/xyz2graph/month)](https://pepy.tech/projects/xyz2graph)\n[![GitHub Stars](https://img.shields.io/github/stars/zotko/xyz2graph)](https://github.com/zotko/xyz2graph/stargazers)\n[![GitHub Forks](https://img.shields.io/github/forks/zotko/xyz2graph)](https://github.com/zotko/xyz2graph/network/members)\n\n[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)\n\nA Python package to convert XYZ molecular files into NetworkX graphs with interactive 3D visualization using Plotly.\n\n<a href=\"https://zotko.github.io/xyz2graph/demo\" target=\"_blank\">Try it live \ud83d\ude80</a>\n\n## Features\n\n- Interactive 3D molecular visualization using Plotly\n- NetworkX graph conversion for analysis\n- Command-line interface\n\n## Installation\n\n```bash\npip install xyz2graph\n```\n\n## Requirements\n\n- Python 3.8+\n- Dependencies: NumPy, Plotly, NetworkX\n\n## Quick Start\n\n```python\nfrom xyz2graph import MolGraph\n\n# Create molecular graph and read XYZ file\nmg = MolGraph()\nmg.read_xyz('molecule.xyz')\n\n# Convert to NetworkX graph\nG = mg.to_networkx()\n\n# Generate interactive 3D visualization\nfig = mg.to_plotly()\nfig.show()\n```\n\n## Command Line\n\n```bash\n# Save visualization as HTML\nxyz2graph molecule.xyz\n\n# Specify output file\nxyz2graph molecule.xyz --output viz.html\n\n# Open directly in browser\nxyz2graph molecule.xyz --browser\n```\n\n## Documentation\n\nRead the [documentation](https://zotko.github.io/xyz2graph) for guides, API reference, and examples.\n\n## Help & Discussion\n\n\ud83e\udeb2 [Report a bug](https://github.com/zotko/xyz2graph/issues)  \n\u2728 [Request a feature](https://github.com/zotko/xyz2graph/discussions)\n\n## Contributing\n\nContributions are welcome! Please see the [Contributing Guide](https://github.com/zotko/xyz2graph/tree/main/CONTRIBUTING.md) for guidelines.\n\n## Citation\n\nIf you use xyz2graph in your research, please cite:\n\n```bibtex\n@misc{zotko2018xyz2graph,\n  author       = {Zotko, Mykola},\n  title        = {xyz2graph: Molecular Structure Visualization},\n  year         = {2018},\n  publisher    = {GitHub},\n  url          = {https://github.com/zotko/xyz2graph}\n}\n```\n\n<p align=\"center\">\n  <a href=\"https://www.buymeacoffee.com/mykola_zotko\">\n    <img src=\"https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png\" alt=\"Buy Me A Coffee\">\n  </a>\n</p>\n",
    "bugtrack_url": null,
    "license": "ISC License\n        \n        Copyright (c) 2018 Mykola Zotko\n        \n        Permission to use, copy, modify, and/or distribute this software for any\n        purpose with or without fee is hereby granted, provided that the above\n        copyright notice and this permission notice appear in all copies.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\n        REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\n        AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\n        INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\n        LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\n        OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\n        PERFORMANCE OF THIS SOFTWARE.",
    "summary": "Package for reading of .xyz files and constructing of molecular graphs from atomic coordinates.",
    "version": "3.5.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/zotko/xyz2graph/issues",
        "Documentation": "https://zotko.github.io/xyz2graph",
        "Homepage": "https://github.com/zotko/xyz2graph",
        "Repository": "https://github.com/zotko/xyz2graph"
    },
    "split_keywords": [
        "chemistry",
        " molecular-graphs",
        " visualization",
        " xyz-files"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0d67663be8a430236476ab9533e79297a53dc9508f7114f7c51b20db5f045324",
                "md5": "321fadfd441cf39f56af89498d99e410",
                "sha256": "a576f9994df1a7526a384fe74464b5908323672bf8f40a92bf03abf03797058d"
            },
            "downloads": -1,
            "filename": "xyz2graph-3.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "321fadfd441cf39f56af89498d99e410",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 21960,
            "upload_time": "2025-02-27T16:01:13",
            "upload_time_iso_8601": "2025-02-27T16:01:13.187346Z",
            "url": "https://files.pythonhosted.org/packages/0d/67/663be8a430236476ab9533e79297a53dc9508f7114f7c51b20db5f045324/xyz2graph-3.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a029643b099df2e290ea3ef9aec1f8a1b9949d72547527a93d46549d730067d7",
                "md5": "704a6ba38d27b7778897636633374d18",
                "sha256": "ae2645edcf420881408bf583af99b0783cd01c9f60fdf49583cbdb175621cd00"
            },
            "downloads": -1,
            "filename": "xyz2graph-3.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "704a6ba38d27b7778897636633374d18",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 1360222,
            "upload_time": "2025-02-27T16:01:14",
            "upload_time_iso_8601": "2025-02-27T16:01:14.678181Z",
            "url": "https://files.pythonhosted.org/packages/a0/29/643b099df2e290ea3ef9aec1f8a1b9949d72547527a93d46549d730067d7/xyz2graph-3.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-27 16:01:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zotko",
    "github_project": "xyz2graph",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "xyz2graph"
}
        
Elapsed time: 1.25217s