Skip to content
Snippets Groups Projects
Forked from kwant / website
92 commits behind the upstream repository.
community.rst 6.80 KiB

The Kwant community

The Kwant project is an international collaboration. Everybody is welcome to participate in the community by asking and replying to questions, reporting bugs, providing suggestions, and contributing to the code and documentation.

A list of Kwant authors is included in the documentation. Please only contact the authors directly for matters that cannot be discussed in public on one of the mailing lists.

General mailing list

The kwant-discuss mailing list is the main public communication platform for anything related to Kwant: questions, bug reports, discussions, and announcements. You can use it in various ways:

Development list

Those who are interested (or would like to participate) in the further development of Kwant are invited to subscribe to the kwant-devel mailing list. This is the place for technical discussions about changes to Kwant. Please do not send bug reports to this list but rather to kwant-discuss.

Kwant-devel works in the same way as kwant-discuss:

Announcements (low-volume)

This read-only list is reserved for important announcements like new releases of Kwant. Only a few messages will be sent per year. These announcements will be also posted on the main mailing list, so there is no need to subscribe to both lists. We recommend every user of Kwant to subscribe at least to this list in order to stay informed about new developments.

Reporting bugs

If you encounter a problem with Kwant, first try to reproduce it with as simple a system as possible. Double-check with the documentation that what you observe is actually a bug in Kwant. If you think it is, please check the list of known bugs in Kwant. It may be also a good idea to search or ask on the general mailing list. (You can use the search box at the top of this page.)

If after checking you still think that you have found a bug, please add it to the above-mentioned list of bugs by creating an issue with the “bug” label. A useful bug report should contain:

  • The versions of software you are using (Kwant, Python, operating system, etc.)
  • A description of the problem, i.e. what exactly goes wrong.
  • Enough information to reproduce the bug, preferably in the form of a simple script.