Installation#

Requirement for Wulfric installation are:

Most likely you already have Python installed on your machine (if not check these links: Python installation).

Wulfric can be installed with pip or from source.

Check Python#

The easiest way to check if you have python installed is to run the following command in your terminal:

python

If you see something similar to the following, than you have python installed:

Python 3.10.9 (main, Dec 15 2022, 18:25:35) [Clang 14.0.0 (clang-1400.0.29.202)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>>

In most cases python command launches python3, however if it launches python2, then you may need to use python3 instead (and pip3 instead of pip in the following commands).

Hint

Use exit() or press ctrl+D to close python console.

Installation with pip#

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

pip install wulfric

Optionally, if you want to use visualization capabilities of Wulfric, you can install matplotlib and/or Plotly by yourself or install them with Wulfric:

pip install wulfric[visual]

Note

You may need to escpae the [ and ] characters from your shell, because they are special characters in most shells. For example, in bash you can use backslash to escape them:

pip install wulfric\[visual\]

Or enclose full name in quotes:

pip install "wulfric[visual]"

Installation from source#

  • Clone the project to your local computer:

    git clone git@github.com:adrybakov/wulfric.git

  • Change the directory:

    cd wulfric

  • Install the requirements:

    pip install -r requirements.txt

Note

If you check the content of the requirements.txt file:

# Package dependencies
numpy
scipy
termcolor

# Optional package dependencies
matplotlib
plotly

You'll see that all dependencies - mandatory and optional - are installed. If you prefer to install only mandatory dependencies, you can do it manually.

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

    pip install wulfric

Update#

If you want to update the package to the latest available version (0.3.1) type the following in your terminal (you may need to use pip3):

pip install wulfric --upgrade