Skip to content

Commit

Permalink
Added Overview
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexHls committed Oct 18, 2023
1 parent eb9d9f0 commit d10b6d5
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@
Frequently Asked Questions
**************************

Overview
--------

Welcome to the FAQ section! Here, you'll find answers to common questions about TARDIS.

- :ref:`faq-usage` - Questions related to the usage of TARDIS

- :ref:`faq-usage-memory` - My simulation seems to consume excessive amounts of memory

Overview
--------

Welcome to our FAQ section! Here, you'll find answers to common questions about our software.

- :ref:`faq-installation` - How do I install the software?
- :ref:`faq-usage` - How do I perform a specific task?

Usage
-----

Expand All @@ -12,6 +29,8 @@ Usage
My simulation seems to consume excessive amounts of memory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. _faq-usage-memory:

High memory usage can have many reasons. Both your model
and certain simulation settings can increase the memory
usage significantly
Expand Down

0 comments on commit d10b6d5

Please sign in to comment.