Skip to main content

Cage detection plugin for GenIce.

Project description

genice2-cage

A GenIce2 format plugin to detect cage-like topologies.

version 2.1.1

Requirements

  • cycless
  • attrdict
  • networkx
  • numpy
  • yaplotlib>=0.1.2
  • genice2>=2.1b0

Installation from PyPI

% pip install genice2-cage

Manual Installation

System-wide installation

% make install

Private installation

Copy the files in genice2_cage/formats/ into your local formats/ folder.

Usage

Usage:
    % genice2 CS1 -r 2 2 2 -f cage[12,14-16:ring=-6]
    % genice2 CRN1 -f cage[sizes=3-10:json]
    % genice2 CRN1 -f cage[sizes=3-10:yaplot]
    % genice2 CS2 -w tip4p -f cage[gromacs:sizes=-16:ring=5,6]
    % analice2 traj.gro -O OW -H HW[12] -w tip4p -f cage[quad]
    % analice2 traj.gro -O OW -H HW[12] -w tip4p -f cage[quad:json]

It may not work with a small structure. (In the example above, the unit cell of CS1 is extended to 2x2x2 so as to avoid detecting cell-spanning wierd cages.)

Options:
    Cage sizes to be listed, separated by commas and ranged with hyphens. (e.g. -4,6,8-10,16-) (default is 3-16)
    ring=3,5-6 Specify the ring sizes that cages are built of (default is 3-8, maximum is 8).
    json       Output values in [JSON](https://www.json.org/) format.
    yaplot     Visualize cages with [Yaplot](https://github.com/vitroid/Yaplot/). Cages are drawn in different layers according to the number of faces, and faces are colored according to the number of vertices.
    gromacs    Output individual cages in Gromacs format. (EXPERIMENTAL)
    quad       Quadcage order parameter to identify the Frank-Kasper-type crystal structures.[JMM2011] Cages sizes and maximum ring size are set appropriately automatically.
    python     Output cage types in python format convenient for GenIce lattice modules.
* [JMM2011] Jacobson, L. C., Matsumoto, M. & Molinero, V. Order parameters for the multistep crystallization of clathrate hydrates. J. Chem. Phys. 135, 074501 (2011).[doi:10.1063/1.3613667](https://doi.org/10.1063/1.3613667)

Test in place

% make test

Algorithms

  • M. Matsumoto, A. Baba, and I. Ohmine, Topological building blocks of hydrogen bond network in water, J. Chem. Phys. 127, 134504 (2007); doi:10.1063/1.2772627

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

genice2-cage-2.1.1.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

genice2_cage-2.1.1-py2.py3-none-any.whl (6.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file genice2-cage-2.1.1.tar.gz.

File metadata

  • Download URL: genice2-cage-2.1.1.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.1rc1

File hashes

Hashes for genice2-cage-2.1.1.tar.gz
Algorithm Hash digest
SHA256 bfc740d44d71335ad29b3597f01ed55602e385d734c7c6e1bea6a43a5665cb2c
MD5 aacdf63dcb265963914feccf954b2b09
BLAKE2b-256 32cf1bf08341942c5711e2727f6528d7d96884013bb2bb868812c2f2faa88086

See more details on using hashes here.

File details

Details for the file genice2_cage-2.1.1-py2.py3-none-any.whl.

File metadata

  • Download URL: genice2_cage-2.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.1rc1

File hashes

Hashes for genice2_cage-2.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ee9856704d7aeaca9d81b1dfcb81a7b0a7ff3c5e9c669d228bab58cf6ad7511e
MD5 4068c670f1895dde596a082ad0954d24
BLAKE2b-256 edbc2b8bd53ec54f318539579aefb8c79a58777e8d863a95d31c155e411352ef

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