Skip to content
Snippets Groups Projects
Commit ef6190b5 authored by Christoph Groth's avatar Christoph Groth
Browse files

install: reorder OSes, putting windows at the bottom

parent ee15ba69
No related branches found
No related tags found
No related merge requests found
......@@ -3,10 +3,10 @@ Downloading and installing Kwant
================================
The quickest and easiest way to install Kwant is using the prepared packages
that are available for `Windows`_, GNU/Linux (`Debian
<#debian-and-derivatives>`_, `Ubuntu <#ubuntu-and-derivatives>`_, and their
variants, `Arch Linux`_), and `Mac OS X`_. It is possible to be notified about new releases
of Kwant through an `announcement mailing list
that are available for GNU/Linux (`Debian <#debian-and-derivatives>`_, `Ubuntu
<#ubuntu-and-derivatives>`_, and their variants, `Arch Linux`_), `Mac OS X`_,
and `Microsoft Windows`_. It is possible to be notified about new releases of
Kwant through an `announcement mailing list
<community.html#announcements-of-new-releases>`_.
If no packages are available for the system you use, or if you would like to
......@@ -22,84 +22,14 @@ by cloning the `Git repository of Kwant <http://git.kwant-project.org/kwant>`_
(browsable online).
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. 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:\Python27\python.exe C:\Python27\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:\Python27`` by the
actual location where python is installed.
5. Reboot your computer
6. Now 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>`_.
In this new command prompt window, execute::
pip install -U pip
pip install pyreadline
pip install --find-links http://downloads.kwant-project.org/gohlke-mirror/ ^
--trusted-host downloads.kwant-project.org --no-index numpy scipy ^
matplotlib ipython tornado pyzmq jinja2 nose tinyarray kwant
Now you are done!
If you want to run ipython notebook, open a command prompt (no need for
Adminstrator rights this time), and type::
ipython notebook
If you wish to install later other python packages form the website of
`Christoph Gohlke <http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_, download
the package (with the ending ``.whl``) for your operating system (32 or 64 bit)
and install it from a command prompt as::
pip install filename
where filename is the name of the downloaded file.
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
systems as well. (For example, the following works with recent Ubuntu versions.)
packages we provide. Our packages are known to work with Debian "stable" and
Debian "testing", but they may also work on many other recent Debian-derived
systems as well. (For example, the following works with recent Ubuntu
versions, too.)
The lines prefixed with ``sudo`` have to be run as root.
......@@ -138,6 +68,20 @@ This method should work for virtually all Debian-derived systems, even on exotic
architectures.
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``.
Arch Linux
==========
......@@ -281,3 +225,60 @@ Notes:
`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.
Microsoft 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. 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:\Python27\python.exe C:\Python27\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:\Python27`` by the
actual location where python is installed.
5. Reboot your computer
6. Now 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>`_.
In this new command prompt window, execute::
pip install -U pip
pip install pyreadline
pip install --find-links http://downloads.kwant-project.org/gohlke-mirror/ ^
--trusted-host downloads.kwant-project.org --no-index numpy scipy ^
matplotlib ipython tornado pyzmq jinja2 nose tinyarray kwant
Now you are done!
If you want to run ipython notebook, open a command prompt (no need for
Adminstrator rights this time), and type::
ipython notebook
If you wish to install later other python packages form the website of
`Christoph Gohlke <http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_, download
the package (with the ending ``.whl``) for your operating system (32 or 64 bit)
and install it from a command prompt as::
pip install filename
where filename is the name of the downloaded file.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment