Skip to content

Commit

Permalink
Jaladh's suggested changes
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacgsmith committed Jun 25, 2021
1 parent c93d3da commit 0422f31
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/io/configuration/components/plasma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ TARDIS currently supports three different kinds of line interaction: ``scatter``
version of ``macroatom`` in which only downward transitions are allowed (see :ref:`lineinteraction`).

Finally, ``w_epsilon`` describes the dilution factor to use to calculate :math:`J_\textrm{blue}` that are 0, which
causes problemsl with the code (so :math:`J_\textrm{blue}` are set to a very small number).
causes problems with the code (so :math:`J_\textrm{blue}` are set to a very small number).

NLTE
^^^^
Expand Down
13 changes: 10 additions & 3 deletions docs/io/optional/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Optional Inputs
***************

TARDIS also allows other inputs that are passed as arguments into the ``run_tardis`` function.
TARDIS also allows other inputs that are passed as keyword arguments into the ``run_tardis`` function.

.. toctree::
:maxdepth: 1
Expand All @@ -13,6 +13,13 @@ TARDIS also allows other inputs that are passed as arguments into the ``run_tard
callback_example


Additionally, ``run_tardis`` can take in a filepath for the atomic data and a boolian for virtual packet logging, both of
which are also options in the :ref:`configuration file <config-components>`. The options to pass them inside ``run_tardis``
Additionally, ``run_tardis`` can take in a filepath for the atomic data and a boolian for virtual packet logging. For example:

.. code-block:: python
from tardis.base import run_tardis
sim = run_tardis('configuration_file', atom_data='filepath_to_atomic_data', virtual_packet_logging=True)
Both of these are also options in the :ref:`configuration file <config-components>`. The option to pass them inside ``run_tardis``
may be removed in a future release of the code.
2 changes: 2 additions & 0 deletions docs/io/output/vpacket_logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ After running the simulation, the following information can be retrieved:

* - Attribute of Simulation
- Description
* - ``virt_packet_logging``
- Boolean that shows if virtual packet logging is turned on
* - ``runner.virt_packet_nus``
- List of virtual packet frequencies
* - ``runner.virt_packet_energies``
Expand Down

0 comments on commit 0422f31

Please sign in to comment.