Skip to main content

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

Metadata

Release files for chic-lib 0.1.19

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chic-lib 0.1.19
File Size Uploaded
chic_lib-0.1.19.tar.gz 107.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for chic-lib 0.1.19
File Interpreter ABI Platform
chic_lib-0.1.19-py3-none-any.whl Python 3 none any Details

Total release size: 207.8 kB

Release files / chic_lib-0.1.19.tar.gz

Download URL chic_lib-0.1.19.tar.gz
Size 107.0 kB
Tags Source
SHA-256 checksum
How to use checksums
715a990588b30e416fe86210c436c2daca260349aeb66d97c591f76e565ac8f9
BLAKE2b-256 checksum
How to use checksums
02c257e157d1bf85fdf3230641fe6857477a5d3720db29deb67b94ad3482a5f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.15

Release files / chic_lib-0.1.19-py3-none-any.whl

Download URL chic_lib-0.1.19-py3-none-any.whl
Size 100.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0d7c1fda76db2a3d3ae120ebca6373bea8a619e083bc1ffe86b0016462c57c64
BLAKE2b-256 checksum
How to use checksums
b7d9a2e73385215bd6e0d44fc3276f27dcf2e70c3fe252fb875889cadfbb9907
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.15

Release history Release notifications | RSS feed

This release

0.1.19 This release

2 release files

0.1.18

2 release files

0.1.17

2 release files

0.1.16

2 release files

0.1.15

2 release files

0.1.14

2 release files

0.1.13

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page