Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
Fixed formatting for latex math
Browse files Browse the repository at this point in the history
  • Loading branch information
anand43 committed Feb 29, 2024
1 parent 403c5be commit 6eeb6c8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/user-guide/basic-simulation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/detailed-simulation-setup/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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()``.
Expand Down

0 comments on commit 6eeb6c8

Please sign in to comment.