refactored code and updated readme

BlackHolePerturbationToolkit · Oct 6, 2023 · a9c7b94 · a9c7b94
1 parent ac60e38
commit a9c7b94
Show file tree

Hide file tree

Showing 57 changed files with 1,796 additions and 1,372 deletions.
diff --git a/README.md b/README.md
@@ -272,3 +272,7 @@ plt.ylabel(r"$\phi(\lambda)$")
 ![png](README_files/Getting%20Started_20_1.png)
 
 
+## Credit
+
+* Seyong Park
+* Zach Nasipak
diff --git a/...nitial_conditions.apex_from_constants.rst → ...rrgeopy.constants.apex_from_constants.rst b/...nitial_conditions.apex_from_constants.rst → ...rrgeopy.constants.apex_from_constants.rst
@@ -1,6 +1,6 @@
 apex\_from\_constants
 =====================
 
-.. currentmodule:: kerrgeopy.initial_conditions
+.. currentmodule:: kerrgeopy.constants
 
 .. autofunction:: apex_from_constants
diff --git a/docs/source/_autosummary/kerrgeopy.constants.plunging_radial_roots.rst b/docs/source/_autosummary/kerrgeopy.constants.plunging_radial_roots.rst
@@ -0,0 +1,6 @@
+plunging\_radial\_roots
+=======================
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: plunging_radial_roots
diff --git a/docs/source/_autosummary/kerrgeopy.constants.rst b/docs/source/_autosummary/kerrgeopy.constants.rst
@@ -16,13 +16,17 @@ constants
       :template: custom-base-template.rst
 
       angular_momentum
+      apex_from_constants
       carter_constant
       constants_of_motion
       energy
       fast_separatrix
       is_stable
+      plunging_radial_roots
       scale_constants
       separatrix
+      stable_polar_roots
+      stable_radial_roots
       valid_params
 
 

diff --git a/docs/source/_autosummary/kerrgeopy.constants.stable_polar_roots.rst b/docs/source/_autosummary/kerrgeopy.constants.stable_polar_roots.rst
@@ -0,0 +1,6 @@
+stable\_polar\_roots
+====================
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: stable_polar_roots
diff --git a/docs/source/_autosummary/kerrgeopy.constants.stable_radial_roots.rst b/docs/source/_autosummary/kerrgeopy.constants.stable_radial_roots.rst
@@ -0,0 +1,6 @@
+stable\_radial\_roots
+=====================
+
+.. currentmodule:: kerrgeopy.constants
+
+.. autofunction:: stable_radial_roots
diff --git a/...g_solutions.plunging_mino_frequencies.rst → ...frequencies.plunging_mino_frequencies.rst b/...g_solutions.plunging_mino_frequencies.rst → ...frequencies.plunging_mino_frequencies.rst
@@ -1,6 +1,6 @@
 plunging\_mino\_frequencies
 ===========================
 
-.. currentmodule:: kerrgeopy.plunging_solutions
+.. currentmodule:: kerrgeopy.frequencies
 
 .. autofunction:: plunging_mino_frequencies
diff --git a/docs/source/_autosummary/kerrgeopy.frequencies.rst b/docs/source/_autosummary/kerrgeopy.frequencies.rst
@@ -19,6 +19,7 @@ frequencies
       gamma
       mino_frequencies
       phi_frequency
+      plunging_mino_frequencies
       r_frequency
       theta_frequency
 

diff --git a/docs/source/_autosummary/kerrgeopy.frequencies_from_constants.rst b/docs/source/_autosummary/kerrgeopy.frequencies_from_constants.rst
diff --git a/docs/source/_autosummary/kerrgeopy.initial_conditions.rst b/docs/source/_autosummary/kerrgeopy.initial_conditions.rst
@@ -15,7 +15,6 @@ initial\_conditions
       :toctree:
       :template: custom-base-template.rst
 
-      apex_from_constants
       constants_from_initial_conditions
       is_stable
       plunging_orbit_initial_phases

diff --git a/docs/source/_autosummary/kerrgeopy.orbit.Orbit.rst b/docs/source/_autosummary/kerrgeopy.orbit.Orbit.rst
@@ -20,9 +20,8 @@
       ~Orbit.animate
       ~Orbit.constants_of_motion
       ~Orbit.four_velocity
-      ~Orbit.four_velocity_norm
       ~Orbit.is_visible
