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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file chic_lib-0.1.18.tar.gz.

File metadata

  • Download URL: chic_lib-0.1.18.tar.gz
  • Upload date:
  • Size: 106.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.15

File hashes

Hashes for chic_lib-0.1.18.tar.gz
Algorithm Hash digest
SHA256 994afadbe0f0ae140e137053933ec82081bde03cbc83ae554494e676b6399aa2
MD5 e30abb52b000eb2ce0be7a49a670f3b8
BLAKE2b-256 fd99537d81f89554343a187512f25d163bae02b46bd0daf8f1449eeafdebe3cd

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for chic_lib-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 5a6410d42a0c12f77bd000907e5f48b92095d6ca9b8d2e62f0134f725e4f573c
MD5 1e55c3f6d12f654921dca40235a24279
BLAKE2b-256 99f30798773d9dd25c8ca3b28649a5957678c33813ea1c483d2888e586f83930

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