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.3.tar.gz (27.3 kB view details)

Uploaded Source

Built Distribution

wulffpack-1.3-py2.py3-none-any.whl (33.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: wulffpack-1.3.tar.gz
  • Upload date:
  • Size: 27.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for wulffpack-1.3.tar.gz
Algorithm Hash digest
SHA256 ef07b2a49179e446afb6d1f83b597c240cf21191d8afe3f943c35e019593b9b6
MD5 48cac33bfd942094fb5468b4694dcd24
BLAKE2b-256 9965579d601235b6ba6e84becd63b1c6cc633bcc7824113ed1b109c36536a1eb

See more details on using hashes here.

File details

Details for the file wulffpack-1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: wulffpack-1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 33.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for wulffpack-1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 82904c30f259796ec8cd702b89851358cd3f1a05a6a365c98e8214e7cc09fe01
MD5 7bffbf671574d2045179c945d986a481
BLAKE2b-256 f710b2c8dee5cf495963ba7654a9314f749835c1bfc83332ae57004e66a35ede

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