-      ~Orbit.orbital_parameters
+      ~Orbit.numerical_four_velocity
       ~Orbit.plot
       ~Orbit.trajectory
 

diff --git a/...errgeopy.plunging_orbit.PlungingOrbit.rst → ...ummary/kerrgeopy.plunge.PlungingOrbit.rst b/...errgeopy.plunging_orbit.PlungingOrbit.rst → ...ummary/kerrgeopy.plunge.PlungingOrbit.rst
@@ -1,7 +1,7 @@
 PlungingOrbit
 =============
 
-.. currentmodule:: kerrgeopy.plunging_orbit
+.. currentmodule:: kerrgeopy.plunge
 
 .. autoclass:: PlungingOrbit
    :members:
@@ -20,9 +20,8 @@
       ~PlungingOrbit.animate
       ~PlungingOrbit.constants_of_motion
       ~PlungingOrbit.four_velocity
-      ~PlungingOrbit.four_velocity_norm
       ~PlungingOrbit.is_visible
-      ~PlungingOrbit.orbital_parameters
+      ~PlungingOrbit.numerical_four_velocity
       ~PlungingOrbit.plot
       ~PlungingOrbit.trajectory
 

diff --git a/...ng_solutions.plunging_polar_solutions.rst → ...geopy.plunge.plunging_polar_solutions.rst b/...ng_solutions.plunging_polar_solutions.rst → ...geopy.plunge.plunging_polar_solutions.rst
@@ -1,6 +1,6 @@
 plunging\_polar\_solutions
 ==========================
 
-.. currentmodule:: kerrgeopy.plunging_solutions
+.. currentmodule:: kerrgeopy.plunge
 
 .. autofunction:: plunging_polar_solutions
diff --git a/...g_solutions.plunging_radial_integrals.rst → ...eopy.plunge.plunging_radial_integrals.rst b/...g_solutions.plunging_radial_integrals.rst → ...eopy.plunge.plunging_radial_integrals.rst
@@ -1,6 +1,6 @@
 plunging\_radial\_integrals
 ===========================
 
-.. currentmodule:: kerrgeopy.plunging_solutions
+.. currentmodule:: kerrgeopy.plunge
 
 .. autofunction:: plunging_radial_integrals
diff --git a/...ons.plunging_radial_solutions_complex.rst → ...nge.plunging_radial_solutions_complex.rst b/...ons.plunging_radial_solutions_complex.rst → ...nge.plunging_radial_solutions_complex.rst
@@ -1,6 +1,6 @@
 plunging\_radial\_solutions\_complex
 ====================================
 
-.. currentmodule:: kerrgeopy.plunging_solutions
+.. currentmodule:: kerrgeopy.plunge
 
 .. autofunction:: plunging_radial_solutions_complex
diff --git a/docs/source/_autosummary/kerrgeopy.plunge.plunging_trajectory.rst b/docs/source/_autosummary/kerrgeopy.plunge.plunging_trajectory.rst
@@ -0,0 +1,6 @@
+plunging\_trajectory
+====================
+
+.. currentmodule:: kerrgeopy.plunge
+
+.. autofunction:: plunging_trajectory
diff --git a/...osummary/kerrgeopy.plunging_solutions.rst → .../source/_autosummary/kerrgeopy.plunge.rst b/...osummary/kerrgeopy.plunging_solutions.rst → .../source/_autosummary/kerrgeopy.plunge.rst
@@ -1,7 +1,7 @@
-plunging\_solutions
-===================
+plunge
+======
 
-.. automodule:: kerrgeopy.plunging_solutions
+.. automodule:: kerrgeopy.plunge
 
 
 
@@ -15,15 +15,23 @@ plunging\_solutions
       :toctree:
       :template: custom-base-template.rst
 
-      plunging_mino_frequencies
       plunging_polar_solutions
       plunging_radial_integrals
       plunging_radial_solutions_complex
+      plunging_trajectory
 
 
 
 
 
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      PlungingOrbit
+
 
 
 

diff --git a/docs/source/_autosummary/kerrgeopy.plunging_orbit.rst b/docs/source/_autosummary/kerrgeopy.plunging_orbit.rst
diff --git a/docs/source/_autosummary/kerrgeopy.rst b/docs/source/_autosummary/kerrgeopy.rst
@@ -30,13 +30,10 @@
 
    ~kerrgeopy.constants
    ~kerrgeopy.frequencies
