Issue #140: Initial refactor

Author: Mark2000

.github/pull_request_template.md

@@ -13,7 +13,6 @@ __pycache__/
 # Distribution / packaging
 .Python
 bin/
-env/
 build/
 develop-eggs/
 dist/
@@ -100,7 +99,6 @@ celerybeat-schedule
 # virtualenv
 .venv
 venv/
-ENV/
 
 # Spyder project settings
 .spyderproject
@@ -127,4 +125,4 @@ bsk_rl/results/
 .DS_Store
 
 # data files
-src/bsk_rl/envs/general_satellite_tasking/scenario/simplemaps_worldcities/
+src/bsk_rl/data/simplemaps_worldcities/

.gitignore

@@ -39,8 +39,8 @@
     vizSupport,
 )
 
-from bsk_rl.utilities.effector_primitives import actuator_primitives as ap
 from bsk_rl.utilities.initial_conditions import leo_orbit, sc_attitudes
+from bsk_rl.utils import actuator_primitives as ap
 
 bskPath = __path__[0]
 

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 from Basilisk.utilities import macros as mc
 from gymnasium import spaces
 
-from bsk_rl.envs.agile_eos.bsk_sim import AgileEOSSimulator
+from bsk_rl.env.agile_eos.bsk_sim import AgileEOSSimulator
 
 
 class AgileEOS(gym.Env):

src/bsk_rl/agents/__init__.py deprecated/agents/__init__.py

@@ -14,7 +14,7 @@
 from Basilisk.utilities import macros as mc
 from Basilisk.utilities import unitTestSupport
 
-from bsk_rl.utilities.effector_primitives import actuator_primitives as ap
+from bsk_rl.utils import actuator_primitives as ap
 
 
 class DynamicModel:

src/bsk_rl/agents/genetic_algorithm.py deprecated/agents/genetic_algorithm.py

@@ -7,9 +7,9 @@
 from Basilisk.utilities import orbitalMotion, vizSupport
 from scipy.sparse.csgraph import connected_components
 
-from bsk_rl.envs.multisat_agile_eos.bsk_models import dynamics, environment
-from bsk_rl.envs.multisat_agile_eos.bsk_models import fsw as fsw_feedback
-from bsk_rl.envs.multisat_agile_eos.bsk_models import fsw_steering
+from bsk_rl.env.multisat_agile_eos.bsk_models import dynamics, environment
+from bsk_rl.env.multisat_agile_eos.bsk_models import fsw as fsw_feedback
+from bsk_rl.env.multisat_agile_eos.bsk_models import fsw_steering
 from bsk_rl.utilities.initial_conditions import leo_initial_conditions
 
 

src/bsk_rl/agents/mcts.py deprecated/agents/mcts.py

@@ -5,8 +5,8 @@
 from Basilisk.utilities import macros as mc
 from gymnasium import spaces
 
-from bsk_rl.envs.multisat_agile_eos import env_settings
-from bsk_rl.envs.multisat_agile_eos.bsk_sim import MultiSatAgileEOSSimulator
+from bsk_rl.env.multisat_agile_eos import env_settings
+from bsk_rl.env.multisat_agile_eos.bsk_sim import MultiSatAgileEOSSimulator
 
 gym.utils.passive_env_checker.logger.setLevel(
     40

src/bsk_rl/agents/state_machine.py deprecated/agents/state_machine.py

@@ -28,7 +28,7 @@
 from Basilisk.utilities import macros as mc
 from Basilisk.utilities import simIncludeGravBody, unitTestSupport, vizSupport
 
-from bsk_rl.utilities.effector_primitives import actuator_primitives as ap
+from bsk_rl.utils import actuator_primitives as ap
 
 bskPath = __path__[0]
 

src/bsk_rl/envs/agile_eos/__init__.py deprecated/environments/agile_eos/__init__.py

@@ -4,8 +4,8 @@
 import numpy as np
 from gymnasium import spaces
 
-from bsk_rl.envs.multisensor_eos.bsk_sim import MultiSensorEOSSimulator
-from bsk_rl.envs.multisensor_eos.env_settings import Settings
+from bsk_rl.env.multisensor_eos.bsk_sim import MultiSensorEOSSimulator
+from bsk_rl.env.multisensor_eos.env_settings import Settings
 
 
 class MultiSensorEOS(gym.Env):

src/bsk_rl/envs/agile_eos/bsk_sim.py deprecated/environments/agile_eos/bsk_sim.py

@@ -41,8 +41,8 @@
     vizSupport,
 )
 
-from bsk_rl.utilities.effector_primitives import actuator_primitives as ap
 from bsk_rl.utilities.initial_conditions import leo_orbit, sc_attitudes
+from bsk_rl.utils import actuator_primitives as ap
 
 bskPath = __path__[0]
 

src/bsk_rl/envs/agile_eos/gym_env.py deprecated/environments/agile_eos/gym_env.py

