From 0c45d8d2df651b34e222fb2963e9558e2988a0f5 Mon Sep 17 00:00:00 2001 From: David Minton Date: Fri, 1 Mar 2024 19:15:30 -0500 Subject: [PATCH] Restructured the user guide and added authorship credits to the pages --- .../index.rst => basic-simulation.rst} | 4 +++- .../index.rst => detailed-simulation-setup.rst} | 2 ++ .../index.rst => gravitational-harmonics.rst} | 2 ++ docs/user-guide/index.rst | 12 ++++++------ 4 files changed, 13 insertions(+), 7 deletions(-) rename docs/user-guide/{basic-simulation/index.rst => basic-simulation.rst} (99%) rename docs/user-guide/{detailed-simulation-setup/index.rst => detailed-simulation-setup.rst} (99%) rename docs/user-guide/{gravitational-harmonics/index.rst => gravitational-harmonics.rst} (99%) diff --git a/docs/user-guide/basic-simulation/index.rst b/docs/user-guide/basic-simulation.rst similarity index 99% rename from docs/user-guide/basic-simulation/index.rst rename to docs/user-guide/basic-simulation.rst index 32bd6ffaa..e286035bf 100644 --- a/docs/user-guide/basic-simulation/index.rst +++ b/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 `__. diff --git a/docs/user-guide/detailed-simulation-setup/index.rst b/docs/user-guide/detailed-simulation-setup.rst similarity index 99% rename from docs/user-guide/detailed-simulation-setup/index.rst rename to docs/user-guide/detailed-simulation-setup.rst index 3b0ab0279..e10f3ddbe 100644 --- a/docs/user-guide/detailed-simulation-setup/index.rst +++ b/docs/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/docs/user-guide/gravitational-harmonics/index.rst b/docs/user-guide/gravitational-harmonics.rst similarity index 99% rename from docs/user-guide/gravitational-harmonics/index.rst rename to docs/user-guide/gravitational-harmonics.rst index 1e5dfc4f8..2668b939e 100644 --- a/docs/user-guide/gravitational-harmonics/index.rst +++ b/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 `__ 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 index faa81fdc3..db5711584 100644 --- 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 ` +- Setting up a :doc:`Basic Simulation ` -- A more in-depth :doc:`Detailed Simulation Setup ` +- A more in-depth :doc:`Detailed Simulation Setup ` -- Understanding the :doc:`Gravitational Harmonics capabilities ` +- Understanding the :doc:`Gravitational Harmonics capabilities ` .. toctree:: :maxdepth: 2 :hidden: - Basic Simulation - Detailed Simulation Setup - Gravitational Harmonics \ No newline at end of file + Basic Simulation + Detailed Simulation Setup + Gravitational Harmonics \ No newline at end of file