Package: tkwant
Tkwant is a python package to simulate time-dependent quantum dynamics of
mesoscopic systems. It is the time-dependent generalization of theKwantpackage and distributed under2-clause BSD license.
Tkwant is developed by the followingauthors.Website:https://tkwant.kwant-project.orgInstallationInstallation from sourceTkwant can currently only installed from its source.
Please visit theinstallation instructions.DevelopmentSource codeThe official tkwant repository is:Source code repository:https://gitlab.kwant-project.org/kwant/tkwant.gitThemasterbranch holds the current development version.Test suiteUnittests can be run directly in the local tkwant source repository from the command line:pytestIntegration tests, that require more time to run, are started with the command:pytest --integtestTests involving MPI can be run by the command:pytest --mpitestThe test suite needs the Python packagespytestto be installed and tkwant compiled.
Please visit theinstallation instructions.
Additional pep8 compliance checks can be activated with:pytest --flake8when the optionalpytest-flake8package is installed.Building the documentationThe documentation can be build directly in thedocfolder of the
local tkwant source repository from the command line:make htmlThe generated html documentation can be browsed
by opening the filedoc/build/html/index.htmlwith a web browser.
To build the documentation, additional Python packages need to be installed.
Please visit theinstallation instructions.ContributionContributions and feedback to tkwant are always welcome.
We also appreciate if you have suggestions for the documentation or find new bugs.
If you like to contribute new features,
feel free do discuss your ideas on the mailing list before opening a merge request.
Moreover, please make sure that the tkwant test suite runs without errors before opening
a new merge request.
See theContributionsection of kwant for coding style and general advice.AuthorsTkwant is developed by the followingauthors.LicenseTkwant is distributed under2-clause BSD license.
The license can be also found in fileLICENSE.rstin the project repository.Help and SupportDocumentationThe official user and developer documentation is found under:stable:https://tkwant.kwant-project.org/doc/stabledevelopment (master branch):https://tkwant.kwant-project.org/doc/devCommunicationThe kwant-discuss mailing list is the main communication channel for
questions and discussions around tkwant. Searching and using the mailing list
is explained in sectionmailing list.Mailing list:kwant-discuss@kwant-project.orgReporting bugsIf you encounter a problem that seems to be a bug of tkwant, you can open a ticket
with the issue tracker.Issue tracker:https://gitlab.kwant-project.org/kwant/tkwant/issuesPlease make sure that the problem has not yet been reported in theList of known tkwant bugs.
You may alsosearch the mailing listprior to open a new ticket.
See the theReporting bugssection of kwant for general advice.CitationIf you have used tkwant for work that has lead to a scientific publication,
we would appreciate if you cite the publication which introduces tkwant:T. Kloss, J. Weston, B. Gaury, B. Rossignol, C. Groth and X. Waintal,Tkwant: a software package for time-dependent quantum transportNew J. Phys.23, 023025 (2021),arXiv:2009.03132 [cond-mat.mes-hall].