@@ -3,7 +3,7 @@
 from Basilisk.utilities import macros as mc
 from gymnasium import spaces
 
-from bsk_rl.envs.simple_eos import bsk_sim
+from bsk_rl.env.simple_eos import bsk_sim
 
 
 class SimpleEOS(gym.Env):

src/bsk_rl/envs/general_satellite_tasking/__init__.py deprecated/environments/multisat_agile_eos/__init__.py

@@ -43,8 +43,8 @@
     vizSupport,
 )
 
-from bsk_rl.utilities.effector_primitives import actuator_primitives as ap
 from bsk_rl.utilities.initial_conditions import sc_attitudes, small_body
+from bsk_rl.utils import actuator_primitives as ap
 
 bskPath = __path__[0]
 

src/bsk_rl/envs/general_satellite_tasking/scenario/__init__.py deprecated/environments/multisat_agile_eos/bsk_models/__init__.py

@@ -2,7 +2,7 @@
 import numpy as np
 from gymnasium import spaces
 
-from bsk_rl.envs.small_body_science.bsk_sim import SmallBodyScienceSimulator
+from bsk_rl.env.small_body_science.bsk_sim import SmallBodyScienceSimulator
 
 
 class SmallBodyScience(gym.Env):

src/bsk_rl/envs/multisat_agile_eos/bsk_models/dynamics.py deprecated/environments/multisat_agile_eos/bsk_models/dynamics.py

@@ -5,7 +5,7 @@
 from Basilisk.utilities import macros as mc
 from Basilisk.utilities import orbitalMotion, unitTestSupport
 
-from bsk_rl.envs.small_body_science.bsk_sim import SmallBodyScienceSimulator
+from bsk_rl.env.small_body_science.bsk_sim import SmallBodyScienceSimulator
 
 
 class SmallBodySciencePOMDPSimulator(SmallBodyScienceSimulator):

src/bsk_rl/envs/multisat_agile_eos/bsk_models/environment.py deprecated/environments/multisat_agile_eos/bsk_models/environment.py

@@ -2,8 +2,8 @@
 import numpy as np
 from gymnasium import spaces
 
-from bsk_rl.envs.small_body_science.gym_env import SmallBodyScience
-from bsk_rl.envs.small_body_science_pomdp.bsk_sim import SmallBodySciencePOMDPSimulator
+from bsk_rl.env.small_body_science.gym_env import SmallBodyScience
+from bsk_rl.env.small_body_science_pomdp.bsk_sim import SmallBodySciencePOMDPSimulator
 
 
 class SmallBodySciencePOMDP(SmallBodyScience):

src/bsk_rl/envs/multisat_agile_eos/bsk_models/fsw.py deprecated/environments/multisat_agile_eos/bsk_models/fsw.py

@@ -6,7 +6,7 @@
 import gymnasium as gym
 import numpy as np
 
-from bsk_rl.envs.agile_eos.gym_env import AgileEOS  # noqa: F401; needed for gym
+from bsk_rl.env.agile_eos.gym_env import AgileEOS  # noqa: F401; needed for gym
 
 os.environ["CUDA_VISIBLE_DEVICES"] = "-1"
 

src/bsk_rl/envs/multisat_agile_eos/bsk_models/fsw_steering.py deprecated/environments/multisat_agile_eos/bsk_models/fsw_steering.py

@@ -21,10 +21,20 @@ a.el, a.el:visited {
 	color: #565A5C; # CU dark gray
 }
 
