Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • kwant/website
  • jbweston/website
  • basnijholt/website
  • r-j-skolasinski/website
  • marwahaha/website
5 results
Show changes
Hide whitespace changes
Inline Side-by-side
Showing
with 443 additions and 408 deletions
content/harvard-only_trial/index.txt deleted 100644 → 0
View file @ 97e4fa9d
Harvard-only trial pre-release of kwant
=======================================
kwant is made available as a special preview **exclusively** to the audience of
the 30 April 2013 presentation at Harvard University by Anton Akhmerov. Please
do not spread the link to this page. Instead, you are welcome show the link to
the `kwant website <http://kwant-project.org/>`_.
You may use kwant for your personal evaluation. Any other use, **explicitly
including further distribution**, is not allowed. Please wait for the release
of the final version that we expect to occur very soon.
So far, kwant is running on the following platforms: GNU/Linux, Mac OS, and
Windows. The usage experience on GNU/Linux is best (this is the platform
recommended by the authors of kwant), followed by Mac OS. Support for Windows
is highly experimental (help wanted).
Installation from source
------------------------
This method of installation is described in the documentation. It is extremely
easy on Debian-based GNU/Linux distributions (e.g. Ubuntu). On Mac OS and
Windows it is more involved, but documented as well. Please download the files
and follow the `installation instructions </docs/install.html>`_.
* kwant: `tar-gz-archive <kwant-0.3pre4.tar.gz>`__, `zip-archive <kwant-0.3pre4.zip>`__
* tinyarray (needed by kwant): `tar-gz-archive <tinyarray-0.0.tar.gz>`__, `zip-archive <tinyarray-0.0.zip>`__
Binary installation instructions for Windows
--------------------------------------------
**Warning:** These packages are highly experimental and likely not to work
fully. In a test with Windows XP, most tutorial examples ran. In another test
with Windows 7, most did not. We would appreciate the help of people
experienced with the Windows platform.
**Important note**: The provided binary packages are compiled for 32-bit
Microsoft Windows (win32). They can be installed on a 64-bit Windows as well,
but for them to work all the other required packages (like Python itself) have
to be present in their win32 versions.
1. Install the official Python 2.7 distribution from the official `Python
download page <http://python.org/download/>`_. Bear in mind the note above:
Choose "Python 2.7.x Windows Installer", not the 64 bit version.
2. Install the Python packages required by kwant (NumPy, SciPy, matplotlib). An
easy way to do so is to install the `scipy-stack package
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy-stack>`_ (win32-py2.7)
kindly provided by Christoph Gohlke. Please also note the instructions
at the top of that page.
3. Download and execute the `tinyarray installer <tinyarray-0.0.win32-py2.7.exe>`__.
4. Download and execute the `kwant installer <kwant-0.3pre2.win32-py2.7.exe>`__.
5. kwant and tinyarray require four libraries (DLLs) that can be downloaded
`here <kwant-dlls.zip>`__. For these libraries to be found by kwant, they
have either to be in the current directory, or in a directory that belongs to
``PATH``, or in ``C:\WINDOWS\SYSTEM32``. You have the following alternative
possibilities:
(a) Unpack the 4 files into some directory and launch all your kwant Python
scripts from the same directory.
(b) Like (a), but add that directory to the ``PATH`` environment variable
(The Web knows how to do that.). Now you should be able to launch kwant
scripts from everywhere.
(c) Copy the four DLL files directly to ``C:\WINDOWS\SYSTEM32``.
Please note that the kwant binary packages do not include any kwant examples or
documentation. Use the `online documentation </docs/>`_.
content/index.rst 0 → 100644
View file @ 63e84e27
Quantum transport simulations made easy
=======================================
.. raw:: html
<div class="workflow-image">
<object type="image/svg+xml" data="kwant-workflow.svgz" class="img-responsive">kwant-workflow.svgz</object>
</div>
Kwant is a `free (open source) <https://gitlab.kwant-project.org/kwant/kwant>`_,
powerful, and easy to use Python package for numerical calculations on tight-binding
models with a strong focus on quantum transport.
.. raw:: html
<div id="recent-posts" class="section col-sm-6">
<h2> Recent blog posts </h2>
.. post-list::
:stop: 4
.. raw:: html
</div>
.. raw:: html
<div id="kwant-uses" class="section col-sm-5">
<h2> Use Kwant to... </h2>
<ul id="kwant-uses-list">
<li>
<a href="/about#quantum-hall-effect"> Compute differential conductance </a>
</li>
<li>
<a href="/about#graphene-flake"> Visualize edge states </a>
</li>
<li>
<a href="/about#numerical-experiment-flying-qubit"> Conduct numerical experiments </a>
</li>
<li>
<a href="/doc/1/tutorial/spectrum#band-structure-calculations"> Explore band structure </a>
</li>
<li>
<a href="https://tkwant.kwant-project.org/"> Simulate time-dependent problems </a>
</li>
</div>
content/index.txt deleted 100644 → 0
View file @ 97e4fa9d
Quantum transport simulations made easy
=======================================
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, while not sacrificing performance.
Tight-binding models are ubiquitous in quantum physics and they can be used to
describe a vast variety of systems and phenomena, such as semiconductors,
metals, graphene, topological insulators, quantum Hall effect,
superconductivity, spintronics, molecular electronics, any combination of the
above and many other things. While all these systems exhibit very distinct
physical behavior, the underlying mathematical description is very similar.
Kwant has been designed so that the computer simulation of various physical
systems and phenomena is within reach of one software package.
Kwant does not use the traditional input files often found in scientific
software packages. Instead, one writes simple Python programs (using the
Python's simple and very expressive syntax) to define the system and calculate
its quantum properties (conductance, density of states, etc). This workflow is
summarized as follows:
.. image:: kwant_workflow.png
:width: 90%
Kwant was designed to be easy to use: for example the program that generates
the right panel of the image above is only 42 lines long. It is also accessible
for people without expertise in numerics. To aid that, it is provided along
with a detailed hand-on `tutorial </doc/1.0/tutorial/>`_ and the Kwant `paper
</paper>`_, which describes the guiding principles underlying its design.
Kwant is provided to the physics community as an open source free software (we
merely ask you to cite Kwant article in scientific publications using
Kwant). Below a few research applications of Kwant are shown.
3-d systems
-----------
.. container:: leftside
.. image:: 3d_systems.png
In this example, one can see a quantum wire (gray) to which is attached a
superconducting electrode (blue). This device has been built in order to give
rise to a Majorana bound states close to the superconducting-normal interface.
The latter can be seen in the spectrum of the device (REF).
Flying qubit
------------
.. container:: leftside
.. image:: flying-qubit.png
This example shows some numerical simulations (left) and experimental results
(right) for a flying Qubit sample made in a GaAs/GaAlAs heterostrucutre. See
Yamamoto et al, Nature Nanotechnology 7, 247 (2012) for details about this
experiment. (Simulations: T. Bautze et al. to be submitted to
Phys. Rev. B). In this example, particular attention was paid to designing a
realistic model for the confining potential seen by the electrons so that
rather subtle aspects of the experiments could be reproduce. Such type of
"numerical experiments" can not only be used to interpret the experimental data
but also as an aid in designing the sample geometry or in the choice of
materials.
conductance of a Corbino disk in a quantum Hall regime
------------------------------------------------------
.. container:: leftside
.. image:: corbino.png
Transport properties of a Corbino disk across a quantum Hall transition. Left
panel: winding number of the reflection matrix, which has to change from 0 to 1
across the transition. Right panel: conductance across the transition, showing
quantized conductance peaks.
content/install.rst 0 → 100644
View file @ 63e84e27
================================
Installing Kwant
================================
License and citation request
============================
Kwant is free software covered by the `2-clause BSD license </license>`_.
If you have used Kwant for work that has lead to a scientific publication,
please `cite the Kwant paper and possibly other relevant publications
</cite>`_.
Prerequisites
=============
In order to use Kwant you will need to install a distribution of the Python
language. If you are using a GNU/Linux operating system this should already be
installed on your computer.
If you are using Mac OS X or Microsoft Windows you will need to install a
Python distribution yourself. Details of how to do this are in the
installation instructions of the corresponding platform.
**Kwant version 1.2 and newer requires at least Python 3.4**.
Those who must use Python 2 can still use Kwant up to version 1.1,
which will receive bug fixes for several years
after 2015 (but no new features).
The instructions below assume Python 3. They should be also valid for Python
2 if all occurrences of ``python3``, ``pip3``, etc. are replaced by
``python``, ``pip``.
Platforms
=========
Installation instructions are available for the major operating systems:
+ `GNU/Linux`_
+ `Mac OS X`_
+ `Microsoft Windows`_
+ `Building from source`_
GNU/Linux
=========
Pre-built packages exist for the following distributions:
+ `Debian <#debian-and-derivatives>`_
+ `Ubuntu <#ubuntu-and-derivatives>`_
+ `Arch Linux`_
We also provide `Conda packages <#conda>`_ for users of the `Anaconda
<https://www.continuum.io/downloads>`_ Python distribution. This is a useful
option if you do not have root privileges on the machine where you would like
to install Kwant (e.g. on a computing cluster).
If your distribution is not listed above, and you do not want to use the
Conda packages, you can always install Kwant using `pip`_. Or by directly
building `from source <#building-from-source>`_.
Debian and derivatives
----------------------
The easiest way to install Kwant on a Debian system is using the pre-built
packages we provide. We target Debian "stable", but our packages may also work
on many other recent Debian-derived distributions as well.
The following instructions will install Kwant on Debian stable "buster".
They need to be executed as root.
1. Add the following lines to ``/etc/apt/sources.list``::
deb http://ftp.debian.org/debian buster main
deb http://downloads.kwant-project.org/debian/ buster main
deb-src http://downloads.kwant-project.org/debian/ buster main
2. (Optional) Add the OpenPGP key used to sign the repositories by executing::
apt-key adv --keyserver keyserver.ubuntu.com --recv-key C3F147F5980F3535
The fingerprint of the key is 5229 9057 FAD7 9965 3C4F 088A C3F1 47F5 980F
3535.
3. Update the package data, and install Kwant::
apt-get update
apt-get install python3-kwant
Ubuntu and derivatives
----------------------
The easiest way to install Kwant on an Ubuntu system is using the pre-built
packages we provide. Execute the following commands in a terminal::
sudo apt-add-repository -s ppa:kwant-project/ppa
sudo apt-get update
sudo apt-get install python3-kwant
This should provide up-to-date Kwant for all recent versions of Ubuntu,
up to at least the last LTS version.
Debian or Ubuntu: building packages from source
-----------------------------------------------
It is straightforward to build Debian/Ubuntu packages from source. This can be
useful when the installation from pre-built packages has failed for some
reason (e.g. for non-x86 CPUs).
As a prerequisite, a ``deb-src`` entry for Kwant is needed in
``/etc/apt/sources.list``. (It will be present if either of the above
instructions for Debian or for Ubuntu have been followed.)
FIrst, install the build dependencies (as root)::
apt-get build-dep tinyarray kwant
Then, compile Tinyarray and Kwant. This may be done as a normal user. ::
cd /tmp
apt-get source --compile tinyarray
apt-get source --compile kwant
Finally, install the built packages (again as root)::
dpkg --install python3-tinyarray_*.deb
dpkg --install python3-kwant_*.deb
Arch Linux
----------
`Arch install scripts for Kwant
<https://aur.archlinux.org/packages/python-kwant/>`_ are kindly provided by
Jörg Behrmann (formerly by Max Schlemmer). To install, follow the `Arch User
Repository installation instructions
<https://wiki.archlinux.org/index.php/Arch_User_Repository#Installing_packages>`_.
Note that for checking the validity of the package you need to add the key
used for signing to your user's keyring via::
gpg --keyserver pool.sks-keyservers.net --recv-key C3F147F5980F3535
The fingerprint of the key is 5229 9057 FAD7 9965 3C4F 088A C3F1 47F5 980F
3535.
Mac OS X
========
`Pre-built packages <#conda>`_ for Max OS X exist for the Conda package
manager, which is a part of the ``Anaconda`` Python distribution.
Using Conda is the recommended way to install Kwant on Mac OS X.
If you do not want to use the Conda packages, you can always install Kwant
using `pip`_. Or by directly `building from source`_.
We previously maintained Homebrew and Macports packages for Kwant, but due to
effort required to keep them up to date we have dropped support for these
installation methods. We recommend that people use the Conda packages
whenever possible.
Microsoft Windows
=================
`Pre-built packages <#conda>`_ for Microsoft Windows exist for the Conda
package manager, which is a part of the ``Anaconda`` Python distribution.
Using Conda is the recommended way to install Kwant on Microsoft Windows.
We previously recommended using that Kwant packages built by
Christoph Gohlke, however due to the complexity of the installation
instructions the Conda packages are preferred. Installation of the
package provided by Christoph Gohlke is only needed if the integration
with MUMPS is required (as this is still not available for the Conda packages).
The instructions for installing the alternative package are included below
Alternative Package
-------------------
The following instructions explain how to install the official version
of Python 3, Kwant, and its dependencies.
1. Determine whether you have a 32-bit or 64-bit Windows installation by
following these `instructions <http://support.microsoft.com/kb/827218>`_.
2. Download and install Python 3 for the appropriate architecture (32-bit: “x86” or
64-bit: “x86-64”) from the official `Python download site for Windows
<http://www.python.org/download/windows>`_. The current stable version
at the time of writing is Python 3.6.
3. Open a command prompt, as described in "How do I get a command prompt" at
the `Microsoft Windows website <http://windows.microsoft.com/en-us/windows/command-prompt-faq>`_.
4. In the command prompt window, execute::
C:\Python36\python.exe C:\Python36\Tools\Scripts\win_add2path.py
(Instead of typing this command, you can also just copy it from here and
paste it into the command prompt window). If you did not use the default
location to install Python in step 2, then replace ``C:\Python36`` by the
actual location where Python is installed. You may also need to adjust the
version (“36” signifies Python 3.6).
5. Reboot your computer.
6. Download the necessary packages (with the ending ``.whl``) for your
operating system (32 or 64 bit) and Python version (e.g. ``cp35`` for
Python 3.5) from the website of `Christoph Gohlke
<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_. For Kwant, we recommend to
download at least `NumPy
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy>`_, `SciPy
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy>`_, `Matplotlib
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#matplotlib>`_, `Sympy
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#sympy>`_, `MPMath
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#mpmath>`_, `Pytest
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#pytest>`_, `Six
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#six>`_, `Tinyarray
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#tinyarray>`_, and `Kwant
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#kwant>`_ itself. Make sure to
put the downloaded files into a directory without any other ``.whl`` files.
7. Open a command prompt with administrator rights, as described in “How do I
run a command with elevated permissions” at the `Microsoft Windows website
<http://windows.microsoft.com/en-us/windows/command-prompt-faq>`_.
Go to the directory with the ``.whl`` files, e.g.::
cd c:\Users\YOUR_USERNAME\Downloads
To install all the ``.whl``-files in the current directory, execute ::
python -c "import pip, glob; pip.main(['install', '--no-deps'] + glob.glob('*.whl'))"
The above cryptic command is equivalent to ``pip install --no-deps
*.whl``, i.e. it installs all the wheel files in the current directory
using pip. Because the Windows command interpreter does not support globs,
we have to rely on the globbing as provided by Python itself.
Now you are done, you can ``import kwant`` from within Python scripts.
(Note that many other useful scientific packages are available in Gohlke’s
repository. For example, you might want to install `IPython
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#ipython>`_ and its various
dependencies so that you can use the `IPython notebook <http://ipython.org/notebook.html>`_.)
If you do not want to use the Conda packages, you can always install Kwant
using `pip`_. Or by directly `building from source`_.
Conda
=====
Conda is the package manager for the Anaconda Python distribution.
Kwant currently has Conda packages for GNU/Linux, Mac OS X, and Microsoft Windows.
1. Download the Python 3.6 version of `Anaconda <https://www.continuum.io/downloads>`_ for
your platform and install it.
2. Execute the following command in a terminal::
conda install -c conda-forge kwant
The above command installs Kwant and all of its dependencies from the
``conda-forge`` channel.
``pip``
=======
.. caution::
Installing Kwant with ``pip`` is not easy because Kwant has several
non-Python dependencies and requires a C compiler. These instructions
are provided for advanced users only.
``pip`` is the standard Python package manager that downloads and installs
packages from the `Python package index <https://pypi.python.org/>`_.
1. Install the non-Python dependencies of Kwant: a C compiler, BLAS, Lapack,
and (optionally) MUMPS (see `Installing non-Python dependencies`_).
2. Execute the following command in a terminal::
sudo pip3 install kwant
The above command installs Kwant and all of its Python dependencies from the
Python package index.
The latest development build of Kwant can be installed directly from Kwant's
Git repository::
sudo pip3 install git+https://gitlab.kwant-project.org/kwant/kwant.git
Each of the above commands will perform a system-wide install (to
``/usr/local`` on Unix). Type ``pip3 help install`` for installation options
and see `pip documentation <https://pip.readthedocs.org/>`_ for a detailed
description of ``pip``.
Installing non-Python dependencies
----------------------------------
As mentioned above, ``pip`` will not install any non-Python dependencies
required by Kwant. Kwant has several non-Python dependencies:
+ a C compiler (e.g. ``gcc``)
+ BLAS
+ Lapack
+ `MUMPS <http://graal.ens-lyon.fr/MUMPS/>`_.
If you using a GNU/Linux system then your distribution probably has packages
for these libraries; you will need to install the `-dev` or `-devel` versions
of the packages.
As an example, on a Debian or Ubuntu system, the following
command will install the non-Python dependencies of Kwant::
sudo apt-get install build-essential gfortran libopenblas-dev liblapack-dev libmumps-scotch-dev
On Debian or Ubuntu systems the Kwant build scripts should find libraries that
have been installed in the above way automatically. This will be signaled at
the end of the build process as follows::
******************************** Build summary ********************************
Default LAPACK and BLAS
Auto-configured MUMPS
*******************************************************************************
On other platforms it is possible that MUMPS is not linked against Kwant during
installation. If this is the case the build process must be `configured
manually <doc/1/pre/install.html#build-configuration>`_ by writing a
``build.conf`` file. You can then tell ``pip`` to use this ``build.conf`` when
installing kwant::
sudo pip install --global-option="--configfile=/path/to/build.conf" kwant
Building from source
====================
If no packages are available for the system you use, or if you would like to
build Kwant from source for another reason (expert users may want to customize
Kwant to use certain optimized versions of libraries), you can `download
the source code <https://downloads.kwant-project.org/kwant>`_ and consult the
documentation on `how to install Kwant from source <doc/1/pre/install.html>`_.
content/install.txt deleted 100644 → 0
View file @ 97e4fa9d
================================
Downloading and installing Kwant
================================
The source code of released versions of Kwant is available for `download
<http://downloads.kwant-project.org/kwant/>`_. You can follow the development
by cloning the `Git repository of Kwant <http://git.kwant-project.org/kwant>`_
(browsable online).
The quickest and easiest way to install Kwant is using the prepared packages
that are available for GNU/Linux (Debian, Ubuntu, and variants), Windows, and
Mac OS X. See further below for the instructions for your operating system.
If no packages are available for the system you use, or if you would like to
install Kwant from source for another reason (expert users may want to customize
Kwant to use certain optimized versions of libraries), please consult the `full
installation instructions
<doc/1.0/pre/install.html#building-and-installing-from-source>`_ in the
documentation.
Ubuntu (and derivatives)
========================
Execute the following commands::
sudo apt-add-repository ppa:kwant-project/ppa
sudo apt-get update
sudo apt-get install python-kwant python-kwant-doc
This should provide Kwant for all versions of Ubuntu >= 12.04. The HTML
documentation will be installed locally in the directory
``/usr/share/doc/python-kwant-doc``.
Debian (and derivatives)
========================
The easiest way to install Kwant on a Debian system is using the pre-built
packages we provide. Our packages are known to work with Debian "wheezy" and
Debian "jessie", but they may also work on many other recent Debian-derived
sytems as well. (For example, the following works with recent Ubuntu versions.)
The lines prefixed with ``sudo`` have to be run as root.
1. Add the following lines to ``/etc/apt/sources.list``::
deb http://downloads.kwant-project.org/debian/ stable main
deb-src http://downloads.kwant-project.org/debian/ stable main
2. (Optional) Add the OpenPGP key used to sign the repositories by executing::
sudo apt-key adv --keyserver pgp.mit.edu --recv-key C3F147F5980F3535
3. Update the package data, and install Kwant::
sudo apt-get update
sudo apt-get install python-kwant python-kwant-doc
The ``python-kwant-doc`` package is optional and installs the HTML
documentation of Kwant in the directory ``/usr/share/doc/python-kwant-doc``.
Should the last command (``apt-get install``) fail due to unresolved
dependencies, you can try to build and install your own packages, which is
surprisingly easy::
cd /tmp
sudo apt-get build-dep tinyarray
apt-get source --compile tinyarray
sudo dpkg -i python-tinyarray_*.deb
sudo apt-get build-dep kwant
apt-get source --compile kwant
sudo dpkg -i python-kwant_*.deb python-kwant-doc_*.deb
This method should work for virtually all Debian-derived systems, even on exotic
architectures.
Windows
=======
There are multiple distributions of scientific Python software for Windows that
provide the prerequisites for Kwant. We recommend to use the packages kindly
provided by Christoph Gohlke. To install Kwant on Windows
1. Determine whether you have a 32-bit or 64-bit Windows installation by
following these `instructions <http://support.microsoft.com/kb/827218>`_.
2. Download and install Python 2.7 for the appropriate architecture (32-bit or
64-bit) from the official `Python download site
<http://www.python.org/download/>`_.
3. Download and install ``scipy-stack``, ``tinyarray``, and ``kwant`` for Python
2.7 from `Christoph Gohlke's page
<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_. Once again you should choose
the architecture that is appropriate for your system. ("win32" means 32-bit,
"amd64" means 64-bit -- even if you have a processor from Intel.) If the
download from Gohlke's site is slow, try to download from `our mirror
<http://downloads.kwant-project.org/gohlke-mirror/>`_.
You may see a warning that says "The publisher could not be verified. Do you
want to run this software?". Select "Run".
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 `homebrew <http://brew.sh>`_ systems.
If you are unsure, go for MacPorts, this is the simpler option.
Mac OSX: MacPorts
=================
MacPorts is a full-fledged package manager that recreates a whole Linux-like
environment on your Mac. Beside Kwant, MacPorts gives you access to a wealth of free softwares which you can install on your computer
easily (using simple command line instructions). It requires few choices to be made by the user,
and provides the simplest way to install Kwant.
In order to install Kwant,
1. Install a recent version of MacPorts. In order to do that, you first have to install
the prerequisites described below. When this is done, you can proceed with the installation of
MacPorts itself, as explained in the `installation instructions of MacPorts
<http://www.macports.org/install.php>`_. The prerequisites are,
* the Xcode developer tools (compiler suite for Mac OSX) from
`<http://developer.apple.com/downloads>`_. You will need an Apple ID to
download. Note that if you have one already from using the App store
on the Mac/Ipad/Iphone/... you can use that one. You will also need the
command line tools: Within Xcode 4, you have to download them by going to
`Xcode->Preferences`, click on `Download`, go to `Components`,
select `Command Line Tools` and click on `Install`. Alternatively, you can
also directly download the command line tools from the
Apple developer website.
* if you have MacOSX 10.8 or higher, the X11 server from the
`XQuartz project <http://xquartz.macosforge.org>`_.
2. After the installation, open a terminal and execute ::
echo http://downloads.kwant-project.org/macports/ports.tar |\
sudo tee -a /opt/local/etc/macports/sources.conf >/dev/null
(this adds the Kwant MacPorts download link
`<http://downloads.kwant-project.org/macports/ports.tar>`_ at the end of the
``sources.conf`` file.)
3. Execute ::
sudo port selfupdate
4. Now, install Kwant and its prerequisites ::
sudo port install py27-kwant
5. Finally, we choose python 2.7 to be the default python ::
sudo port select --set python python27
After that, you will need to close and reopen the terminal to
have all changes in effect.
Notes:
* If you have problems because your institution's firewall blocks MacPorts (more
precisely, the `rsync` port), resulting in errors from ``sudo port
selfupdate``, follow `these instructions
<https://trac.macports.org/wiki/howto/PortTreeTarball>`_.
* Of course, if you already have MacPorts installed, you can skip step 1
and continue with step 2.
Mac OS X: homebrew
==================
homebrew 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 homebrew as described on the `homebrew
homepage <http://brew.sh>`_ (instructions are towards the end of
the page)
2. Run ::
brew doctor
and follow its directions. It will ask for a few prerequisites to be
installed, in particular
* the Xcode developer tools (compiler suite for Mac OSX) from
`<http://developer.apple.com/downloads>`_. You will need an Apple ID to
download. Note that if you have one already from using the App store on the
Mac/Ipad/Iphone/... you can use that one. Downloading the command line
tools (not the full Xcode suite) is sufficient. If you have the full Xcode
suite installed, you might need to download the command line tools manually
if you have version 4 or higher. In this case go to `Xcode->Preferences`,
click on `Download`, go to `Components`, select `Command Line Tools` and
click on `Install`.
* although `brew doctor` might not complain about it right away, while we're
at it, you should also install the X11 server from the `XQuartz project
<http://xquartz.macosforge.org>`_ if you have Mac OSX 10.8 or higher.
3. Add permanently ``/usr/local/bin`` before ``/usr/bin/`` in the ``$PATH$``
environment variable of your shell, for example by adding ::
export PATH=/usr/local/bin:$PATH
at the end of your ``.bash_profile`` or ``.profile``. Then close
the terminal Terminal and reopen it again.
4. Install a few prerequisites ::
brew install gfortran python
5. Add additional repositories ::
brew tap homebrew/science
brew tap samueljohn/python
brew tap michaelwimmer/kwant
6. Install Kwant and its prerequisites ::
pip install nose
brew install numpy scipy matplotlib
brew install kwant
Notes:
- If something does not work as expected, use ``brew doctor`` for
instructions (it will find conflicts and things like that).
- As mentioned, homebrew allows for quite some freedom. In particular,
if you are an expert, you don't need necessarily to install
numpy/scipy/matplotlib from homebrew, but can use your own installation.
The only prerequisite is that they are importable from python. (the
Kwant installation will in any case complain if they are not)
- In principle, you need not install the homebrew python, but could use
Apple's already installed python. Homebrew's python is more up-to-date,
though.
content/kwant_workflow.png deleted 100644 → 0
View file @ 97e4fa9d
content/kwant_workflow.png

