Skip to main content

Provides the object bz, that defines a lattice in mometum space.

Project description

##############
Brillouin Zone
##############

.. contents::
.. section-numbering::
.. raw:: pdf

PageBreak oneColumn

=====
About
=====

A package that provides an object bz that defines a lattice in momentum (k) space
by means of the minimal wedge of the Brillouin Zone. The minimal wedge includes
k=(kx, ky): kx in [0,pi], ky <= kx. It is initialized by

.. code-block:: python

>>> import brillouin_zone
>>> brillouin_zone.bz( (int)kpts )

where kpts is the number of k points in one direction (e.g. kx).

* Python 3 support
* Linus, Mac OS X and Windows support
* Documentation
* Ongoing development and support

============
Installation
============

On **Mac OS X**, brillouin-zone can be installed via `Homebrew <http://brew.sh/>`_:

.. code-block:: bash

$ brew install brillouin-zone

Most **Linux** distributions may use

.. code-block:: bash

$ apt-get install brillouin-zone

A universal installation methos (that works on **Windows**, Mac OS X, Linux, ...) is
to use pip:

.. code-block:: bash

$ pip install --upgrade pip setuptools
$ pip install --upgrade brillouin_zone

-------------------
Development version
-------------------

This README and version currently undergoes heavy changes.

---------
Extension
---------

padefit - A package providing the objects selfenergy and greensfunctions as well
as all functions needed to perfom an analytic continuation from the
Matsubara axis to the real axis by means of a Pade Approximation.

=====
Usage
=====

-------
Example
-------

====
Meta
====

-------
Authors
-------

--------------
Acknowledgment
--------------

Project details


Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page