wulfric

Crystal, Lattice, Atoms, K-path.


License
xpp
Install
pip install wulfric==0.3.1

Documentation

Wulfric

Crystal, Lattice, Atoms, K-path.

image

Documentation Status

image

image

image

pre-commit.ci status

For the detailed description check documentation.

Installation

Requirement for Wulfric installation are:

  • Python (>=3.8)
  • NumPy
  • SciPy
  • termcolor
  • matplotlib (optional)
  • plotly (optional)

Optional dependencies are required if you want to use visual capabilities.

Wulfric can be installed with pip or from source.

pip

To install Wulfric, run (you may need to use pip3):

pip install wulfric

To install with optional visualisation capabilities, run (you may need to use pip3):

pip install wulfric[visual]

Installing from source

  • Clone the project to your local computer:
git clone git@github.com:adrybakov/wulfric.git
  • Change the directory:
cd wulfric
  • Instal the dependencies (you may need to use pip3):
pip install -r requirements.txt
  • To install Wulfric, run (you may need to use pip3):
pip install wulfric