Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
K
kwant
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Michael Wimmer
kwant
Commits
a7a6f105
Commit
a7a6f105
authored
11 years ago
by
Anton Akhmerov
Committed by
Christoph Groth
11 years ago
Browse files
Options
Downloads
Patches
Plain Diff
fill in references to mailing list and the paper
parent
482adcce
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTE
+17
-11
17 additions, 11 deletions
CONTRIBUTE
doc/source/tutorial/introduction.rst
+2
-3
2 additions, 3 deletions
doc/source/tutorial/introduction.rst
with
19 additions
and
14 deletions
CONTRIBUTE
+
17
−
11
View file @
a7a6f105
...
@@ -7,27 +7,33 @@ framework for implementing different physics-related algorithms using a common
...
@@ -7,27 +7,33 @@ framework for implementing different physics-related algorithms using a common
set of concepts and, if possible, a shared interface. We have designed it
set of concepts and, if possible, a shared interface. We have designed it
leaving room for growth, and plan to keep extending it.
leaving room for growth, and plan to keep extending it.
External contributions to Kwant are highly welcome. You can help to advance
the
External contributions to Kwant are highly welcome. You can help to advance
project not only by writing code, but also by reporting bugs, and
the
project not only by writing code, but also by reporting bugs, and
fixing/improving the documentation. A mailing list
TODO: add link (also
fixing/improving the documentation. A
`
mailing list
usable through a web interface (TODO: add link) )
is available for discussions.
<http://kwant-project.org/community.html>`_
is available for discussions.
If you have some code that works well with Kwant, or extends it in some useful
If you have some code that works well with Kwant, or extends it in some useful
way, please consider sharing it. Any external contribution will be clearly
way, please consider sharing it. Any external contribution will be clearly
marked as such, and relevant papers will be added to the list of :doc:`suggested
marked as such, and relevant papers will be added to the list of
acknowledgements <citing>`. The complete development history is available
:doc:`suggested acknowledgements <citing>`. The complete development history
through a `web interface <http://git.kwant-project.org/kwant>`_.
is also made available through a `web interface
<http://git.kwant-project.org/kwant>`_. If you plan to contribute, it is best
to coordinate with us in advance either through the `mailing list
<http://kwant-project.org/community.html>`__, or directly by `email
<mailto:authors@kwant-project.org>`_ for matters that you prefer to not discuss
publicly.
Reporiting bugs
Reporiting bugs
---------------
---------------
If you encounter a problem with Kwant, first try to reproduce it with as simple
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
a system as possible. Double-check with the documentation that what you
is actually a bug in Kwant. If you think it is, please check whether the problem
observe is actually a bug in Kwant. If you think it is, please check whether
is already known by searching the mailing list. (TODO: tell how).
the problem is already known by searching the `mailing list
<http://kwant-project.org/community.html>`__.
If the problem is not known yet, please email a bug report to the `Kwant mailing
If the problem is not known yet, please email a bug report to the `Kwant mailing
list <
mailto:kwant-discuss@
kwant-project.org>`_. A report should contain:
list <
http://
kwant-project.org
/community.html
>`_
_
. A report should contain:
* The versions of software you are using (Kwant, Python, operating system, etc.)
* The versions of software you are using (Kwant, Python, operating system, etc.)
...
...
This diff is collapsed.
Click to expand it.
doc/source/tutorial/introduction.rst
+
2
−
3
View file @
a7a6f105
...
@@ -7,9 +7,8 @@ commented extensively. In addition, you will find notes about more subtle,
...
@@ -7,9 +7,8 @@ commented extensively. In addition, you will find notes about more subtle,
technical details at the end of each example. At first reading, these notes may
technical details at the end of each example. At first reading, these notes may
be safely skipped.
be safely skipped.
A scientific article about Kwant is available as well:
A scientific article about Kwant is available as well, see `Kwant
website <http://kwant-project.org/citing.html>`_.
TO-BE-FILLED-IN
The article introduces Kwant with a somewhat different focus than the tutorial
The article introduces Kwant with a somewhat different focus than the tutorial
and it is the authors' intention that both texts complement each other. While
and it is the authors' intention that both texts complement each other. While
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment