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

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.1.tar.gz (12.3 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.1-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pacman_charge-1.4.1.tar.gz
Algorithm Hash digest
SHA256 be7d08723d284b33eb5f8844aa83f2b337e9c225990e3e981fe0f365c3af6f4d
MD5 ecb4f1eb92e8cafaf05724dcd7bbf4c0
BLAKE2b-256 534ccd262c54613be427258146da1a3352e5d14eead67a1f52b7f41cb58746f8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pacman_charge-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f9dd0dd90f6a5a0b9b00a12cd7ccd0ad3ff93ec8a2011e906010f15b2d915b8
MD5 0e1843ddf8421a3ad2009f0ae4e4d009
BLAKE2b-256 be948b67f49cbf2fc6596590a11c6f0acd55e91ffa35300d5077e0f545ab1dea

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