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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: chic_lib-0.1.19.tar.gz
  • Upload date:
  • Size: 107.0 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.19.tar.gz
Algorithm Hash digest
SHA256 715a990588b30e416fe86210c436c2daca260349aeb66d97c591f76e565ac8f9
MD5 61d75ef3342d3833856483bbb88a97cd
BLAKE2b-256 02c257e157d1bf85fdf3230641fe6857477a5d3720db29deb67b94ad3482a5f8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chic_lib-0.1.19-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.19-py3-none-any.whl
Algorithm Hash digest
SHA256 0d7c1fda76db2a3d3ae120ebca6373bea8a619e083bc1ffe86b0016462c57c64
MD5 dafa2bc873b8aac689337462b179b81c
BLAKE2b-256 b7d9a2e73385215bd6e0d44fc3276f27dcf2e70c3fe252fb875889cadfbb9907

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