.. literalinclude:: _includes/README.md
   :language: md
   :lines: 2-7

.. _nekrs:

The nekRS Computational Fluid Dynamics Code
===================================================

.. mdinclude:: _includes/README.md
   :start-line: 12
   :end-line: 28

This documentation is intended to help new users get started with using *nekRS*, as well as serve as a reference for more advanced users.
For the uninitated user we recommend working through this user guide in the order below. 
At the very least, please read :ref:`case` page for a description of *nekRS* case setup and case file structure.

.. note::

   The instructions in this documentation are specific to `v26.x <https://github.com/Nek5000/nekRS/tree/master>`_.
   The documentation does not currently support earlier versions of *nekRS*.

.. note::

   This documentation is a work in progress, and is expected to undergo major changes as more features are added to nekRS. 
   Please open issues on the `nekRS documentation Github repository <https://github.com/Nek5000/nekRS_doc>`_ to track any missing information or to request modification of existing information.

Table of Contents
-----------------

.. toctree::
   :maxdepth: 2

   quickstart
   problem_setup/_problem_setup
   tutorials/_tutorials
   developer_guide/_developer_guide
   theory
   other_resources
   glossary
   references

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

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

Versioning
----------

.. mdinclude:: _includes/README.md
   :start-line: 72
   :end-line: 74

.. mdinclude:: _includes/README.md
   :start-line: 87
   :end-line: 108