Commit ff7eb28c authored by Anton Akhmerov's avatar Anton Akhmerov
Browse files

update links in documentation

In addition to basic updates to skip permanent redirect, remove an
obsolete reference to macports installation instructions on the main
website.
parent a6547b2d
...@@ -7,7 +7,7 @@ The Kwant authors can be reached at authors@kwant-project.org. ...@@ -7,7 +7,7 @@ The Kwant authors can be reached at authors@kwant-project.org.
The principal developers of Kwant are The principal developers of Kwant are
* `Christoph W. Groth <mailto://christoph.groth@cea.fr>`_ (INAC/CEA Grenoble) * `Christoph W. Groth <mailto://christoph.groth@cea.fr>`_ (INAC/CEA Grenoble)
* `Michael Wimmer <http://michaelwimmer.org>`_ (TU Delft) * `Michael Wimmer <https://michaelwimmer.org>`_ (TU Delft)
* `Anton R. Akhmerov <http://antonakhmerov.org>`_ (TU Delft) * `Anton R. Akhmerov <http://antonakhmerov.org>`_ (TU Delft)
* `Xavier Waintal <http://inac.cea.fr/Pisp/xavier.waintal>`_ (INAC/CEA Grenoble) * `Xavier Waintal <http://inac.cea.fr/Pisp/xavier.waintal>`_ (INAC/CEA Grenoble)
* `Joseph Weston <http://josephweston.org>`_ (INAC/CEA Grenoble) * `Joseph Weston <http://josephweston.org>`_ (INAC/CEA Grenoble)
......
...@@ -32,7 +32,7 @@ Building Kwant requires ...@@ -32,7 +32,7 @@ Building Kwant requires
* `Python <https://www.python.org/>`_ 3.4 or above (Kwant 1.1 is the last * `Python <https://www.python.org/>`_ 3.4 or above (Kwant 1.1 is the last
version to support Python 2), version to support Python 2),
* `NumPy <http://numpy.org/>`_ 1.8.1 or newer, * `NumPy <http://numpy.org/>`_ 1.8.1 or newer,
* `SciPy <http://scipy.org/>`_ 0.13.3 or newer, * `SciPy <https://scipy.org/>`_ 0.13.3 or newer,
* `LAPACK <http://netlib.org/lapack/>`_ and `BLAS <http://netlib.org/blas/>`_, * `LAPACK <http://netlib.org/lapack/>`_ and `BLAS <http://netlib.org/blas/>`_,
(For best performance we recommend the free `OpenBLAS (For best performance we recommend the free `OpenBLAS
<http://www.openblas.net/>`_ or the nonfree `MKL <http://www.openblas.net/>`_ or the nonfree `MKL
...@@ -156,7 +156,7 @@ Building the documentation ...@@ -156,7 +156,7 @@ Building the documentation
To build the documentation, the `Sphinx documentation generator To build the documentation, the `Sphinx documentation generator
<http://www.sphinx-doc.org/en/stable/>`_ is required with ``numpydoc`` extension <http://www.sphinx-doc.org/en/stable/>`_ is required with ``numpydoc`` extension
(version 0.5 or newer). If PDF documentation is to be built, the tools (version 0.5 or newer). If PDF documentation is to be built, the tools
from the `libRSVG <http://live.gnome.org/LibRsvg>`_ (Debian/Ubuntu package from the `libRSVG <https://wiki.gnome.org/action/show/Projects/LibRsvg>`_ (Debian/Ubuntu package
``librsvg2-bin``) are needed to convert SVG drawings into the PDF format. ``librsvg2-bin``) are needed to convert SVG drawings into the PDF format.
As a prerequisite for building the documentation, Kwant must have been built As a prerequisite for building the documentation, Kwant must have been built
...@@ -216,11 +216,7 @@ systems. Here we only consider the case of `MacPorts ...@@ -216,11 +216,7 @@ systems. Here we only consider the case of `MacPorts
below. below.
1. Install a recent version of MacPorts, as explained in the `installation 1. Install a recent version of MacPorts, as explained in the `installation
instructions of MacPorts <https://www.macports.org/install.php>`_. `The instructions of MacPorts <https://www.macports.org/install.php>`_.
MacPorts section of the Kwant website
<https://kwant-project.org/install#mac-os-x-macports>`_ may be also of
interest. (Note that it describes how to install Kwant using a ports file,
while the aim here is to install from source manually.)
2. Install the required dependencies:: 2. Install the required dependencies::
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
.. module:: kwant.solvers.sparse .. module:: kwant.solvers.sparse
This solver uses SciPy's `scipy.sparse.linalg This solver uses SciPy's `scipy.sparse.linalg
<http://docs.scipy.org/doc/scipy/reference/sparse.linalg.html>`_. The <https://docs.scipy.org/doc/scipy/reference/sparse.linalg.html>`_. The
interface is identical to that of the :mod:`default solver interface is identical to that of the :mod:`default solver
<kwant.solvers.default>`. <kwant.solvers.default>`.
......
...@@ -325,7 +325,7 @@ subbands that increases with energy. ...@@ -325,7 +325,7 @@ subbands that increases with energy.
.. rubric:: Footnotes .. rubric:: Footnotes
.. [#] http://xkcd.com/353/ .. [#] https://xkcd.com/353/
.. [#] Leads are numbered in the python convention, starting from 0. .. [#] Leads are numbered in the python convention, starting from 0.
Building the same system with less code Building the same system with less code
......
...@@ -71,7 +71,7 @@ In this example, we compute the wave functions of a closed circular quantum dot ...@@ -71,7 +71,7 @@ In this example, we compute the wave functions of a closed circular quantum dot
and its spectrum as a function of magnetic field (Fock-Darwin spectrum). and its spectrum as a function of magnetic field (Fock-Darwin spectrum).
To compute the eigenenergies and eigenstates, we will make use of the sparse To compute the eigenenergies and eigenstates, we will make use of the sparse
linear algebra functionality of `SciPy <http://www.scipy.org>`_, which linear algebra functionality of `SciPy <https://www.scipy.org>`_, which
interfaces the ARPACK package: interfaces the ARPACK package:
.. literalinclude:: closed_system.py .. literalinclude:: closed_system.py
...@@ -139,7 +139,7 @@ it using `kwant.plotter.current`: ...@@ -139,7 +139,7 @@ it using `kwant.plotter.current`:
matrix, if the optional argument ``sparse=True``. The sparse matrix is in matrix, if the optional argument ``sparse=True``. The sparse matrix is in
SciPy's ``scipy.sparse.coo_matrix`` format, which can be easily be converted SciPy's ``scipy.sparse.coo_matrix`` format, which can be easily be converted
to various other sparse matrix formats (see `SciPy's documentation to various other sparse matrix formats (see `SciPy's documentation
<http://docs.scipy.org/doc/scipy/reference/>`_). <https://docs.scipy.org/doc/scipy/reference/>`_).
.. rubric:: Footnotes .. rubric:: Footnotes
......
Supports Markdown
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