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
72164d8f
Commit
72164d8f
authored
11 years ago
by
Anton Akhmerov
Committed by
Christoph Groth
11 years ago
Browse files
Options
Downloads
Patches
Plain Diff
mention tutorial and bug reports in CONTRIBUTE
parent
2b4e8152
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTE
+15
-4
15 additions, 4 deletions
CONTRIBUTE
with
15 additions
and
4 deletions
CONTRIBUTE
+
15
−
4
View file @
72164d8f
=====================
Contributing to Kwant
=====================
=====================
=======================
Contributing to Kwant
and reporting problems
=====================
=======================
We view Kwant as not just a package with fixed functionality, but also as a
framework to implement different physics-related algorithms using a common set
...
...
@@ -10,7 +10,10 @@ room for growth, and planning to extend it.
We welcome both external contributions that are well-integrated with Kwant's
core functionality, such as new solvers type, or algorithms for calculation of
other observables, as well as code modules that are relatively independent but
useful with Kwant (such as the random matrix theory module `kwant.rmt`).
useful with Kwant (such as the random matrix theory module `kwant.rmt`). We
also welcome contributions to the reference documentation and the tutorial. It
is also possible to add complete tutorial sections that illustrate a physical
phenomenon using Kwant.
The complete development history of Kwant is `publicly available
<http://git.kwant-project.org/kwant>`_. Any external contribution will be
...
...
@@ -18,6 +21,14 @@ clearly marked as such, and papers where it is described (if any) will be
properly mentioned. Contact us if you are interested in submitting a
contribution.
When you encounter a bug, first try to reproduce it with as simple of a system
as possible. Double-check with Kwant documentation that what you observe is
actually a bug in Kwant. Then please email the bug report the Kwant `mailing
list <mailto:kwant-discuss@kwant-project.org>`_. A bug report should contain
the steps required to reproduce the bug, preferably with a simple script that
reproduces the bug attached. It should also include a description of the bug
(i.e. what exactly goes wrong).
Technical advice
----------------
...
...
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