Installation

Installing via pip

In the most simple case, WulffPack can be simply installed via pip:

pip install wulffpack

It is always a good idea to test that your installation works as advertised. To this end, you should run the test suite, which can be accomplished as follows:

curl -O https://wulffpack.materialsmodeling.org/tests.zip
unzip tests.zip
python3 tests/main.py

Cloning the repository

If you want to get the absolutely latest version you can clone the repo:

git clone git@gitlab.com:materials-modeling/wulffpack.git

and then install WulffPack via:

cd wulffpack
python3 setup.py install --user

in the root directory. This will set up WulffPack as a Python module for the current user. To ensure that the installation has succeeded it is recommended to run the tests:

python3 tests/main.py

Requirements

WulffPack requires Python3 and depends on the following libraries