Quickstart

Welcome to the quickstart guide of Wulfric!

Installation

If you already have Python installed you may simply run:

pip install wulfric

For the full guide on Wulfric installation see Installation.

How to import Wulfric

To use Wulfric in your code import it in a following way:

import wulfric as wulf

The shorten import name wulf simplifies the readability of python code. It is used in the examples and we encourage you to try it.

Further reading

Good starting point is the Data structure overview. Afterwards we recommend to continue with the Detailed guides, where every class and function of Wulfric is explained with the examples.

For the full technical reference of modules, classes and methods see API reference.

Some of the algorithms used in Wulfric are described in the Methods and algorithms.

For the full description of adopted Bravais lattices and high-symmetry K-points see Bravais lattices.

Note

The images are interactive over there.