Issue #4: Vizard documentation.

Author: Mark2000

docs/build/doctrees/nbsphinx/examples/aeos.ipynb

@@ -41,6 +41,7 @@
     "sphinx_rtd_theme",
     "nbsphinx",
     "sphinx.ext.mathjax",
+    "sphinxcontrib.youtube",
 ]
 
 templates_path = ["_templates"]
@@ -234,7 +235,6 @@ def generate_index(self, index_path, file_paths, dir_paths, source_dir):
             f.write(lines)
 
     def generate_autodoc(self, doc_path, source_file):
-
         # Make header
         short_name = source_file.name.replace(".py", "")
         lines = ""

docs/source/conf.py

@@ -31,6 +31,8 @@ for working with these environments.
 A whitepaper on the design philosophy behind BSK-RL and an example use case can be 
 :download:`downloaded here <_static/stephenson_bskrl_2024.pdf>`.
 
+..  youtube:: 8qR-AGrCFQw
+
 Quickstart
 ----------
 Installation

docs/source/index.rst

@@ -26,7 +26,8 @@ Development Version
 * Improve performance of :class:`~bsk_rl.obs.Eclipse` observations by about 95%.
 * Logs a warning if the initial battery charge or buffer level is incompatible with its capacity.
 * Optimize communication when all satellites are communicating with each other.
-
+* Enable Vizard visualization of the environment by setting the ``vizard_dir`` and ``vizard_settings``
+  options in the environment.
 
 
 Version 1.0.1

docs/source/release_notes.rst

@@ -366,6 +366,42 @@
     "for i in range(5):\n",
     "    env.step(env.action_space.sample())"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Enabling Vizard\n",
+    "\n",
+    "Vizard visualization can be enabled by setting the ``vizard_dir`` to save the Vizard binary to. Here, it is saved to ``/tmp/vizard``, but this can be modified. Scripting settings can also be passed to Vizard."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "env = SatelliteTasking(\n",
+    "    satellite=satellite_generator(observation=\"S3\", n_ahead=32, include_time=False)(\n",
+    "        name=\"EO1\",\n",
+    "        sat_args=SAT_ARGS,\n",
+    "    ),\n",
+    "    scenario=scene.CityTargets(100),\n",
+    "    rewarder=data.UniqueImageReward(),\n",
+    "    sim_rate=0.5,\n",
+    "    max_step_duration=300.0,\n",
+    "    time_limit=duration,\n",
+    "    failure_penalty=0.0,\n",
+    "    terminate_on_time_limit=True,\n",
+    "    log_level=\"INFO\",\n",
+    "    vizard_dir=\"/tmp/vizard\",\n",
+    "    vizard_settings=dict(showLocationLabels=1),\n",
+    ")\n",
+    "_ = env.reset()\n",
+    "for i in range(5):\n",
+    "    env.step(env.action_space.sample())"
+   ]
   }
  ],
  "metadata": {

examples/aeos.ipynb

@@ -28,7 +28,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-docs = ["ipykernel", "ipywidgets", "nbdime", "nbsphinx", "sphinx-rtd-theme"]
+docs = ["ipykernel", "ipywidgets", "nbdime", "nbsphinx", "sphinx-rtd-theme", 'sphinxcontrib-youtube']
 rllib = ["dm_tree", "pyarrow", "ray[rllib]==2.35.0", "scikit-image", "torch", "typer"]
 
 [project.scripts]

pyproject.toml

@@ -133,9 +133,12 @@ def visualize_target(self, target, vizSupport=None, vizInstance=None):
             color=vizSupport.toRGBA255("white"),
             range=1000.0 * 1000,  # meters
         )
-        vizInstance.settings.showLocationCones = -1
-        vizInstance.settings.showLocationCommLines = -1
-        vizInstance.settings.showLocationLabels = -1
+        if vizInstance.settings.showLocationCones == 0:
+            vizInstance.settings.showLocationCones = -1
+        if vizInstance.settings.showLocationCommLines == 0:
+            vizInstance.settings.showLocationCommLines = -1
+        if vizInstance.settings.showLocationLabels == 0:
+            vizInstance.settings.showLocationLabels = -1
 
     def regenerate_targets(self) -> None:
         """Regenerate targets uniformly.