Restructured the user guide and added authorship credits to the pages

MintonGroup · Mar 2, 2024 · 0c45d8d · 0c45d8d
1 parent dd360f2
commit 0c45d8d
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 7 deletions.
diff --git a/docs/user-guide/basic-simulation/index.rst → docs/user-guide/basic-simulation.rst b/docs/user-guide/basic-simulation/index.rst → docs/user-guide/basic-simulation.rst
@@ -2,6 +2,8 @@
 Basic Simulation
 #################
 
+.. rubric:: by David A. Minton
+
 Here, we will walk you through the basic features of Swiftest and using them in Python. 
 
 Start with importing Swiftest. ::
@@ -196,7 +198,7 @@ Here is an example where we can generate a simple plot of the semimajor axis vs.
 
   sim.data['a'].where(sim.data.particle_type != 'Central Body', drop=True).plot(x='time',hue='name')
 
-.. image:: ../../_static/basic_simulation_a_vs_t_plot.png
+.. image:: ../_static/basic_simulation_a_vs_t_plot.png
 
 This is just a simple example of what you can do with the simulation data. Xarray has a large number of built-in plotting and 
 data processing functions. For more information, see the `Xarray documentation <https://docs.xarray.dev/en/stable/>`__.

diff --git a/...guide/detailed-simulation-setup/index.rst → .../user-guide/detailed-simulation-setup.rst b/...guide/detailed-simulation-setup/index.rst → .../user-guide/detailed-simulation-setup.rst
@@ -2,6 +2,8 @@
 Detailed Simulation
 #####################
 
+.. rubric:: by Kaustub Anand
+
 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``.
 

diff --git a/...r-guide/gravitational-harmonics/index.rst → docs/user-guide/gravitational-harmonics.rst b/...r-guide/gravitational-harmonics/index.rst → docs/user-guide/gravitational-harmonics.rst
@@ -2,6 +2,8 @@
 Gravitational Harmonics
 ##########################
 
+.. rubric:: by Kaustub Anand
+
 Here, we show how to use Swiftest's Gravitational Harmonics capabilities. This is based on ``spherical_harmonics_cb`` 
 in ``swiftest/examples``. Swiftest uses `SHTOOLS <https://shtools.github.io/SHTOOLS/>`__ to compute the gravitational 
 harmonics coefficients for a given body and calculate it's associated acceleration kick. The conventions and formulae used here 

diff --git a/docs/user-guide/index.rst b/docs/user-guide/index.rst
@@ -4,16 +4,16 @@ User Guide
 
 In this user guide, you will find detailed descriptions and examples that describe the many capabilities of Swiftest and how to use them.
 
-- Setting up a :doc:`Basic Simulation <basic-simulation/index>`
+- Setting up a :doc:`Basic Simulation <basic-simulation>`
 
-- A more in-depth :doc:`Detailed Simulation Setup <detailed-simulation-setup/index>`
+- A more in-depth :doc:`Detailed Simulation Setup <detailed-simulation-setup>`
 
-- Understanding the :doc:`Gravitational Harmonics capabilities <gravitational-harmonics/index>`
+- Understanding the :doc:`Gravitational Harmonics capabilities <gravitational-harmonics>`
 
 .. toctree::
    :maxdepth: 2
    :hidden:
 
-   Basic Simulation <basic-simulation/index>
-   Detailed Simulation Setup <detailed-simulation-setup/index>
-   Gravitational Harmonics <gravitational-harmonics/index>
+   Basic Simulation <basic-simulation>
+   Detailed Simulation Setup <detailed-simulation-setup>
+   Gravitational Harmonics <gravitational-harmonics>