/fplore

:open_file_folder: A library for evaluating data generated by FPLO runs :mortar_board:

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

fplore

A python library for FPLO run evaluation.

🚧 Still a work in progress, syntax may change without notice. 🚧

🙋 If you have completed FPLO runs, It'd be super helpful if you could send them to me so I can test various cases and implement new features. Thanks! Either drop me an e-mail or submit a pull request here.

Installation

The recommended way to install fplore is via the packages made available at PyPI by using the tool pip: pip install fplore.

Ideally, you should never install packages from PyPI as system packages, rather you should use virtual environments. If for some reason virtualenv is unavailable to you, installing for your user only (pip install --user) is preferable to forced system-wide installation.

Gallery

Brillouin zone Band plot Band projection Fermi surface projection

Usage

See the documentation at fplore.readthedocs.io.