Skip to main content

Coarse-grainig hybrid and inorganic crystals (CHIC)

Project description

CHIC logo

Coarse-graining Hybrid Inorganic Crystals.

Getting started

Install with pip install chic-lib, and you're ready to go!

By way of a quick example, ZIF-8 (CSD RefCode: FAWCEN) can be coarse-grained by running:

from chic import Structure

# read in structure and delete oxygen from the pores.
struct = Structure.from_cif("ZIF-8-sod.cif")
struct.remove_sites_by_symbol("O")

# compute neighbour list, find atomic clusters, and coarse-grain. 
struct.get_neighbours_crystalnn()
struct.find_atomic_clusters()
struct.get_coarse_grained_net()

# export structure as TopoCIF.
struct.net_to_cif('ZIF-8-sod-cg.cif', write_bonds=True, name='ZIF-8-cg')

Head over to the chic docs to see examples and more details!

ToDo list

  • Add docs.
  • Add simple distance cut-off algorithm for neighbour list building.
  • Add custom implementation of optimised CrystalNN algorithm.
  • Integrate back-mapping code.
  • Integrate extraction of local energies from LAMMPS dump format.
  • Add registry to Net class for easier future development beyond ZIFs.

Authors

Thomas C. Nicholas

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

chic-lib-0.1.17.tar.gz (106.7 kB view details)

Uploaded Source

Built Distribution

chic_lib-0.1.17-py3-none-any.whl (100.8 kB view details)

Uploaded Python 3

File details

Details for the file chic-lib-0.1.17.tar.gz.

File metadata

  • Download URL: chic-lib-0.1.17.tar.gz
  • Upload date:
  • Size: 106.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.17

File hashes

Hashes for chic-lib-0.1.17.tar.gz
Algorithm Hash digest
SHA256 0a5b5a52784f9e29037657fc39c5edc2614cf726a3484a3a81bad30777fe712d
MD5 30beba711520b2d315c4a90a29f05a3a
BLAKE2b-256 7a3288c5249058902959385585d164c4ce745d0f959f4b3ac9637ad854246539

See more details on using hashes here.

File details

Details for the file chic_lib-0.1.17-py3-none-any.whl.

File metadata

  • Download URL: chic_lib-0.1.17-py3-none-any.whl
  • Upload date:
  • Size: 100.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.17

File hashes

Hashes for chic_lib-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 0864817f39db6174fe41ee8a31c21c6469dc3bbf61d4a0b3af0a47ab331dd5e5
MD5 06eb0da92fe97dce34847f84298a3b4e
BLAKE2b-256 667cda9d5644339da24fa712a603a071fb60f4fc47a4c494b698527ec641a8c8

See more details on using hashes here.

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