Issue #79: refactored repo to src style directory using pyproject.toml

AVSLab · Dec 5, 2023 · 6aa05a9 · 6aa05a9
1 parent f3c7f70
commit 6aa05a9
Show file tree

Hide file tree

Showing 80 changed files with 67 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 To install the package, run:
 
 ```
-pip install -e .
+pip install -e . && finish_install
 ```
 
 while in the base directory. This will install `pip` dependencies and download data dependencies (see [#51](https://github.com/AVSLab/bsk_rl/issues/51) for issues with `chebpy` installation on Silicon Macs). Test the installation by running

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,35 @@
+[build-system]
+    requires = ["setuptools", "setuptools-scm"]
+    build-backend = "setuptools.build_meta"
+
+[project]
+    name = "bsk_rl"
+    version = "0.0.0"
+    authors = [
+        {name = "Adam Herrmann", email = "adam.herrmann@colorado.edu"},
+        {name = "Mark Stephenson", email = "mark.a.stephenson@colorado.edu"},
+    ]
+    description = "RL environments and tools for spacecraft autonomy research, built on Basilisk. Developed by the AVS Lab."
+    readme = "README.md"
+    requires-python = ">=3.9.0"
+    license = {text = "MIT"}
+    dependencies = [
+        "deap==1.3.3",
+        "Deprecated",
+        "gymnasium",
+        "matplotlib",
+        "numpy",
+        "pandas",
+        "pytest",
+        "pytest-cov",
+        "pytest-repeat",
+        "requests",
+        "scikit-learn",
+        "scipy",
+        "stable-baselines3",
+        "tensorflow",
+        "torch",
+    ]
+
+[project.scripts]
+    finish_install = "bsk_rl.finish_install:pck_install"
diff --git a/setup.py b/setup.py
diff --git a/bsk_rl/__init__.py → src/bsk_rl/__init__.py b/bsk_rl/__init__.py → src/bsk_rl/__init__.py
diff --git a/bsk_rl/agents/__init__.py → src/bsk_rl/agents/__init__.py b/bsk_rl/agents/__init__.py → src/bsk_rl/agents/__init__.py
diff --git a/bsk_rl/agents/genetic_algorithm.py → src/bsk_rl/agents/genetic_algorithm.py b/bsk_rl/agents/genetic_algorithm.py → src/bsk_rl/agents/genetic_algorithm.py
diff --git a/bsk_rl/agents/mcts.py → src/bsk_rl/agents/mcts.py b/bsk_rl/agents/mcts.py → src/bsk_rl/agents/mcts.py
diff --git a/bsk_rl/agents/state_machine.py → src/bsk_rl/agents/state_machine.py b/bsk_rl/agents/state_machine.py → src/bsk_rl/agents/state_machine.py
diff --git a/bsk_rl/envs/__init__.py → src/bsk_rl/envs/__init__.py b/bsk_rl/envs/__init__.py → src/bsk_rl/envs/__init__.py
diff --git a/bsk_rl/envs/agile_eos/__init__.py → src/bsk_rl/envs/agile_eos/__init__.py b/bsk_rl/envs/agile_eos/__init__.py → src/bsk_rl/envs/agile_eos/__init__.py
diff --git a/bsk_rl/envs/agile_eos/bsk_sim.py → src/bsk_rl/envs/agile_eos/bsk_sim.py b/bsk_rl/envs/agile_eos/bsk_sim.py → src/bsk_rl/envs/agile_eos/bsk_sim.py
diff --git a/bsk_rl/envs/agile_eos/gym_env.py → src/bsk_rl/envs/agile_eos/gym_env.py b/bsk_rl/envs/agile_eos/gym_env.py → src/bsk_rl/envs/agile_eos/gym_env.py
diff --git a/...nvs/general_satellite_tasking/__init__.py → ...nvs/general_satellite_tasking/__init__.py b/...nvs/general_satellite_tasking/__init__.py → ...nvs/general_satellite_tasking/__init__.py
diff --git a/...envs/general_satellite_tasking/gym_env.py → ...envs/general_satellite_tasking/gym_env.py b/...envs/general_satellite_tasking/gym_env.py → ...envs/general_satellite_tasking/gym_env.py
diff --git a/...al_satellite_tasking/scenario/__init__.py → ...al_satellite_tasking/scenario/__init__.py b/...al_satellite_tasking/scenario/__init__.py → ...al_satellite_tasking/scenario/__init__.py
diff --git a/...tellite_tasking/scenario/communication.py → ...tellite_tasking/scenario/communication.py b/...tellite_tasking/scenario/communication.py → ...tellite_tasking/scenario/communication.py
diff --git a/...eneral_satellite_tasking/scenario/data.py → ...eneral_satellite_tasking/scenario/data.py b/...eneral_satellite_tasking/scenario/data.py → ...eneral_satellite_tasking/scenario/data.py
diff --git a/..._tasking/scenario/environment_features.py → ..._tasking/scenario/environment_features.py b/..._tasking/scenario/environment_features.py → ..._tasking/scenario/environment_features.py
diff --git a/...satellite_tasking/scenario/sat_actions.py → ...satellite_tasking/scenario/sat_actions.py b/...satellite_tasking/scenario/sat_actions.py → ...satellite_tasking/scenario/sat_actions.py
diff --git a/...lite_tasking/scenario/sat_observations.py → ...lite_tasking/scenario/sat_observations.py b/...lite_tasking/scenario/sat_observations.py → ...lite_tasking/scenario/sat_observations.py
diff --git a/..._satellite_tasking/scenario/satellites.py → ..._satellite_tasking/scenario/satellites.py b/..._satellite_tasking/scenario/satellites.py → ..._satellite_tasking/scenario/satellites.py
diff --git a/..._satellite_tasking/simulation/__init__.py → ..._satellite_tasking/simulation/__init__.py b/..._satellite_tasking/simulation/__init__.py → ..._satellite_tasking/simulation/__init__.py
diff --git a/..._satellite_tasking/simulation/dynamics.py → ..._satellite_tasking/simulation/dynamics.py b/..._satellite_tasking/simulation/dynamics.py → ..._satellite_tasking/simulation/dynamics.py
diff --git a/...tellite_tasking/simulation/environment.py → ...tellite_tasking/simulation/environment.py b/...tellite_tasking/simulation/environment.py → ...tellite_tasking/simulation/environment.py
diff --git a/...neral_satellite_tasking/simulation/fsw.py → ...neral_satellite_tasking/simulation/fsw.py b/...neral_satellite_tasking/simulation/fsw.py → ...neral_satellite_tasking/simulation/fsw.py
diff --git a/...satellite_tasking/simulation/simulator.py → ...satellite_tasking/simulation/simulator.py b/...satellite_tasking/simulation/simulator.py → ...satellite_tasking/simulation/simulator.py
diff --git a/...l/envs/general_satellite_tasking/types.py → ...l/envs/general_satellite_tasking/types.py b/...l/envs/general_satellite_tasking/types.py → ...l/envs/general_satellite_tasking/types.py
diff --git a/...neral_satellite_tasking/utils/__init__.py → ...neral_satellite_tasking/utils/__init__.py b/...neral_satellite_tasking/utils/__init__.py → ...neral_satellite_tasking/utils/__init__.py
diff --git a/.../general_satellite_tasking/utils/debug.py → .../general_satellite_tasking/utils/debug.py b/.../general_satellite_tasking/utils/debug.py → .../general_satellite_tasking/utils/debug.py
diff --git a/...ral_satellite_tasking/utils/functional.py → ...ral_satellite_tasking/utils/functional.py b/...ral_satellite_tasking/utils/functional.py → ...ral_satellite_tasking/utils/functional.py
diff --git a/...eneral_satellite_tasking/utils/orbital.py → ...eneral_satellite_tasking/utils/orbital.py b/...eneral_satellite_tasking/utils/orbital.py → ...eneral_satellite_tasking/utils/orbital.py
diff --git a/bsk_rl/envs/multisat_agile_eos/__init__.py → ...sk_rl/envs/multisat_agile_eos/__init__.py b/bsk_rl/envs/multisat_agile_eos/__init__.py → ...sk_rl/envs/multisat_agile_eos/__init__.py
diff --git a/...multisat_agile_eos/bsk_models/__init__.py → ...multisat_agile_eos/bsk_models/__init__.py b/...multisat_agile_eos/bsk_models/__init__.py → ...multisat_agile_eos/bsk_models/__init__.py
diff --git a/...multisat_agile_eos/bsk_models/dynamics.py → ...multisat_agile_eos/bsk_models/dynamics.py b/...multisat_agile_eos/bsk_models/dynamics.py → ...multisat_agile_eos/bsk_models/dynamics.py
diff --git a/...tisat_agile_eos/bsk_models/environment.py → ...tisat_agile_eos/bsk_models/environment.py b/...tisat_agile_eos/bsk_models/environment.py → ...tisat_agile_eos/bsk_models/environment.py
diff --git a/...envs/multisat_agile_eos/bsk_models/fsw.py → ...envs/multisat_agile_eos/bsk_models/fsw.py b/...envs/multisat_agile_eos/bsk_models/fsw.py → ...envs/multisat_agile_eos/bsk_models/fsw.py
diff --git a/...isat_agile_eos/bsk_models/fsw_steering.py → ...isat_agile_eos/bsk_models/fsw_steering.py b/...isat_agile_eos/bsk_models/fsw_steering.py → ...isat_agile_eos/bsk_models/fsw_steering.py
diff --git a/bsk_rl/envs/multisat_agile_eos/bsk_sim.py → ...bsk_rl/envs/multisat_agile_eos/bsk_sim.py b/bsk_rl/envs/multisat_agile_eos/bsk_sim.py → ...bsk_rl/envs/multisat_agile_eos/bsk_sim.py
diff --git a/...l/envs/multisat_agile_eos/env_settings.py → ...l/envs/multisat_agile_eos/env_settings.py b/...l/envs/multisat_agile_eos/env_settings.py → ...l/envs/multisat_agile_eos/env_settings.py
diff --git a/bsk_rl/envs/multisat_agile_eos/gym_env.py → ...bsk_rl/envs/multisat_agile_eos/gym_env.py b/bsk_rl/envs/multisat_agile_eos/gym_env.py → ...bsk_rl/envs/multisat_agile_eos/gym_env.py
diff --git a/bsk_rl/envs/multisensor_eos/__init__.py → src/bsk_rl/envs/multisensor_eos/__init__.py b/bsk_rl/envs/multisensor_eos/__init__.py → src/bsk_rl/envs/multisensor_eos/__init__.py
diff --git a/bsk_rl/envs/multisensor_eos/bsk_sim.py → src/bsk_rl/envs/multisensor_eos/bsk_sim.py b/bsk_rl/envs/multisensor_eos/bsk_sim.py → src/bsk_rl/envs/multisensor_eos/bsk_sim.py
diff --git a/bsk_rl/envs/multisensor_eos/env_settings.py → ...k_rl/envs/multisensor_eos/env_settings.py b/bsk_rl/envs/multisensor_eos/env_settings.py → ...k_rl/envs/multisensor_eos/env_settings.py
diff --git a/bsk_rl/envs/multisensor_eos/gym_env.py → src/bsk_rl/envs/multisensor_eos/gym_env.py b/bsk_rl/envs/multisensor_eos/gym_env.py → src/bsk_rl/envs/multisensor_eos/gym_env.py
diff --git a/bsk_rl/envs/simple_eos/__init__.py → src/bsk_rl/envs/simple_eos/__init__.py b/bsk_rl/envs/simple_eos/__init__.py → src/bsk_rl/envs/simple_eos/__init__.py
diff --git a/bsk_rl/envs/simple_eos/bsk_sim.py → src/bsk_rl/envs/simple_eos/bsk_sim.py b/bsk_rl/envs/simple_eos/bsk_sim.py → src/bsk_rl/envs/simple_eos/bsk_sim.py
diff --git a/bsk_rl/envs/simple_eos/gym_env.py → src/bsk_rl/envs/simple_eos/gym_env.py b/bsk_rl/envs/simple_eos/gym_env.py → src/bsk_rl/envs/simple_eos/gym_env.py
diff --git a/bsk_rl/envs/small_body_science/__init__.py → ...sk_rl/envs/small_body_science/__init__.py b/bsk_rl/envs/small_body_science/__init__.py → ...sk_rl/envs/small_body_science/__init__.py
diff --git a/bsk_rl/envs/small_body_science/bsk_sim.py → ...bsk_rl/envs/small_body_science/bsk_sim.py b/bsk_rl/envs/small_body_science/bsk_sim.py → ...bsk_rl/envs/small_body_science/bsk_sim.py
diff --git a/bsk_rl/envs/small_body_science/gym_env.py → ...bsk_rl/envs/small_body_science/gym_env.py b/bsk_rl/envs/small_body_science/gym_env.py → ...bsk_rl/envs/small_body_science/gym_env.py
diff --git a/...envs/small_body_science_pomdp/__init__.py → ...envs/small_body_science_pomdp/__init__.py b/...envs/small_body_science_pomdp/__init__.py → ...envs/small_body_science_pomdp/__init__.py
diff --git a/.../envs/small_body_science_pomdp/bsk_sim.py → .../envs/small_body_science_pomdp/bsk_sim.py b/.../envs/small_body_science_pomdp/bsk_sim.py → .../envs/small_body_science_pomdp/bsk_sim.py
diff --git a/.../envs/small_body_science_pomdp/gym_env.py → .../envs/small_body_science_pomdp/gym_env.py b/.../envs/small_body_science_pomdp/gym_env.py → .../envs/small_body_science_pomdp/gym_env.py
diff --git a/src/bsk_rl/finish_install.py b/src/bsk_rl/finish_install.py
@@ -0,0 +1,31 @@
+import io
+import subprocess
+import sys
+import zipfile
+from pathlib import Path
+
+import requests
+
+
+def pck_install():
+    subprocess.check_call(
+        [
+            sys.executable,
+            "-m",
+            "pip",
+            "install",
+            "git+https://github.com/chebpy/chebpy.git",
+        ]
+    )
+
+    r = requests.get(
+        "https://simplemaps.com/static/data/world-cities/basic/simplemaps_worldcities_basicv1.76.zip"
+    )
+    z = zipfile.ZipFile(io.BytesIO(r.content))
+    z.extractall(
+        Path(__file__).parent.resolve()
+        / "envs"
+        / "general_satellite_tasking"
+        / "scenario"
+        / "simplemaps_worldcities"
+    )
diff --git a/bsk_rl/training/__init__.py → src/bsk_rl/training/__init__.py b/bsk_rl/training/__init__.py → src/bsk_rl/training/__init__.py
diff --git a/bsk_rl/training/mcts/INSTRUCTIONS.md → src/bsk_rl/training/mcts/INSTRUCTIONS.md b/bsk_rl/training/mcts/INSTRUCTIONS.md → src/bsk_rl/training/mcts/INSTRUCTIONS.md
diff --git a/bsk_rl/training/mcts/__init__.py → src/bsk_rl/training/mcts/__init__.py b/bsk_rl/training/mcts/__init__.py → src/bsk_rl/training/mcts/__init__.py
diff --git a/bsk_rl/training/mcts/mcts_train.py → src/bsk_rl/training/mcts/mcts_train.py b/bsk_rl/training/mcts/mcts_train.py → src/bsk_rl/training/mcts/mcts_train.py
diff --git a/bsk_rl/training/sb3/__init__.py → src/bsk_rl/training/sb3/__init__.py b/bsk_rl/training/sb3/__init__.py → src/bsk_rl/training/sb3/__init__.py
diff --git a/bsk_rl/training/sb3/experiments.py → src/bsk_rl/training/sb3/experiments.py b/bsk_rl/training/sb3/experiments.py → src/bsk_rl/training/sb3/experiments.py
diff --git a/bsk_rl/utilities/__init__.py → src/bsk_rl/utilities/__init__.py b/bsk_rl/utilities/__init__.py → src/bsk_rl/utilities/__init__.py
diff --git a/...utilities/effector_primitives/__init__.py → ...utilities/effector_primitives/__init__.py b/...utilities/effector_primitives/__init__.py → ...utilities/effector_primitives/__init__.py
diff --git a/...ffector_primitives/actuator_primitives.py → ...ffector_primitives/actuator_primitives.py b/...ffector_primitives/actuator_primitives.py → ...ffector_primitives/actuator_primitives.py
diff --git a/...l/utilities/genetic_algorithm/__init__.py → ...l/utilities/genetic_algorithm/__init__.py b/...l/utilities/genetic_algorithm/__init__.py → ...l/utilities/genetic_algorithm/__init__.py
diff --git a/...tilities/genetic_algorithm/experiments.py → ...tilities/genetic_algorithm/experiments.py b/...tilities/genetic_algorithm/experiments.py → ...tilities/genetic_algorithm/experiments.py
diff --git a/.../utilities/initial_conditions/__init__.py → .../utilities/initial_conditions/__init__.py b/.../utilities/initial_conditions/__init__.py → .../utilities/initial_conditions/__init__.py
diff --git a/...tial_conditions/leo_initial_conditions.py → ...tial_conditions/leo_initial_conditions.py b/...tial_conditions/leo_initial_conditions.py → ...tial_conditions/leo_initial_conditions.py
diff --git a/...utilities/initial_conditions/leo_orbit.py → ...utilities/initial_conditions/leo_orbit.py b/...utilities/initial_conditions/leo_orbit.py → ...utilities/initial_conditions/leo_orbit.py
diff --git a/...lities/initial_conditions/sc_attitudes.py → ...lities/initial_conditions/sc_attitudes.py b/...lities/initial_conditions/sc_attitudes.py → ...lities/initial_conditions/sc_attitudes.py
diff --git a/...tilities/initial_conditions/small_body.py → ...tilities/initial_conditions/small_body.py b/...tilities/initial_conditions/small_body.py → ...tilities/initial_conditions/small_body.py
diff --git a/bsk_rl/utilities/mcts/__init__.py → src/bsk_rl/utilities/mcts/__init__.py b/bsk_rl/utilities/mcts/__init__.py → src/bsk_rl/utilities/mcts/__init__.py
diff --git a/bsk_rl/utilities/mcts/rollout_policies.py → ...bsk_rl/utilities/mcts/rollout_policies.py b/bsk_rl/utilities/mcts/rollout_policies.py → ...bsk_rl/utilities/mcts/rollout_policies.py
diff --git a/bsk_rl/utilities/sb3/__init__.py → src/bsk_rl/utilities/sb3/__init__.py b/bsk_rl/utilities/sb3/__init__.py → src/bsk_rl/utilities/sb3/__init__.py
diff --git a/bsk_rl/utilities/sb3/custom_sb3_policies.py → ...k_rl/utilities/sb3/custom_sb3_policies.py b/bsk_rl/utilities/sb3/custom_sb3_policies.py → ...k_rl/utilities/sb3/custom_sb3_policies.py
diff --git a/bsk_rl/utilities/sb3/shielded_policies.py → ...bsk_rl/utilities/sb3/shielded_policies.py b/bsk_rl/utilities/sb3/shielded_policies.py → ...bsk_rl/utilities/sb3/shielded_policies.py
diff --git a/bsk_rl/utilities/sb3/shields.py → src/bsk_rl/utilities/sb3/shields.py b/bsk_rl/utilities/sb3/shields.py → src/bsk_rl/utilities/sb3/shields.py
diff --git a/bsk_rl/utilities/state_machine/__init__.py → ...sk_rl/utilities/state_machine/__init__.py b/bsk_rl/utilities/state_machine/__init__.py → ...sk_rl/utilities/state_machine/__init__.py
diff --git a/...utilities/state_machine/agile_eos_ops.adv → ...utilities/state_machine/agile_eos_ops.adv b/...utilities/state_machine/agile_eos_ops.adv → ...utilities/state_machine/agile_eos_ops.adv
diff --git a/...ies/state_machine/multisensor_eos_ops.adv → ...ies/state_machine/multisensor_eos_ops.adv b/...ies/state_machine/multisensor_eos_ops.adv → ...ies/state_machine/multisensor_eos_ops.adv
diff --git a/...tilities/state_machine/simple_eos_ops.adv → ...tilities/state_machine/simple_eos_ops.adv b/...tilities/state_machine/simple_eos_ops.adv → ...tilities/state_machine/simple_eos_ops.adv