Fix doc construction (#19)

Caltech-IPAC · May 15, 2024 · d4d1a25 · d4d1a25
1 parent d4c20ad
commit d4d1a25
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 49 deletions.
diff --git a/doc/api/population.rst b/doc/api/population.rst
@@ -5,44 +5,3 @@ population
    :members:
    :inherited-members:
    :no-undoc-members:
-
-
-population.definitions
-----------------------
-
-.. automodule:: neospy.population.definitions
-   :members:
-   :inherited-members:
-
-
-population.utils
-----------------
-
-.. automodule:: neospy.population.utils
-   :members:
-   :inherited-members:
-
-
-population.diameters
---------------------
-
-.. automodule:: neospy.population.diameters
-   :members:
-   :inherited-members:
-
-
-population.neas
----------------
-
-.. automodule:: neospy.population.neas
-   :members:
-   :inherited-members:
-
-
-population.main_belt
---------------------
-
-.. automodule:: neospy.population.main_belt
-   :members:
-   :inherited-members:
-
diff --git a/doc/images/orbit_models_short.png b/doc/images/orbit_models_short.png
diff --git a/src/examples/galactic_center.py b/src/examples/galactic_center.py
@@ -18,9 +18,7 @@
 all_orbits = neospy.mpc.fetch_known_orbit_data()
 
 # Filter to just the neos
-neos = all_orbits[
-    neospy.population.definitions.neo(all_orbits.peri_dist, all_orbits.ecc)
-]
+neos = all_orbits[neospy.population.neo(all_orbits.peri_dist, all_orbits.ecc)]
 
 # convert the catalog to States
 states = neospy.mpc.table_to_states(neos)

diff --git a/src/examples/plot_phases.py b/src/examples/plot_phases.py
@@ -12,7 +12,7 @@
 orbits = neospy.mpc.fetch_known_orbit_data()
 
 # Subselect NEO population
-neos = neospy.population.definitions.neo(orbits.peri_dist, orbits.ecc)
+neos = neospy.population.neo(orbits.peri_dist, orbits.ecc)
 neo_subset = orbits[neos]
 
 # Convert the dataframe to States

diff --git a/src/examples/plot_trojans.py b/src/examples/plot_trojans.py
@@ -9,7 +9,7 @@
 
 # Load orbit data and select just the jupiter trojans
 orbs = neospy.mpc.fetch_known_orbit_data()
-subset = orbs[neospy.population.definitions.jup_trojan(orbs.peri_dist, orbs.ecc)]
+subset = orbs[neospy.population.jup_trojan(orbs.peri_dist, orbs.ecc)]
 
 # Construct the states and propagate them to a common epoch
 states = neospy.mpc.table_to_states(subset)

diff --git a/src/neospy/mpc.py b/src/neospy/mpc.py
@@ -733,7 +733,7 @@ def mpc_known_orbit_filtered(filt):
     filt:
         Filter function which defines which group to select. The filter function must
         accept 3 parameters, `peri_dist, eccentricity, h_mag`, and return a bool.
-        See `neospy.population.definitions` for a collection of filter functions which
+        See `neospy.population` for a collection of filter functions which
         are used to generation model populations.
     """
     orbs = fetch_known_orbit_data()
@@ -755,7 +755,7 @@ def table_to_states(orbit_dataframe):
         orbits = neospy.mpc.fetch_known_orbit_data()
 
         # Subset the table to be only NEOs
-        neos = neospy.population.definitions.neo(orbits.peri_dist, orbits.ecc)
+        neos = neospy.population.neo(orbits.peri_dist, orbits.ecc)
         neo_subset = orbits[neos]
 
         # load the state object from this table

diff --git a/src/neospy/population.py b/src/neospy/population.py
@@ -311,7 +311,7 @@ def plot_groups():
         :context: close-figs
 
         import neospy
-        neospy.population.definitions.plot_groups();
+        neospy.population.plot_groups();
 
 
     """