-   ~kerrgeopy.frequencies_from_constants
    ~kerrgeopy.initial_conditions
    ~kerrgeopy.orbit
-   ~kerrgeopy.plunging_orbit
-   ~kerrgeopy.plunging_solutions
+   ~kerrgeopy.plunge
    ~kerrgeopy.spacetime
-   ~kerrgeopy.stable_orbit
-   ~kerrgeopy.stable_solutions
+   ~kerrgeopy.stable
    ~kerrgeopy.units
 
diff --git a/docs/source/_autosummary/kerrgeopy.spacetime.KerrSpacetime.rst b/docs/source/_autosummary/kerrgeopy.spacetime.KerrSpacetime.rst
@@ -18,11 +18,9 @@
 
       ~KerrSpacetime.__init__
       ~KerrSpacetime.four_velocity
-      ~KerrSpacetime.inner_horizon
       ~KerrSpacetime.is_stable
       ~KerrSpacetime.metric
       ~KerrSpacetime.norm
-      ~KerrSpacetime.outer_horizon
       ~KerrSpacetime.separatrix
 
 

diff --git a/...ry/kerrgeopy.stable_orbit.StableOrbit.rst → ...osummary/kerrgeopy.stable.StableOrbit.rst b/...ry/kerrgeopy.stable_orbit.StableOrbit.rst → ...osummary/kerrgeopy.stable.StableOrbit.rst
@@ -1,7 +1,7 @@
 StableOrbit
 ===========
 
-.. currentmodule:: kerrgeopy.stable_orbit
+.. currentmodule:: kerrgeopy.stable
 
 .. autoclass:: StableOrbit
    :members:
@@ -20,12 +20,11 @@
       ~StableOrbit.animate
       ~StableOrbit.constants_of_motion
       ~StableOrbit.four_velocity
-      ~StableOrbit.four_velocity_norm
       ~StableOrbit.from_constants
       ~StableOrbit.fundamental_frequencies
       ~StableOrbit.is_visible
       ~StableOrbit.mino_frequencies
-      ~StableOrbit.orbital_parameters
+      ~StableOrbit.numerical_four_velocity
       ~StableOrbit.plot
       ~StableOrbit.trajectory
 

diff --git a/...eopy.stable_solutions.polar_solutions.rst → ...mary/kerrgeopy.stable.polar_solutions.rst b/...eopy.stable_solutions.polar_solutions.rst → ...mary/kerrgeopy.stable.polar_solutions.rst
@@ -1,6 +1,6 @@
 polar\_solutions
 ================
 
-.. currentmodule:: kerrgeopy.stable_solutions
+.. currentmodule:: kerrgeopy.stable
 
 .. autofunction:: polar_solutions
diff --git a/...opy.stable_solutions.radial_solutions.rst → ...ary/kerrgeopy.stable.radial_solutions.rst b/...opy.stable_solutions.radial_solutions.rst → ...ary/kerrgeopy.stable.radial_solutions.rst
@@ -1,6 +1,6 @@
 radial\_solutions
 =================
 
-.. currentmodule:: kerrgeopy.stable_solutions
+.. currentmodule:: kerrgeopy.stable
 
 .. autofunction:: radial_solutions
diff --git a/...utosummary/kerrgeopy.stable_solutions.rst → .../source/_autosummary/kerrgeopy.stable.rst b/...utosummary/kerrgeopy.stable_solutions.rst → .../source/_autosummary/kerrgeopy.stable.rst
@@ -1,7 +1,7 @@
-stable\_solutions
-=================
+stable
+======
 
-.. automodule:: kerrgeopy.stable_solutions
+.. automodule:: kerrgeopy.stable
 
 
 
@@ -17,11 +17,20 @@ stable\_solutions
 
       polar_solutions
       radial_solutions
+      stable_trajectory
 
 
 
 
 
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      StableOrbit
+
 
 
 

diff --git a/docs/source/_autosummary/kerrgeopy.stable.stable_trajectory.rst b/docs/source/_autosummary/kerrgeopy.stable.stable_trajectory.rst
@@ -0,0 +1,6 @@
+stable\_trajectory
+==================
+
+.. currentmodule:: kerrgeopy.stable
+
+.. autofunction:: stable_trajectory
diff --git a/docs/source/_autosummary/kerrgeopy.stable_orbit.rst b/docs/source/_autosummary/kerrgeopy.stable_orbit.rst