Skip to main content

ClustIce

A tool to generate exotic ice clusters.

version 0.7.1

Requirements

  • python
  • numpy
  • networkx
  • scikit-learn
  • cycless

Installation

ClustIce is registered to PyPI (Python Package Index). Install with pip3.

pip3 install clustice

Uninstallation

pip3 uninstall clustice

API

API manual is here.

Examples

Make an icosahedral ice cluster.

import numpy as np
import networkx as nx

import genice_core
from clustice.geometry import make_layout
from clustice.gromacs import render
from clustice.water import tip4p
from clustice import graph

# O-O distance
L = 0.27

# note: g must be a graph whose labels start from 0.
# g = graph.great_icosahedron(12, separation=L)
g = graph.great_decahedron(12)
# g = graph.small_barrelan()
# g = graph.large_barrelan()
# g = graph.twistane()
# g = graph.adamantane()
# g = nx.cycle_graph(6) # hexagon
# g = nx.cycle_graph(7) # heptagon
# g = nx.cubical_graph() # cubic octamer
# g = nx.dodecahedral_graph()


if "pos" in g.nodes[0]:
    # extract the embedded coords in g
    layout = np.array([g.nodes[v]["pos"] for v in g])
else:
    # estimate of the positions of the nodes
    layout = make_layout(g, edgelen=L)

# set orientations of the hydrogen bonds.
# if vertexPositions is given, the net dipole moment is minimized.
dg = genice_core.ice_graph(g, vertexPositions=layout, dipoleOptimizationCycles=100)

# put water molecules
gro = render(dg, layout, watermodel=tip4p)
with open("sample.gro", "w") as f:
    f.write(gro)

Metadata

Release files for ClustIce 0.8.0

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

Source distribution (sdist)

Source distribution for ClustIce 0.8.0
File Size Uploaded
clustice-0.8.0.tar.gz 10.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ClustIce 0.8.0
File Interpreter ABI Platform
clustice-0.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 22.4 kB

Release files / clustice-0.8.0.tar.gz

Download URL clustice-0.8.0.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
84b834ff553d26d3744a7be1ead228bbc81c813c4ad334c949b020d89af32246
BLAKE2b-256 checksum
How to use checksums
1ff7c914e2e5deeef2585fdfbc83401eae7dcdebc2dc80ba0241e3dea04ce033
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.2 CPython/3.10.19 Darwin/24.6.0

Release files / clustice-0.8.0-py3-none-any.whl

Download URL clustice-0.8.0-py3-none-any.whl
Size 12.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d56837620bd5bb640364204a452bb0ba104af90f27c472e43f137a021f5d367b
BLAKE2b-256 checksum
How to use checksums
66c6fd04ee039fc99dec3004c74c6ceab21668d429477532a0d1a26fbe17ec90
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.2 CPython/3.10.19 Darwin/24.6.0

Release history Release notifications | RSS feed

This release

0.8.0 This release

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

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