Commit f341f326 authored by Adel Kara Slimane's avatar Adel Kara Slimane
Browse files

Update README

parent a971402f
Pipeline #79502 failed with stages
in 1 minute and 12 seconds
### tkwant-energy-transport
**Important Note:** This is a deprecated repository that only contains the intial development behind [tkwantoperator](https://gitlab.kwant-project.org/kwant/tkwantoperator), `tkwantoperator` is the official release and must be used instead of the code in this repository.
This is a fork of [tkwant](https://gitlab.kwant-project.org/kwant/tkwant) where an additional module, `tkwant.operator.energy`, have been added: it enables the calculation of the time dependant energy related quantities: energy current, source, density and heat current.
This specific branch contains our newer approach in implementing these energy related classes.
This specific branch contains our newer approach in implementing energy related quantities, with respect to the [energy-args-legacy](https://gitlab.kwant-project.org/spec-gmt/tkwant-energy-transport/-/tree/energy-args-legacy) branch. But then, this branch got supplanted by the [energy-params](https://gitlab.kwant-project.org/spec-gmt/tkwant-energy-transport/-/tree/energy-params) branch that includes upstream changes from [tkwant](https://gitlab.kwant-project.org/kwant/tkwant).
### Install instructions
For install instruction and how to run an example script, please refer to the `INSTALL.md` file in this same folder.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment