Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
W
website
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD 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
kwant
website
Commits
5a118974
Commit
5a118974
authored
11 years ago
by
Anton Akhmerov
Browse files
Options
Downloads
Patches
Plain Diff
minor wording improvements, package name capitalization
parent
1e27232f
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
content/doc/index.txt
+3
-2
3 additions, 2 deletions
content/doc/index.txt
content/index.txt
+9
-8
9 additions, 8 deletions
content/index.txt
content/install.txt
+10
-10
10 additions, 10 deletions
content/install.txt
with
22 additions
and
20 deletions
content/doc/index.txt
+
3
−
2
View file @
5a118974
...
...
@@ -3,8 +3,9 @@ Kwant documentation
The two available resources for learning Kwant are its tutorial, and the paper
inctroducing Kwant structure and design. The tutorial is hands-on, and mainly
explains how to use Kwant, and its various features, while the paper presents a
more general perspective, useful to kwow for extending Kwant functionality.
explains how to use Kwant and its various features. The paper on the other
hand presents a more general perspective, that is useful to kwow for extending
Kwant functionality.
Kwant tutorial:
...
...
This diff is collapsed.
Click to expand it.
content/index.txt
+
9
−
8
View file @
5a118974
...
...
@@ -5,7 +5,7 @@ Kwant is a Python package for numerical calculations on tight-binding models
with a strong focus on quantum transport. It is designed to be flexible and
easy to use. Thanks to the use of innovative algorithms, Kwant is often faster
than other available codes, even those entirely written in the low level
languages
FORTRAN and C/C++.
FORTRAN and C/C++
languages
.
Tight-binding models can describe a vast variety of systems and phenomena in
quantum physics. Therefore, Kwant can be used to simulate metals, graphene,
...
...
@@ -32,9 +32,10 @@ Examples of Kwant usage
-----------------------
The following examples are meant to give an overview of what is possible with
Kwant. The `tutorial <doc/1.0/tutorial/>`_ and the `Kwant paper`_ each contain
several pedagogical examples with line-by-line explanations (`zipfile of all
examples <http://downloads.kwant-project.org/examples/kwant-examples.zip>`_).
Kwant. The tutorial section of `Kwant documentation <doc/1.0/>`_ and the
`Kwant paper`_ each contain several pedagogical examples with line-by-line
explanations (`zipfile of all examples
<http://downloads.kwant-project.org/examples/kwant-examples.zip>`_).
Graphene flake
...
...
@@ -57,10 +58,10 @@ is::
sys[lat.shape(disk, (0, 0))] = 0
sys[lat.neighbors()] = -1
Next
to the flake itself, the image also shows the wave function of a
low energy
eigenstate. The size of each circle is proportional to the wave
function
probability amplitude on that site. It can be clearly seen that the
wave
function is peaked near the zigzag segments of the boundary, as `expected
In addition
to the flake itself, the image also shows the wave function of a
low energy
eigenstate. The size of each circle is proportional to the wave
function
probability amplitude on that site. It can be clearly seen that the
wave
function is peaked near the zigzag segments of the boundary, as `expected
<http://arxiv.org/abs/1003.4602>`_ for graphene quantum dots.
Taken from the Kwant `plotting tutorial <doc/1.0/tutorial/tutorial6.html>`_.
...
...
This diff is collapsed.
Click to expand it.
content/install.txt
+
10
−
10
View file @
5a118974
...
...
@@ -109,7 +109,7 @@ Mac OSX
There is a number of different package managers to bring software
from the Unix/Linux world to Mac OS X. Since the community is quite
split, we provide Kwant and its dependencies both via the `MacPorts
<http://www.macports.org>`_ and `
h
omebrew <http://brew.sh>`_ systems.
<http://www.macports.org>`_ and `
H
omebrew <http://brew.sh>`_ systems.
If you are unsure, go for MacPorts, this is the simpler option.
Mac OSX: MacPorts
...
...
@@ -156,7 +156,7 @@ In order to install Kwant,
sudo port install py27-kwant
5. Finally, we choose
p
ython 2.7 to be the default
p
ython ::
5. Finally, we choose
P
ython 2.7 to be the default
P
ython ::
sudo port select --set python python27
...
...
@@ -173,17 +173,17 @@ Notes:
and continue with step 2.
Mac OS X:
h
omebrew
Mac OS X:
H
omebrew
==================
h
omebrew is a recent addition to the package managers on Mac OSX. It is
H
omebrew is a recent addition to the package managers on Mac OSX. It is
more lightweight, tries to be as minimalistic as possible and give the user
more freedom. Because of that, it requires a little more experience on
the user side compared to MacPorts. The requirements are moderate though,
if you know how to add directories to the ``$PATH`` variable for your shell,
you are safe.
1. Open a terminal and install
h
omebrew as described on the `
h
omebrew
1. Open a terminal and install
H
omebrew as described on the `
H
omebrew
homepage <http://brew.sh>`_ (instructions are towards the end of
the page)
...
...
@@ -235,11 +235,11 @@ Notes:
- If something does not work as expected, use ``brew doctor`` for
instructions (it will find conflicts and things like that).
- As mentioned,
h
omebrew allows for quite some freedom. In particular,
- As mentioned,
H
omebrew allows for quite some freedom. In particular,
if you are an expert, you don't need necessarily to install
numpy/scipy/matplotlib from
h
omebrew, but can use your own installation.
The only prerequisite is that they are importable from
p
ython. (the
numpy/scipy/matplotlib from
H
omebrew, but can use your own installation.
The only prerequisite is that they are importable from
P
ython. (the
Kwant installation will in any case complain if they are not)
- In principle, you need not install the
h
omebrew
p
ython, but could use
Apple's already installed
p
ython. Homebrew's
p
ython is more up-to-date,
- In principle, you need not install the
H
omebrew
P
ython, but could use
Apple's already installed
P
ython. Homebrew's
P
ython is more up-to-date,
though.
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