Skip to content

Latest commit

 

History

History
138 lines (96 loc) · 4.04 KB

index.rst

File metadata and controls

138 lines (96 loc) · 4.04 KB
.. module:: sisl

sisl: Toolbox for electronic structure calculations

The Python library sisl was born out of a need to handle (create and read), manipulate and analyse output from DFT programs. It was initially developed by Nick Papior (co-developer of `Siesta`_) as a side-project to `TranSiesta`_ and `TBtrans`_ to efficiently analyse TBtrans output for N-electrode calculations.

Since then it has expanded to accommodate a rich set of DFT code input/outputs.

.. grid:: 1 1 2 2
    :gutter: 2

    .. grid-item-card:: :fas:`person-running` -- Quick-start guides
        :link: quickstart/index
        :link-type: doc

        New to `sisl`? Quickly get started with basic tutorials
        and getting used to the basic details of `sisl`.

    .. grid-item-card::  :fas:`book-open` -- User guide

        .. The user guide provides a set of how-to's explaining
        .. more usages in greater details.

    .. grid-item-card::  :fas:`book-open` -- API reference
        :link: api/index
        :link-type: doc

        Already familiar with `sisl` and how to use it? Look through
        the API section to discover more functionality and details
        on the parameters and in-depth usage.

    .. grid-item-card:: :fab:`discord` -- Chat with us
        :link: https://discord.gg/5XnFXFdkv2
        :link-type: url

        Join our Discord channel to share scripts, get help, or simply hang
        out.


sisl is also part of the training material for a series of workshops hosted `here <workshop_>`_.

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Getting started

   introduction
   quickstart/index
   cite

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: User Guide

   tutorials/index
   visualization/index
   scripts/index

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Advanced usage

   api/index
   environment
   toolbox/index

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Development

   dev/index

.. toctree::
   :hidden:
   :maxdepth: 3
   :caption: Extras

   math
   release
   other
   references