Installation¶
sisl is easy to install using any of your preferred methods.
Required dependencies¶
- Python 2.7, 3.4 or above
- six
- setuptools
- numpy (1.10 or later)
- scipy
- netCDF4-python
- pyparsing
- A C- and fortran-compiler
Optional dependencies:
- pytest (for running the test suite)
- matplotlib
- tqdm (for displaying progress-bars)
- xarray (for advanced table data structures in certain methods)
sisl implements certain methods in Cython which speeds up the execution. Cython is required if one wishes to re-generate the C-sources with a different Cython version. Note that this is not a necessary step and should typically only be considered by developers of Cython modules.
pip¶
Installing sisl using PyPi can be done using
pip install sisl
# or
pip install sisl[analysis]
pip will automatically install the required dependencies. The optional dependencies
will be used if later installed.
The latter installation call also installs tqdm and xarray which are part of
extended analysis methods. These are not required and may be installed later if their usage
is desired.
conda¶
Installing sisl using conda can be done by
conda config --add channels conda-forge
conda install sisl
To find more information about the conda-forge installation please see here.
Manual installation¶
sisl may be installed using the regular setup.py script.
Ensure the required dependencies are installed before proceeding with the
manual installation (without numpy installed a spurious error message will
appear). The dependencies may be installed using this pip command:
pip install -r requirements.txt
Simply download the release tar from this page, or clone the git repository for the latest developments
python setup.py install --prefix=<prefix>