Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FAQ section to documentation #2450

Merged
merged 3 commits into from
Oct 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. _installation:

**************************
Frequently Asked Questions
**************************

Overview
--------

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

- :ref:`faq-usage`

- :ref:`faq-usage-memory`


.. _faq-usage:

Usage
-----

.. _faq-usage-memory:

My simulation seems to consume excessive amounts of memory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


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

1. Enabling ``track_rpacket: true`` will take up substantial
amounts of memory, in particular for higher packet counts.
Consider turning this feature off or only use it with a
small amount of packets.
2. Both the number of shells and the number of packets
sonachitchyan marked this conversation as resolved.
Show resolved Hide resolved
increase the memory requirements. Consider using only
as many shells/ packets as are required to converge
on a result.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Mission Statement
installation
quickstart
tutorials
faq
API <api/modules>


Expand Down