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)

PACMAN charge logo

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

Reference

@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.

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.4.2.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pacman_charge-1.4.2-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file pacman_charge-1.4.2.tar.gz.

File metadata

  • Download URL: pacman_charge-1.4.2.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for pacman_charge-1.4.2.tar.gz
Algorithm Hash digest
SHA256 7e7965a326cb22232e8099f3aad81f2412fd3bcd94f41df293d7afc231db1c1b
MD5 02f963b666e1ca2c2127f542b0707795
BLAKE2b-256 586ce182b693793f24255ec311fb6617db6b9a145ff55024f35982ce64e86f08

See more details on using hashes here.

File details

Details for the file pacman_charge-1.4.2-py3-none-any.whl.

File metadata

  • Download URL: pacman_charge-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for pacman_charge-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 85cb6d1dc0b4c0186a61d84c72b265555ae2e31ae0f638dd71ea515516d1f93e
MD5 4e9aa375a4785e37276729a67cdff347
BLAKE2b-256 1174e09e1879d55a698d8700aebbe7d8e10587ea93f7efd0889780be78cedb64

See more details on using hashes here.

Supported by

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