README.rst 912 Bytes
Newer Older
Adel Kara Slimane's avatar
Adel Kara Slimane committed
1 2 3 4
About tkwantoperator
====================

``tkwantoperator`` is an opensource python package that extends the `tkwant <https://kwant-project.org/extensions/tkwant/>`_ library with additional operators. Currently, the extension includes energy related operators: current, density, source and heat current. ``tkwantoperator`` is distributed under the `2-clause BSD license  <https://gitlab.kwant-project.org/kwant/tkwantoperator/-/blob/master/LICENSE.rst>`_
Adel Kara Slimane's avatar
Adel Kara Slimane committed
5 6 7

Install instructions
~~~~~~~~~~~~~~~~~~~~
Adel Kara Slimane's avatar
Adel Kara Slimane committed
8
Complete install instructions can be found `here <https://kwant-project.org/extensions/tkwantoperator/pre/installation>`_ (or the file `INSTALL.rst <https://gitlab.kwant-project.org/kwant/tkwantoperator/-/blob/master/INSTALL.rst>`_ in the git repository).
Adel Kara Slimane's avatar
Adel Kara Slimane committed
9 10 11 12

Documentation
~~~~~~~~~~~~~
The documentation of this package, along with a tutorial, is available at : https://kwant-project.org/extensions/tkwantoperator