171 KiB

content/license.txt → content/license.rst
View file @ 63e84e27
Kwant license
=============
(This license applies to all files within Kwant distribution except those
within the ``doc/sphinxext`` subdirectory for which
``doc/sphinxext/LICENSE.txt`` applies.)
Copyright 2011-2013 C. W. Groth (CEA), M. Wimmer, A. R. Akhmerov,
Copyright 2011-2015 C. W. Groth (CEA), M. Wimmer, A. R. Akhmerov,
X. Waintal (CEA), and others. All rights reserved.
(CEA = Commissariat à l'énergie atomique et aux énergies alternatives)
......
content/mm16.rst 0 → 100644
View file @ 63e84e27
APS March meeting 2016 tutorial
-------------------------------
This page collects materials for the APS March meeting 2016 tutorial “Introduction to Computational Quantum Nanoelectronics” (`announcement <http://www.aps.org/meetings/march/events/tutorials.cfm#t10>`_).
The tutorial consists of a set of `Jupyter <http://jupyter.org/>`_ notebooks that combine demonstrations and explainations with exercises. These materials are made available under a `simplified BSD license <https://gitlab.kwant-project.org/kwant/kwant-tutorial-2016/blob/master/LICENSE>`_.
* `Run the tutorial directly in your web browser <http://mybinder.org/repo/kwant-project/kwant-tutorial-2016/>`_. The Python environment and Kwant will run on a server provided by the `Binder service <http://mybinder.org/>`_.
* `Download everything <https://gitlab.kwant-project.org/kwant/kwant-tutorial-2016/repository/archive.zip?ref=master>`_ as a single zip archive. Kwant 1.2 or newer is required to execute the notebooks.
* `Browse the git repository <https://gitlab.kwant-project.org/kwant/kwant-tutorial-2016>`_.
content/paper.rst 0 → 100644
View file @ 63e84e27
Kwant reference
---------------
C. W. Groth, M. Wimmer, A. R. Akhmerov, X. Waintal,
*Kwant: a software package for quantum transport*,
`New J. Phys. 16, 063065 (2014)
<http://iopscience.iop.org/1367-2630/16/6/063065/article>`_.
content/paper.txt deleted 100644 → 0
View file @ 97e4fa9d
Kwant reference
---------------
The ideas behind Kwant design are described in http://arxiv.org/abs/1308:XXXX
content/tinyarray.rst 0 → 100644
View file @ 63e84e27
This page has been moved to https://gitlab.kwant-project.org/kwant/tinyarray
docker/Dockerfile 0 → 100644
View file @ 63e84e27
# Use for building and deploying Kwant website
FROM ubuntu:16.04
MAINTAINER Kwant authors <authors@kwant-project.org>
RUN apt-get update -y && apt-get install -y python3-pip git libjpeg-dev zlib1g-dev libxml2-dev libxslt1-dev
RUN pip3 install nikola jinja2 webassets feedparser
content/collage.png → files/collage.png
View file @ 63e84e27
File moved
files/corbino-conductance.png 0 → 100644
View file @ 63e84e27
files/corbino-conductance.png

52.5 KiB

files/corbino-layout.svgz 0 → 100644
View file @ 63e84e27
File added
files/doc/kwant-screencast-2014.html 0 → 100644
View file @ 63e84e27
<html>
<head>
<meta name="viewport" content="width=device-width; height=device-height;">
<title>Kwant screencast</title>
<style media="screen" type="text/css">
body {
background-color: black;
height: 100%;
width: 100%;
margin: 0;
padding: 0;
}
video {
position: absolute;
top: 0;
right: 0;
bottom: 0;
left: 0;
margin: auto;
max-width: 100%;
max-height: 100%;
}
video:focus {
outline-width: 0;
}
</style>
</head>
<body>
<video controls autoplay>
<source src="http://downloads.kwant-project.org/doc/kwant-screencast-2014.mp4" type='video/mp4; codecs="avc1.4D401E, mp4a.40.2"'>
<source src="http://downloads.kwant-project.org/doc/kwant-screencast-2014.webm" type='video/webm; codecs="vp8.0, vorbis"'>
Please <a href="http://downloads.kwant-project.org/doc/kwant-screencast-2014.mp4">download the video manually</a>.
</video>
</body>
</html>
files/flying-qubit.png 0 → 100644
View file @ 63e84e27
files/flying-qubit.png

101 KiB

files/graphene-edgestate.svgz 0 → 100644
View file @ 63e84e27
File added
files/kwant-workflow.svgz 0 → 100644
View file @ 63e84e27
File added
content/common/kwant_icon.png → files/kwant_icon.png
View file @ 63e84e27
File moved