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
44875651
Commit
44875651
authored
11 years ago
by
Christoph Groth
Browse files
Options
Downloads
Patches
Plain Diff
INSTALL: reduce nesting depth; small fixes
parent
99d8a50d
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
INSTALL
+36
-42
36 additions, 42 deletions
INSTALL
with
36 additions
and
42 deletions
INSTALL
+
36
−
42
View file @
44875651
...
@@ -20,11 +20,13 @@ Ubuntu (and derivatives)
...
@@ -20,11 +20,13 @@ Ubuntu (and derivatives)
Execute the following commands::
Execute the following commands::
sudo apt-add-repository ppa:kwant-project/ppa
sudo apt-add-repository ppa:kwant-project/ppa
sudo apt-get update
sudo apt-get update
sudo apt-get install python-kwant
sudo apt-get install python-kwant
python-kwant-doc
This should provide Kwant for all the versions of Ubuntu >= 12.04.
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 GNU/Linux (and derivatives)
Debian GNU/Linux (and derivatives)
...
@@ -33,8 +35,7 @@ Debian GNU/Linux (and derivatives)
...
@@ -33,8 +35,7 @@ Debian GNU/Linux (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
Debian "jessie", but they may also work on many other recent Debian-derived
Debian "jessie", but they may also work on many other recent Debian-derived
sytems as well. (For example the following works with recent Ubuntu
sytems as well. (For example, the following works with recent Ubuntu versions.)
installations as well.)
The lines prefixed with ``sudo`` have to be run as root.
The lines prefixed with ``sudo`` have to be run as root.
...
@@ -54,25 +55,25 @@ The lines prefixed with ``sudo`` have to be run as root.
...
@@ -54,25 +55,25 @@ The lines prefixed with ``sudo`` have to be run as root.
sudo apt-get update
sudo apt-get update
sudo apt-get install python-kwant python-kwant-doc
sudo apt-get install python-kwant python-kwant-doc
The `python-kwant-doc` package is optional and installs the HTML
The
`
`python-kwant-doc`
`
package is optional and installs the HTML
documentation of Kwant in the directory ``/usr/share/doc/python-kwant-doc``.
documentation of Kwant in the directory ``/usr/share/doc/python-kwant-doc``.
Should the last command (``apt-get install``) fail due to unresolved
Should the last command (``apt-get install``) fail due to unresolved
dependencies, you can try to build your own packages, which is
surprisingly
dependencies, you can try to build
and install
your own packages, which is
easy::
surprisingly
easy::
cd /tmp
cd /tmp
sudo apt-get build-dep tinyarray
sudo apt-get build-dep tinyarray
apt-get source --compile tinyarray
apt-get source --compile tinyarray
sudo dpkg -i python-tinyarray_*.deb
sudo dpkg -i python-tinyarray_*.deb
sudo apt-get build-dep kwant
sudo apt-get build-dep kwant
apt-get source --compile kwant
apt-get source --compile kwant
sudo dpkg -i python-kwant_*.deb python-kwant-doc_*.deb
sudo dpkg -i python-kwant_*.deb python-kwant-doc_*.deb
This method should work for virtually all Debian-derived systems, even
for
This method should work for virtually all Debian-derived systems, even
on exotic
exotic
architectures.
architectures.
Windows
Windows
...
@@ -94,7 +95,7 @@ provided by Christoph Gohlke. To install Kwant on Windows
...
@@ -94,7 +95,7 @@ provided by Christoph Gohlke. To install Kwant on Windows
<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_. Once again you should choose
<http://www.lfd.uci.edu/~gohlke/pythonlibs/>`_. Once again you should choose
the architecture that is appropriate for your system. ("win32" means 32-bit,
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
"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
download from Gohlke's site is slow, try to download from
`
our mirror
<http://downloads.kwant-project.org/gohlke-mirror/>`_.
<http://downloads.kwant-project.org/gohlke-mirror/>`_.
You may see a warning that says "The publisher could not be verified. Do you
You may see a warning that says "The publisher could not be verified. Do you
...
@@ -109,8 +110,8 @@ from the Unix/Linux world to Mac OSX. Since the community is quite
...
@@ -109,8 +110,8 @@ from the Unix/Linux world to Mac OSX. Since the community is quite
split, we provide Kwant and its dependencies both via the `MacPorts
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.
MacPorts
Mac OSX:
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. It requires little choices to be made by the user,
environment on your Mac. It requires little choices to be made by the user,
...
@@ -159,9 +160,7 @@ In order to install Kwant, you have to
...
@@ -159,9 +160,7 @@ In order to install Kwant, you have to
After that, you will need to close and reopen the terminal to
After that, you will need to close and reopen the terminal to
have all changes in effect.
have all changes in effect.
Notes:
Notes
.....
* If you have problems with macports because your institution's firewall
* If you have problems with macports because your institution's firewall
blocks macports (more precisely, the `rsync` port), resulting in
blocks macports (more precisely, the `rsync` port), resulting in
...
@@ -171,8 +170,8 @@ Notes
...
@@ -171,8 +170,8 @@ Notes
and continue with step 2.
and continue with step 2.
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 OSX. 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
...
@@ -230,8 +229,7 @@ you are safe.
...
@@ -230,8 +229,7 @@ you are safe.
brew install numpy scipy matplotlib
brew install numpy scipy matplotlib
brew install kwant
brew install kwant
Notes
Notes:
.....
- If something does not work as expected, use ``brew doctor`` for
- If something does not work as expected, use ``brew doctor`` for
instructions (it will find conflicts and things like that).
instructions (it will find conflicts and things like that).
...
@@ -259,7 +257,8 @@ Building Kwant requires
...
@@ -259,7 +257,8 @@ Building Kwant requires
(For best performance we recommend the free `OpenBLAS
(For best performance we recommend the free `OpenBLAS
<http://xianyi.github.com/OpenBLAS/>`_ or the unfree `MKL
<http://xianyi.github.com/OpenBLAS/>`_ or the unfree `MKL
<http://software.intel.com/en-us/intel-mkl>`_.)
<http://software.intel.com/en-us/intel-mkl>`_.)
* Tinyarray, a NumPy-like Python package optimized for very small arrays,
* `Tinyarray <http://kwant-project.org/tinyarray/>`_, a NumPy-like Python
package optimized for very small arrays,
* An environment which allows to compile Python extensions written in C and
* An environment which allows to compile Python extensions written in C and
C++.
C++.
...
@@ -275,16 +274,14 @@ The following software is highly recommended though not strictly required:
...
@@ -275,16 +274,14 @@ The following software is highly recommended though not strictly required:
tests included with Kwant.
tests included with Kwant.
In addition, to build a copy of Kwant that has been checked-out directly from
In addition, to build a copy of Kwant that has been checked-out directly from
version control (git), you will also need `Cython <http://cython.org/>`_ 0.17.1
`its Git repository <http://git.kwant-project.org/kwant>`_, you will also need
or newer. You do not need Cython to build
Kwant that has been unpacked from a
`Cython <http://cython.org/>`_ 0.17.1
or newer. You do not need Cython to build
source .tar.gz-file.
Kwant that has been unpacked from a
source .tar.gz-file.
Generic instructions
Generic instructions
====================
====================
Please note the `system-specific instructions`_ below.
Kwant can be built and installed following the `usual Python conventions
Kwant can be built and installed following the `usual Python conventions
<http://docs.python.org/install/index.html>`_ by running the following commands
<http://docs.python.org/install/index.html>`_ by running the following commands
in the root directory of the Kwant distribution. ::
in the root directory of the Kwant distribution. ::
...
@@ -303,11 +300,8 @@ The tutorial examples can be found in the directory ``tutorial`` inside the root
...
@@ -303,11 +300,8 @@ The tutorial examples can be found in the directory ``tutorial`` inside the root
directory of the Kwant source distribution.
directory of the Kwant source distribution.
System-specific instructions
============================
Unix-like systems (GNU/Linux)
Unix-like systems (GNU/Linux)
-----------------------------
=============================
Kwant should run on all recent Unix-like systems. The following instructions
Kwant should run on all recent Unix-like systems. The following instructions
have been verified to work on Debian 7 (Wheezy) or newer, and on Ubuntu 12.04 or
have been verified to work on Debian 7 (Wheezy) or newer, and on Ubuntu 12.04 or
...
@@ -349,8 +343,8 @@ You can make this setting permanent by adding this line to the file
...
@@ -349,8 +343,8 @@ You can make this setting permanent by adding this line to the file
``.bashrc`` (or equivalent) in your home directory.
``.bashrc`` (or equivalent) in your home directory.
Mac OS X
Mac OS X
: MacPorts
--------
==================
The required dependencies of Kwant are best installed with one of the packaging
The required dependencies of Kwant are best installed with one of the packaging
systems. Here we only consider the case of `MacPorts
systems. Here we only consider the case of `MacPorts
...
@@ -392,8 +386,8 @@ no Apple Fortran compiler). For this reason we force the Gnu compiler suite
...
@@ -392,8 +386,8 @@ no Apple Fortran compiler). For this reason we force the Gnu compiler suite
with the environment variables ``CC`` and ``LDSHARED`` as shown above.
with the environment variables ``CC`` and ``LDSHARED`` as shown above.
Notes on
homebrew
Mac OS X:
homebrew
.................
==================
It is also possible to build Kwant using homebrew. The dependencies can be
It is also possible to build Kwant using homebrew. The dependencies can be
installed as ::
installed as ::
...
...
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