Skip to main content

A package for making Wulff constructions

Project description

WulffPack is a tool for making Wulff constructions, typically for minimizing the energy of nanoparticles. A detailed description of the functionality provided as well as an extensive tutorial can be found in the user guide.

WulffPack constructs both continuum models and atomistic structures for further modeling with, e.g., molecular dynamics or density functional theory.

from wulffpack import SingleCrystal
from ase.io import write
surface_energies = {(1, 1, 1): 1.0, (1, 0, 0): 1.2}
particle = SingleCrystal(surface_energies)
particle.view()
write('atoms.xyz', particle.atoms)

With the help of ASE and Spglib, WulffPack handles any crystalline symmetry. WulffPack also provides the backbone of a web application in SHARC, in which Wulff constructions for cubic crystals can be created interactively.

Installation

In the most simple case, WulffPack can be installed using pip as follows:

pip3 install wulffpack --user

or alternatively:

python3 -m pip install wulffpack --user

WulffPack is based on Python3 and invokes functionality from other Python libraries including

Credits

WulffPack has been developed at Chalmers University of Technology in Gothenburg (Sweden) in the Condensed Matter and Materials Theory division at the Department of Physics.

When using WulffPack in your research please cite

J. Magnus Rahm and Paul Erhart
WulffPack: A Python package for Wulff constructions
J. Open Source Softw. 5, 1944 (2020)

Contribute

Bugs and feature requests should be submitted via the gitlab issue tracker.

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

wulffpack-1.4.tar.gz (30.7 kB view details)

Uploaded Source

Built Distribution

wulffpack-1.4-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

Details for the file wulffpack-1.4.tar.gz.

File metadata

  • Download URL: wulffpack-1.4.tar.gz
  • Upload date:
  • Size: 30.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for wulffpack-1.4.tar.gz
Algorithm Hash digest
SHA256 f78264cc240731ce02ff3cf2a54d46488b1447a928962774961e05649e9885aa
MD5 fc54cd6bab02d025da6ca211ec7c520e
BLAKE2b-256 364bfe9763e1364fc3091b97f01cc943e34d07aed52bc030d19a5151763c362d

See more details on using hashes here.

File details

Details for the file wulffpack-1.4-py3-none-any.whl.

File metadata

  • Download URL: wulffpack-1.4-py3-none-any.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for wulffpack-1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cbcabf10327304611ff748d13bc7118f7046ec7b41a35541b925472224b99d15
MD5 a1575ba2b175be7d4275d078c0ccac5a
BLAKE2b-256 8302a9a9fe3e5924ef0dfd63620a0259c262f742ee140c57375f086113aad8fc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page