===============================================
National Infrastructure Resilience Demonstrator
===============================================

``nird`` is a Python package to help with analysis of the resilience of national
infrastructure networks.

.. image:: https://img.shields.io/badge/github-nird-brightgreen.svg
   :target: https://github.com/nismod/DAFNI-NIRD/
   :alt: nird on github

.. mdinclude:: ../../README.md
   :start-line: 4
   :end-line: 59

.. toctree::
   :maxdepth: 2
   :caption: Contents:


Contents
--------

.. toctree::
   :maxdepth: 2

   Getting Started <getting_started>

.. toctree::
   :maxdepth: 3

   Reference <api/modules>

.. toctree::
   :maxdepth: 1

   License <license>


Indices and tables
------------------

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