PUCHIK 1.1.2

Description:

PUCHIK 1.1.2

PUCHIK
Overview
Python Utility for Characterizing Heterogeneous Interfaces and Kinetics (PUCHIK), is a tool for analyzing molecular dynamics trajectories. It allows constructing an interface between two phases, enabling to calculate intrinsic density profiles, volumes, etc.
The interface construction works for spherical and rod-like nanoparticles equally well, making it a great tool to work with nanoparticles of almost every shape.
This package is built on top of MDAnalysis, SciPy, NumPy and PyGEL3D libraries.

Installation
You can install the PUCHIK package using pip:
pip install PUCHIK

Usage
The main class in this package is the "Interface" class. To set up a mesh, import it from PUCHIK:
from PUCHIK import Interface

You should provide it with a topology and optionally a trajectory files. PUCHIK uses MDAnalysis Readers to open a trajectory. You can find the supported formats here.
trj = '<path_to_trajectory>'
top = '<path_to_topology>'
m = Interface(trj, top)

Lastly, select the atom groups you want to consider, atom groups that comprise the interface, and run the calculate_density method:
m.select_atoms('all') # Consider every atom in the system
m.select_structure('<selection>') # resname of the nanoparticle

density_selection = 'resname TIP3'
m.calculate_density(density_selection)

Note that calculate_density uses every CPU core. You can specify the number of cores you want to use with the keyword argument cpu_count.
A more customized usage of the calculate_density method can be:
distances, densities = m.calculate_density(density_selection, start=10, end=1000, skip=2, norm_bin_count=12)

This version will start the calculation at the 10th frame and finish it at frame 1000 considering every 2nd frame. norm_bin_count specifies the number of divisions of the simulation box in each dimension to create a grid.
An example figure which shows the number density of different residues relative to the distance to the interface of a sodium oleate micelle:

Solubilized molecule count
PUCHIK also offers functionality for calculating the number of solubilized small molecules within a nanoparticle. This can be accomplished using the mol_count method. The signature of this method is identical to that of the calculate_density method. Here is an example usage:
sol = m.mol_count('resname TIP3 and type O', start=0, end=500)

Volume and area
As a direct consequence of using a convex hull, the volume of the hull can be easily extracted. The calculate_volume method does just that:
v = m.calculate_volume(start=500, end=1000, skip=2)

area keyword argument can be set to True to return the area of the hull as well:
v, a = m.calculate_volume(area=True, start=500, end=1000, skip=2)