/fermi-contours

Fermi Contours

Primary LanguagePythonBSD 2-Clause "Simplified" LicenseBSD-2-Clause

Fermi Contours

PyPI Status Python Version License

Read the documentation at https://fermi-contours.readthedocs.io/ Tests Codecov

pre-commit Black

Reference

Code adapted from

Perez-Piskunow, Pablo M, Bovenzi, Nicandro, Akhmerov, Anton R, & Breitkreiz, Maxim. (2021). Code and data associated with the paper "Chiral Anomaly Trapped in Weyl Metals: Nonequilibrium Valley Polarization at Zero Magnetic Field" (1.0.1). Zenodo. https://doi.org/10.5281/zenodo.4704325

and extended to take into account periodic boundaries and other edge-cases.

Requirements

  • Python >=3.9

Installation

You can install Fermi Contours via pip from PyPI:

$ pip install fermi-contours

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Fermi Contours is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.