Skip to content

adrybakov/rad-tools

Repository files navigation

RAD-TOOLS

Spin Hamiltonians, magnons and condense matter post-processing.

Documentation Status https://static.pepy.tech/personalized-badge/rad-tools?period=total&units=international_system&left_color=grey&right_color=blue&left_text=Downloads https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=505050

GitHub

The package covers post-processing scenarios for the results of Quantum Espresso, TB2J and Wannier90, as well as provides some custom scripts.

It is expected to be used in two ways:

  • As Python library
  • Via scripts (i.e. usage from command line)

For the detailed description check documentation.

Installation

Requirement for RAD-tools installation are:

  • Python (>=3.8)
  • NumPy
  • SciPy
  • matplotlib
  • tqdm
  • termcolor

RAD-tools can be installed with pip or from source.

pip

To install RAD-tools, run (you may need to use pip3):

pip install rad-tools

Installing from source

  • Clone the project to your local computer:
git clone git@github.com:adrybakov/rad-tools.git
  • Change the directory:
cd rad-tools
  • To install RAD-tools, run (you may need to use pip3):
pip install rad-tools

Additionally you may run the unit tests, which requires pytest (requires Python 3.7+) to be installed:

make test

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

pip install pytest

About

Sandbox (mainly condense matter plotting)

Resources

License

Stars

Watchers

Forks

Packages

No packages published