Visual implementation

README.md

@@ -21,4 +21,17 @@ This project is currently under development. Use at your own risk. :)
   <p align="center">
     Description of PASEOS workflow on an individual device
   </p>
+</p>
+
+## Visualising PASEOS
+Navigate to paseos/visualization_example to find minimal examples of how to visualize PASEOS.
+Visualization can be done in interactive mode or as an animation that is saved to disc.
+
+<p align="center">
+  <a href="https://github.com/aidotse/PASEOS/">
+    <img src="resources/images/animation.png" alt="Scheme"  width="500" height="500">
+  </a>
+  <p align="center">
+    Snapshot of PASEOS visualization
+  </p>
 </p>

environment.yml

@@ -12,3 +12,4 @@ dependencies:
 - sphinx_rtd_theme
 - toml
 - tqdm
+- matplotlib

paseos/__init__.py

@@ -27,4 +27,4 @@ def init_sim(local_actor: BaseActor):
     return sim
 
 
-__all__ = ["ActorBuilder", "GroundstationActor", "SpacecraftActor"]
+__all__ = ["ActorBuilder", "GroundstationActor", "SpacecraftActor", "SpaceAnimation"]

paseos/actors/spacecraft_actor.py

@@ -23,7 +23,6 @@ def __init__(
         epoch: pk.epoch,
     ) -> None:
         """Constructor for a spacecraft actor
-
         Args:
             name (str): Name of this actor
             position (list of floats): [x,y,z]
@@ -35,7 +34,6 @@ def __init__(
     @property
     def charging_rate_in_W(self):
         """Get the current charging rate.
-
         Returns:
             float: current charging rate in W.
         """
@@ -44,7 +42,6 @@ def charging_rate_in_W(self):
     @property
     def battery_level_in_Ws(self):
         """Get the current battery level.
-
         Returns:
             float: current battery level in wattseconds.
         """
@@ -53,15 +50,13 @@ def battery_level_in_Ws(self):
     @property
     def battery_level_ratio(self):
         """Get the current battery level as ratio of maximum.
-
         Returns:
             float: current battery level ratio in [0,1].
         """
         return self._battery_level_in_Ws / self._max_battery_level_in_Ws
 
     def discharge(self, consumption_rate_in_W: float, duration_in_s: float):
         """Discharge battery depending on power consumption.
-
         Args:
             consumption_rate_in_W (float): Consumption rate of the activity in Watt
             duration_in_s (float): How long the activity is performed in seconds
@@ -78,17 +73,13 @@ def charge(self, t0: pk.epoch, t1: pk.epoch):
         """Charges the actor during that period. Note that it is only
         verified the actor is neither at start nor end of the period in eclipse,
         thus short periods are preferable.
-
         Args:
             t0 (pk.epoch): Start of the charging interval
             t1 (pk.epoch): End of the charging interval
-
         """
         time_interval = (t1.mjd2000 - t0.mjd2000) * pk.DAY2SEC
         logger.debug(f"Charging actor {self} for {time_interval}s.")
