Skip to content
Snippets Groups Projects
Commit 1d184386 authored by Anton Akhmerov's avatar Anton Akhmerov
Browse files

reduce installation instructions parsing requirements (hopefully)

parent 12a0eae6
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 50 additions and 47 deletions
content/install.txt
+ 50
− 47
View file @ 1d184386
...@@ -2,15 +2,12 @@ ...@@ -2,15 +2,12 @@
Downloading and installing Kwant 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 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 that are available for `Windows`_, GNU/Linux (`Debian
Mac OS X. See further below for the instructions for your operating system. It <#debian-and-derivatives>`_ or `Ubuntu <#ubuntu-and-derivatives>`_, and their
is possible to `be notified about new releases of Kwant <community.html>`_. variants), and `Mac OS X`_. It is possible to be notified about new releases
of Kwant through a `mailing list
<community.html#announcements-of-new-releases>`_.
If no packages are available for the system you use, or if you would like to 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 build Kwant from source for another reason (expert users may want to customize
...@@ -19,8 +16,40 @@ installation instructions ...@@ -19,8 +16,40 @@ installation instructions
<doc/1.0/pre/install.html#building-and-installing-from-source>`_ in the <doc/1.0/pre/install.html#building-and-installing-from-source>`_ in the
documentation. documentation.
Ubuntu (and derivatives) 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).
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".
Ubuntu and derivatives
======================
Execute the following commands:: Execute the following commands::
...@@ -33,8 +62,8 @@ documentation will be installed locally in the directory ...@@ -33,8 +62,8 @@ documentation will be installed locally in the directory
``/usr/share/doc/python-kwant-doc``. ``/usr/share/doc/python-kwant-doc``.
Debian (and derivatives) Debian and derivatives
======================== ======================
The easiest way to install Kwant on a Debian system is using the pre-built 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 packages we provide. Our packages are known to work with Debian "wheezy" and
...@@ -78,34 +107,8 @@ This method should work for virtually all Debian-derived systems, even on exotic ...@@ -78,34 +107,8 @@ This method should work for virtually all Debian-derived systems, even on exotic
architectures. architectures.
Windows Mac OS X
======= ========
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 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 from the Unix/Linux world to Mac OS X. Since the community is quite
...@@ -113,8 +116,8 @@ split, we provide Kwant and its dependencies both via the `MacPorts ...@@ -113,8 +116,8 @@ split, we provide Kwant and its dependencies both via the `MacPorts
<http://www.macports.org>`_ and `Homebrew <http://brew.sh>`_ systems. <http://www.macports.org>`_ and `Homebrew <http://brew.sh>`_ systems.
If you are unsure, go for MacPorts, this is the simpler option. If you are unsure, go for MacPorts, this is the simpler option.
Mac OSX: MacPorts Mac OS X: MacPorts
================= ==================
MacPorts is a full-fledged package manager that recreates a whole Linux-like 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 software which you can install on your computer environment on your Mac. Beside Kwant, MacPorts gives you access to a wealth of free software which you can install on your computer
...@@ -128,7 +131,7 @@ In order to install Kwant, ...@@ -128,7 +131,7 @@ In order to install Kwant,
MacPorts itself, as explained in the `installation instructions of MacPorts MacPorts itself, as explained in the `installation instructions of MacPorts
<http://www.macports.org/install.php>`_. The prerequisites are, <http://www.macports.org/install.php>`_. The prerequisites are,
* the Xcode developer tools (compiler suite for Mac OSX) from * the Xcode developer tools (compiler suite for Mac OS X) from
`<http://developer.apple.com/downloads>`_. You will need an Apple ID to `<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 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 on the Mac/Ipad/Iphone/... you can use that one. You will also need the
...@@ -137,7 +140,7 @@ In order to install Kwant, ...@@ -137,7 +140,7 @@ In order to install Kwant,
select `Command Line Tools` and click on `Install`. Alternatively, you can select `Command Line Tools` and click on `Install`. Alternatively, you can
also directly download the command line tools from the also directly download the command line tools from the
Apple developer website. Apple developer website.
* if you have MacOSX 10.8 or higher, the X11 server from the * if you have Mac OS X 10.8 or higher, the X11 server from the
`XQuartz project <http://xquartz.macosforge.org>`_. `XQuartz project <http://xquartz.macosforge.org>`_.
2. After the installation, open a terminal and execute :: 2. After the installation, open a terminal and execute ::
...@@ -177,7 +180,7 @@ Notes: ...@@ -177,7 +180,7 @@ Notes:
Mac OS X: Homebrew Mac OS X: Homebrew
================== ==================
Homebrew is a recent addition to the package managers on Mac OSX. It is Homebrew is a recent addition to the package managers on Mac OS X. It is
more lightweight, tries to be as minimalistic as possible and give the user 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 more freedom. Because of that, it requires a little more experience on
the user side compared to MacPorts. The requirements are moderate though, the user side compared to MacPorts. The requirements are moderate though,
...@@ -195,7 +198,7 @@ you are safe. ...@@ -195,7 +198,7 @@ you are safe.
and follow its directions. It will ask for a few prerequisites to be and follow its directions. It will ask for a few prerequisites to be
installed, in particular installed, in particular
* the Xcode developer tools (compiler suite for Mac OSX) from * the Xcode developer tools (compiler suite for Mac OS X) from
`<http://developer.apple.com/downloads>`_. You will need an Apple ID to `<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 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 Mac/Ipad/Iphone/... you can use that one. Downloading the command line
...@@ -206,7 +209,7 @@ you are safe. ...@@ -206,7 +209,7 @@ you are safe.
click on `Install`. click on `Install`.
* although `brew doctor` might not complain about it right away, while we're * 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 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. <http://xquartz.macosforge.org>`_ if you have Mac OS X 10.8 or higher.
3. Add permanently ``/usr/local/bin`` before ``/usr/bin/`` in the ``$PATH$`` 3. Add permanently ``/usr/local/bin`` before ``/usr/bin/`` in the ``$PATH$``
environment variable of your shell, for example by adding :: environment variable of your shell, for example by adding ::
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment