Skip to main content

Partial Atomic Charges for Porous Materials based on Graph Convolutional Neural Network (PACMAN)

Project description

PACMAN

A Partial Atomic Charge Predicter for Porous Materials based on Graph Convolutional Neural Network (PACMAN)

Requires Python 3.9 Zenodo MIT Gmail Linux Windows

Usage

from PACMANCharge import pmcharge
pmcharge.predict(cif_file="./test/Cu-BTC.cif",charge_type="DDEC6",digits=6,atom_type=True,neutral=True,keep_connect=True)
pmcharge.Energy(cif_file="./test/Cu-BTC.cif")
  • cif_file: cif file (without partial atomic charges) [cif path]
  • charge-type (default: DDE6): DDEC6, Bader, CM5 or REPEAT
  • digits (default: 6): number of decimal places to print for partial atomic charges. ML models were trained on a 6-digit dataset.
  • atom-type (default: True): keep the same partial atomic charge for the same atom types (based on the similarity of partial atomic charges up to 2 decimal places).
  • neutral (default: True): keep the net charge is zero. We use "mean" method to neuralize the system where the excess charges are equally distributed across all atoms.
  • keep_connect (default: True): retain the atomic and connection information (such as _atom_site_adp_type, bond) for the structure.

Website & Zenodo

PACMAN-APPlink
github repositorylink
DOWNLOAD full code and datasetlink But we will not update new vesion in Zenodo.

Reference

If you use PACMAN Charge, please cite this paper:

@article{       doi : 10.1021/acs.jctc.4c00434 ,
                author = {Zhao, Guobin and Chung, Yongchul G.},
                title = {PACMAN: A Robust Partial Atomic Charge Predicter for Nanoporous Materials Based on Crystal Graph Convolution Networks},
                journal = {Journal of Chemical Theory and Computation},
                volume = {20},
                number = {12},
                pages = {5368-5380},
                year = {2024},
                doi = {10.1021/acs.jctc.4c00434},
                note ={PMID: 38822793},
                URL = {https://doi.org/10.1021/acs.jctc.4c00434},
                eprint = {https://doi.org/10.1021/acs.jctc.4c00434}
        }

Bugs

If you encounter any problem during using PACMAN, please email sxmzhaogb@gmail.com.

Group: Molecular Thermodynamics & Advance Processes Laboratory

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PACMAN-charge-1.3.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

PACMAN_charge-1.3-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

Details for the file PACMAN-charge-1.3.tar.gz.

File metadata

  • Download URL: PACMAN-charge-1.3.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for PACMAN-charge-1.3.tar.gz
Algorithm Hash digest
SHA256 491db9d17ceca83de2d69df7f73e9128850ef1a8613a94dda153dd712901fd87
MD5 d89c3c10380501d4199ab2781a4b64e4
BLAKE2b-256 324e024ec1ea82cac221f17e0b7c7c51d507024f7a49957b8bee28335baa30c5

See more details on using hashes here.

Provenance

File details

Details for the file PACMAN_charge-1.3-py3-none-any.whl.

File metadata

  • Download URL: PACMAN_charge-1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for PACMAN_charge-1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6a0e406e8a1947e67cad5f2034568276b9f650241df7df2cc4c660c7a834a5a9
MD5 aab9aebec16a149c9cc236e3d3ffb3e4
BLAKE2b-256 172ef2b7c16565711b0bf8752bf2ad233f5b72a80a9c28fc02a97d65a671aecb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page