-        assert (
-            time_interval > 0
-        ), "Charging interval has to be positive but t1 was less or equal t0."
+        assert time_interval > 0, "Charging interval has to be positive but t1 was less or equal t0."
 
         if is_in_eclipse(self, central_body=self._central_body, t=t0) or is_in_eclipse(
             self, central_body=self._central_body, t=t1

paseos/paseos.py

@@ -47,7 +47,6 @@ def __init__(self, local_actor: BaseActor):
 
     def advance_time(self, time_to_advance: float):
         """Advances the simulation by a specified amount of time
-
         Args:
             time_to_advance (float): Time to advance in seconds.
         """
@@ -78,7 +77,6 @@ def advance_time(self, time_to_advance: float):
 
     def add_known_actor(self, actor: BaseActor):
         """Adds an actor to the simulation.
-
         Args:
             actor (BaseActor): Actor to add
         """
@@ -95,7 +93,6 @@ def add_known_actor(self, actor: BaseActor):
     @property
     def local_actor(self) -> BaseActor:
         """Returns the local actor.
-
         Returns:
             BaseActor: Local actor
         """
@@ -104,7 +101,6 @@ def local_actor(self) -> BaseActor:
     @property
     def known_actors(self) -> dict:
         """Returns known actors.
-
         Returns:
             dict of BaseActor: Dictionary of the known actors.
         """
@@ -113,7 +109,6 @@ def known_actors(self) -> dict:
     @property
     def known_actor_names(self) -> list:
         """Returns names of known actors.
-
         Returns:
             list: List of names of known actors.
         """
@@ -125,7 +120,6 @@ def emtpy_known_actors(self):
 
     def remove_known_actor(self, actor_name: str):
         """Remove an actor from the list of known actors.
-
         Args:
             actor_name (str): name of the actor to remove.
         """
@@ -141,10 +135,10 @@ def register_activity(
         power_consumption_in_watt: float = None,
     ):
         """Registers an activity that can then be performed on the local actor.
-
         Args:
             name (str): Name of the activity
-            requires_line_of_sight_to (list): List of strings with names of actors which need to be visible for this activity.
+            requires_line_of_sight_to (list): List of strings with names of actors which
+            need to be visible for this activity.
             power_consumption_in_watt (float, optional): Power consumption of performing
             the activity (per second). Defaults to None.
         """
@@ -171,13 +165,11 @@ def perform_activity(
         duration_in_s: float = 1.0,
     ):
         """Perform the activity and discharge battery accordingly
-
         Args:
             name (str): Name of the activity
             power_consumption_in_watt (float, optional): Power consumption of the
             activity in seconds if not specified. Defaults to None.
             duration_in_s (float, optional): Time to perform this activity. Defaults to 1.0.
-
         Returns:
             bool: Whether the activity was performed successfully.
         """
@@ -216,7 +208,6 @@ def perform_activity(
 
     def set_central_body(self, planet: pk.planet):
         """Sets the central body of the simulation for the orbit simulation
-
         Args:
             planet (pk.planet): The central body as a pykep planet
         """
@@ -225,7 +216,6 @@ def set_central_body(self, planet: pk.planet):
 
     def get_cfg(self) -> DotMap:
         """Returns the current cfg of the simulation
-
         Returns:
             DotMap: cfg
         """

paseos/power/is_in_eclipse.py

@@ -21,7 +21,7 @@ def is_in_eclipse(
     Returns:
         bool: True if actor is in eclipse
     """
-    logger.debug(f"Checking whether {actor} is in eclipse at {t}.")
+    logger.debug(f"Checking whether {actor} is in eclipse at {t.mjd2000/pk.SEC2DAY}.")
 
     # Compute central body position in solar reference frame
     r_central_body_heliocentric, _ = np.array(central_body.eph(t))

paseos/tests/visualization_test.py

@@ -0,0 +1,29 @@
+"""Tests to check visualization."""
+import sys
+
+sys.path.append("../..")
+from paseos import ActorBuilder, SpacecraftActor
+from paseos.visualization.space_animation import SpaceAnimation
+from test_utils import get_default_instance
+import pykep as pk
+
+
+def test_animation():
+    sim, sat1, earth = get_default_instance()
+
+    sat2 = ActorBuilder.get_actor_scaffold(
+        "sat2", SpacecraftActor, [10000000, 0, 0], pk.epoch(0)
+    )
+    ActorBuilder.set_orbit(sat2, [0, 10000000, 0], [0, 0, 8000.0], pk.epoch(0), earth)
+    ActorBuilder.set_power_devices(sat2, 5000, 10000, 1)
+    sim.add_known_actor(sat2)
+
+    anim = SpaceAnimation(sim)
+
+    dt = 100
+    for t in range(10):
+        anim.animate(sim, dt)
+
+
+if __name__ == "__main__":
+    test_animation()

paseos/visualization/animation.py

@@ -0,0 +1,29 @@
+from abc import ABC, abstractmethod
+from paseos.paseos import PASEOS
+
+
+class Animation(ABC):
+    """Abstract class for visualization."""
+
+    def __init__(self, sim: PASEOS) -> None:
+        self._local_actor = sim.local_actor
+        self._other_actors = sim.known_actors
+        self.objects = list()
+
+    def _sec_to_ddhhmmss(self, time: float) -> str:
+        """Convert seconds to ddhhmmss format
+        Returns:
+            str: time in ddhhmmss.
+        """
+        m, s = divmod(time, 60)
+        h, m = divmod(m, 60)
+        d, h = divmod(h, 24)
+        return f"T={d:.0f}d{h:.0f}h{m:.0f}m{s:.0f}s"
+
+    @abstractmethod
+    def _plot_actors(self) -> None:
+        pass
+
+    @abstractmethod
+    def _update(self, sim: PASEOS) -> None:
+        pass