Welcome to SWIFTsimIO's documentation!
======================================

.. include:: ../../README.rst
   :start-after: INTRO_START_LABEL
   :end-before: INTRO_END_LABEL

.. grid:: 1 2 1 2
    :margin: 5 5 0 0
    :padding: 0 0 0 0
    :gutter: 4

    .. grid-item-card:: :octicon:`info` Getting started
        :text-align: center
        :class-title: sd-fs-5
        :class-card: sd-p-3

        .. button-ref:: getting_started/index
            :color: primary
            :outline:
            :expand:

            installation & quick-start


    .. grid-item-card:: :octicon:`code-square` Contributing
        :text-align: center
        :class-title: sd-fs-5
        :class-card: sd-p-3

        .. button-ref:: community/index
            :color: primary
            :outline:
            :expand:

            information for developers

        .. button-link:: https://github.com/SWIFTSIM/swiftsimio
            :color: primary
            :outline:
            :expand:

            :octicon:`mark-github` source code :octicon:`link-external`

    .. grid-item-card:: :octicon:`file-badge` Reference documentation
        :text-align: center
        :class-title: sd-fs-5
        :class-card: sd-p-3

        .. button-ref:: modules/index
            :click-parent:
            :color: primary
            :outline:
            :expand:

            lists of modules and functions

    .. grid-item-card:: :octicon:`bookmark` Publishing?
        :text-align: center
        :class-title: sd-fs-5
        :class-card: sd-p-3

        .. button-ref:: citing/index
            :click-parent:
            :color: primary
            :outline:
            :expand:

            citation information

Documentation contents
----------------------

.. toctree::
   :maxdepth: 2

   getting_started/index
   citing/index
   loading_data/index
   cosmo_array/index
   masking/index
   visualisation/index
   soap/index
   velociraptor/index
   creating_initial_conditions/index
   statistics/index
   command_line/index
   community/index

   modules/index


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

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