Commit 8bbf6e76 authored by Kloss's avatar Kloss

add conda installation and update contributors

parent 6e40930d
......@@ -14,16 +14,41 @@ Website: https://kwant-project.org/extensions/kwantspectrum
Source code: https://gitlab.kwant-project.org/kwant/kwantspectrum
Conda package: https://github.com/conda-forge/kwantspectrum-feedstock
Installation
############
This section covers the installation of kwantSpectrum on a GNU/Linux
system as Debian and Ubuntu via the command line.
kwantSpectrum packages are hosted on PyPI and conda.
The installation should work GNU/Linux system as Debian and Ubuntu,
as well as on MacOS and Windows.
Requirements
^^^^^^^^^^^^
**PyPI**::
python3 -m pip install --user kwantspectrum
**conda**::
conda install -c conda-forge kwantspectrum
Installation from source
^^^^^^^^^^^^^^^^^^^^^^^^
kwantSpectrum can be installed directly from the source code repository::
python3 -m pip install --user git+https://gitlab.kwant-project.org/kwant/kwantspectrum.git
For development, kwantSpectrum can be cloned from the official repository with::
git clone https://gitlab.kwant-project.org/kwant/kwantspectrum.git
The requirements listed below must be installed by hand.
Build requirements
------------------
kwantSpectrum has following non-Python dependency:
......@@ -41,10 +66,9 @@ be installed to build kwantSpectrum:
- `NumPy <https://numpy.org/>`_
- `SciPy <https://www.scipy.org/>`_
Most packages can be installed from the command line
by the standard Python package manager `pip <https://pip.pypa.io/en/stable/>`_ via::
The packages can be installed by the standard *pip* command::
sudo pip3 install numpy scipy
python3 -m pip install --user numpy scipy
Testing requirements
--------------------
......@@ -57,7 +81,7 @@ The kwantSpectrum test suite requires the following Python packages:
The packages can be installed by the standard *pip* command::
sudo pip3 install pytest pytest-cov pytest-flake8
python3 -m pip install --user pytest pytest-cov pytest-flake8
Documentation requirements
--------------------------
......@@ -70,22 +94,8 @@ Building the documentation requires the following Python packages:
The packages can be installed by the standard *pip* command::
sudo pip3 install matplotlib sphinx jupyter-sphinx
Building kwantSpectrum
^^^^^^^^^^^^^^^^^^^^^^
kwantSpectrum can be installed from PyPI with::
sudo pip3 install kwantspectrum
python3 -m pip install --user matplotlib sphinx jupyter-sphinx
Alternatively, it can be installed directly from the source code repository::
sudo pip3 install git+https://gitlab.kwant-project.org/kwant/kwantspectrum.git
For development, kwantSpectrum can be cloned from the official repository with::
git clone https://gitlab.kwant-project.org/kwant/kwantspectrum.git
Test suite
----------
......@@ -157,5 +167,6 @@ Contributors to the project are:
* Christoph Groth (CEA Grenoble)
* Xavier Waintal (CEA Grenoble)
* Benoît Rossignol (CEA Grenoble)
* Bas Nijholt (Microsoft)
(CEA = Commissariat à l'énergie atomique et aux énergies alternatives)
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