From 6eeb6c893f370b4a7b0fc53494ec411c74d625f1 Mon Sep 17 00:00:00 2001 From: anand43 Date: Thu, 29 Feb 2024 17:19:07 -0500 Subject: [PATCH] Fixed formatting for latex math --- docs/user-guide/basic-simulation/index.rst | 6 +++--- docs/user-guide/detailed-simulation-setup/index.rst | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/basic-simulation/index.rst b/docs/user-guide/basic-simulation/index.rst index 6c7a6238b..940c62138 100644 --- a/docs/user-guide/basic-simulation/index.rst +++ b/docs/user-guide/basic-simulation/index.rst @@ -5,7 +5,7 @@ Basic Simulation Here, we will walk you through the basic features of Swiftest and using them in Python. This is based on ``/Basic_Simulation`` in ``swiftest/examples``. -Start with importing Swiftest and other packages we will use in this tutorial. :: +Start with importing Swiftest. :: import swiftest @@ -40,8 +40,8 @@ Add other small bodies too: :: Running the Simulation ======================== -We now set up the simulation parameters. Here we have a simulation starting from :math: `0.0 y` and running for :math: `1 My = 1e6 years` -with time steps of :math: `0.01 years`. :: +We now set up the simulation parameters. Here we have a simulation starting from `0.0 y` and running for `1 My = 1e6 years` +with time steps of `0.01 years`. :: sim.set_parameter(tstart=0.0, tstop=1.0e6, dt=0.01) diff --git a/docs/user-guide/detailed-simulation-setup/index.rst b/docs/user-guide/detailed-simulation-setup/index.rst index 16226894e..d5212ffbd 100644 --- a/docs/user-guide/detailed-simulation-setup/index.rst +++ b/docs/user-guide/detailed-simulation-setup/index.rst @@ -146,8 +146,8 @@ This can be done in multiple ways: sim.set_parameter(tstart=0.0, tstop=1.0e6, dt=0.01, istep_out=100, dump_cadence=0, compute_conservation_values=True, mtiny=mtiny) sim.set_parameter(rmin = 0.05) -We now set up the simulation parameters. Here we have a simulation starting from :math: `0.0 y` and running for :math: `1 My = 1e6 years` -with time steps of :math: `0.01 years`. The timestep should be less than or equal to :math: `\frac{1}{10}` of the orbital period of the innermost body. +We now set up the simulation parameters. Here we have a simulation starting from `0.0 y` and running for `1 My = 1e6 years` +with time steps of `0.01 years`. The timestep should be less than or equal to 1/10 of the orbital period of the innermost body. The user can then write the parameters to the `param.in` file by using ``sim.write_param()``. To see the parameters of the simulation, use ``sim.get_parameter()``.