Commit 6ca32422 authored by Christoph Groth's avatar Christoph Groth

provide installation instructions

parent b8578091
......@@ -22,24 +22,56 @@ Tinyarray is licensed under the "simplified BSD License". See `<LICENSE>`_.
Website: http://git.kwant-project.org/tinyarray/about/
Source code
-----------
Source tarballs are available at http://downloads.kwant-project.org/tinyarray/
Clone the Git repository with ::
git clone http://git.kwant-project.org/tinyarray
Installation
------------
Prepared packages exist for Debian, Ubuntu, Windows, and Mac OS X. Follow the
`installation instructions for "Kwant" <http://kwant-project/install>`_ up to
the point where Tinyarray has been installed.
You can build from source with the usual ``python setup.py install``. ``pip
install tinyarray`` should also work.
``pip install tinyarray`` should also work.
Prepared packages also exist:
* Windows
Source
------
Use `Christoph Gohlke's installer
<http://www.lfd.uci.edu/~gohlke/pythonlibs/#tinyarray>`_.
Source tarballs are available at http://downloads.kwant-project.org/tinyarray/
* Ubuntu and derivatives ::
Clone the Git repository with ::
sudo apt-add-repository ppa:kwant-project/ppa
sudo apt-get update
sudo apt-get install python-tinyarray
git clone http://git.kwant-project.org/tinyarray
* Debian and derivatives
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::
sudo apt-get update
sudo apt-get install python-tinyarray
* Mac OS X
Follow the `instructions for installing "Kwant"
<http://kwant-project.org/install#mac-os-x>`_ but install
``py27-tinyarray`` instead of ``py27-kwant`` etc.
Usage example
......
Markdown is supported
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