-.wy-nav-content {
-    max-width: none;
+@media screen and (min-width: 1100px) {
+    .wy-nav-side,
+    .wy-grid-for-nav {
+        margin-left: calc(((100vw - 1100px) / 2));
+    }
+    .wy-nav-content-wrap {
+        background: none;
+    }
+    .wy-body-for-nav {
+        background: #565A5C;
+    }
 }
 
+
 code span.pre, code {
 	color: #cb7ccf;
 }
@@ -87,12 +97,11 @@ ul.simple li p, aside.sidebar ul li p {
 
 ul.simple ul li {
 	list-style-type: circle;
-	margin-left: 1.5em;
 }
 
 ul.simple, aside.sidebar ul {
 	all: revert;
-	padding-left: 1.5em;
+	padding-left: 0em;
 }
 
 figure {

src/bsk_rl/envs/multisat_agile_eos/bsk_sim.py deprecated/environments/multisat_agile_eos/bsk_sim.py

@@ -11,6 +11,7 @@
 import os
 import re
 import sys
+from importlib import metadata
 from pathlib import Path
 
 # sys.path.insert(0, os.path.abspath(os.path.join("..", "..", "src")))
@@ -19,7 +20,8 @@
 project = "BSK-RL"
 copyright = str(now.year) + ", Autonomous Vehicle Systems (AVS) Laboratory"
 author = "Mark Stephenson"
-release = "0.0.0"
+release = metadata.version("bsk_rl")
+version = "Version " + release
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -38,6 +40,11 @@
 exclude_patterns = []
 source_suffix = ".rst"
 master_doc = "index"
+autoclass_content = "init"
+autodoc_member_order = "bysource"
+autodoc_default_options = {
+    "undoc-members": None,
+}
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -63,8 +70,6 @@
 
 
 def skip(app, what, name, obj, would_skip, options):
-    if name == "__init__":
-        return False
     return would_skip
 
 
@@ -87,6 +92,7 @@ def grab_files(self, dir_path):
             r".*\.ruff_cache.*",
             r".*\.egg-info",
             r".*\/simplemaps_worldcities",
+            r".*\/data",
         ]
         dirs_in_dir = list(
             filter(
@@ -100,6 +106,7 @@ def grab_files(self, dir_path):
         file_filters = [
             r".*__init__\.py",
             r"(.*\/|)_[a-zA-Z0-9_]*\.py",
+            r".*types.py",
         ]
         files_in_dir = list(
             filter(

src/bsk_rl/envs/multisat_agile_eos/env_settings.py deprecated/environments/multisat_agile_eos/env_settings.py

@@ -8,12 +8,10 @@
 import gymnasium as gym
 import numpy as np
 
-from bsk_rl.envs.general_satellite_tasking.scenario import communication, data
-from bsk_rl.envs.general_satellite_tasking.scenario import satellites as sats
-from bsk_rl.envs.general_satellite_tasking.scenario.environment_features import (
-    CityTargets,
-)
-from bsk_rl.utilities.initial_conditions import leo_orbit
+from bsk_rl.env.scenario import communication, data
+from bsk_rl.env.scenario import satellites as sats
+from bsk_rl.env.scenario.environment_features import CityTargets
+from bsk_rl.utils.orbital import walker_delta
 
 
 def run():
@@ -25,7 +23,7 @@ def run():
     data_manager = data.UniqueImagingManager(env_features)
 
     # Generate orbital parameters for each satellite in the constellation
-    oes = leo_orbit.walker_delta(
+    oes = walker_delta(
         n_spacecraft=3,  # Number of satellites
         n_planes=1,
         rel_phasing=0,

src/bsk_rl/envs/multisat_agile_eos/gym_env.py deprecated/environments/multisat_agile_eos/gym_env.py

@@ -2,15 +2,13 @@
 from Basilisk.architecture import bskLogging
 from Basilisk.utilities import orbitalMotion
 
-from bsk_rl.envs.general_satellite_tasking.scenario import data
-from bsk_rl.envs.general_satellite_tasking.scenario import sat_actions as sa
-from bsk_rl.envs.general_satellite_tasking.scenario import sat_observations as so
-from bsk_rl.envs.general_satellite_tasking.scenario import satellites as sats
-from bsk_rl.envs.general_satellite_tasking.scenario.environment_features import (
-    CityTargets,
-)
-from bsk_rl.envs.general_satellite_tasking.simulation import dynamics, fsw
-from bsk_rl.envs.general_satellite_tasking.utils.orbital import random_orbit
+from bsk_rl.env.scenario import data
+from bsk_rl.env.scenario import sat_actions as sa
+from bsk_rl.env.scenario import sat_observations as so
+from bsk_rl.env.scenario import satellites as sats
+from bsk_rl.env.scenario.environment_features import CityTargets
+from bsk_rl.env.simulation import dynamics, environment, fsw
+from bsk_rl.utils.orbital import random_orbit
 
 bskLogging.setDefaultLogLevel(bskLogging.BSK_WARNING)
 

src/bsk_rl/envs/general_satellite_tasking/simulation/__init__.py deprecated/environments/multisensor_eos/__init__.py

@@ -1,11 +1,9 @@
 import gymnasium as gym
 
-from bsk_rl.envs.general_satellite_tasking.scenario import data
-from bsk_rl.envs.general_satellite_tasking.scenario import satellites as sats
-from bsk_rl.envs.general_satellite_tasking.scenario.environment_features import (
-    StaticTargets,
-)
-from bsk_rl.envs.general_satellite_tasking.utils.orbital import random_orbit
+from bsk_rl.env.scenario import data
+from bsk_rl.env.scenario import satellites as sats
+from bsk_rl.env.scenario.environment_features import StaticTargets
+from bsk_rl.utils.orbital import random_orbit
 
 # This script demonstrates the configuration of an environment with a single imaging
 # satellite.

src/bsk_rl/envs/multisensor_eos/bsk_sim.py deprecated/environments/multisensor_eos/bsk_sim.py

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bsk_rl"
-version = "0.0.0"
+version = "1.0.0"
 authors = [
     { name = "Adam Herrmann", email = "[email protected]" },
     { name = "Mark Stephenson", email = "[email protected]" },