Skip to main content

KPM Tools

Project description

kpm-tools

=======

KPM Tools

PyPI Status Python Version License

Read the documentation at https://kpm-tools.readthedocs.io/ Tests Codecov

pre-commit Black

Features

  • KPM expansion of typical spectal functions
    • Density of states
    • Green's functions
    • Kubo conductivity
    • Chern marker
  • Time evolution
  • Tools for system with periodic boundaries
    • KPM vector factories that produces tiles
    • Velocity operators adapted to periodic boundaries
    • Distance operators adapted to periodic boundaries

Requirements

  • Python >=3.9

Installation

You can install KPM Tools via pip from PyPI:

$ pip install kpm-tools

Python API

Please see the python api reference for details.

Contributing

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

License

Distributed under the terms of the BSD 2-Clause license, KPM Tools 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kpm_tools-0.0.3.tar.gz (26.5 kB view hashes)

Uploaded Source

Built Distribution

kpm_tools-0.0.3-py3-none-any.whl (29.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page