Dichalcogenides
===============

Contents
--------

.. toctree::
   :maxdepth: 2

   parameters
   model
   dichalcogenide
   superconductor
   about

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Dichalcogenides
===============

Python analysis code for dichalcogenide systems.

Considered unstable and in development until version 1.0.0 is released.

This documentation covers the module API and usage.
For basic installation and development instructions,
refer to README_ hosted with the source on GitHub.

.. _README: https://github.com/razor-x/dichalcogenides

Contents
--------

.. toctree::
   :maxdepth: 2

   parameters
   model
   dichalcogenide
   superconductor
   about

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Add note to docs about README
Add note to docs about README
