Comms expansion

.gitignore

@@ -128,6 +128,9 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+.idea
+pylintrc
+
 my_notebooks
 .vscode
 examples/Sentinel_2_example_notebook/Etna_00.tif

examples/Communication_example/communication_example_utils.py

@@ -0,0 +1,82 @@
+import numpy as np
+import pandas as pd
+
+
+def get_known_actor_comms_status(values):
+    """Helper function to track comms status"""
+    conv_values = []
+    for val in values:
+        status = ["No signal", "Ground only", "CommSat only", "Ground + Sat"]
+        idx = ("comms_1" in val) * 2 + 1 * ("gs_1" in val)
+        conv_values.append(status[idx])
+    return conv_values
+
+
+def get_bitrate_status(link):
+    """Helper function to get bitrate status history"""
+    return link.bitrate_history
+
+
+def get_line_of_sight_status(link):
+    """Helper function to get line of sight status history"""
+    return link.line_of_sight_history
+
+
+def get_distance_status(link):
+    """Helper function to distance status history"""
+    return link.distance_history
+
+
+def get_elevation_angle_status(link):
+    """Helper function to get elevation angle status history"""
+    return link.elevation_angle_history
+
+
+def get_closest_entry(df, t, id):
+    df_id = df[df.ID == id]
+    return df_id.iloc[(df_id["Time"] - t).abs().argsort().iloc[:1]]
+
+
+def get_analysis_df(df, timestep=60, orbital_period=1):
+    t = np.round(np.linspace(0, df.Time.max(), int(df.Time.max() // timestep)))
+    sats = df.ID.unique()
+    df["known_actors"] = pd.Categorical(df.known_actors)
+    df["comm_cat"] = df.known_actors.cat.codes
+    standby = []
+    processing = []
+    is_in_eclipse = []
+    comm_stat = [[], [], [], []]
+
+    for idx, t_cur in enumerate(t):
+        n_c = 0
+        n_ec = 0
+        for c in comm_stat:
+            c.append(0)
+        for sat in sats:
+            vals = get_closest_entry(df, t_cur, sat)
+            n_c += vals.current_activity.values[0] == "Standby"
+            n_ec += vals.is_in_eclipse.values[0]
+            c_idx = vals.comm_cat.values[0]
+            comm_stat[c_idx][idx] += 1
+        standby.append(n_c)
+        processing.append(len(sats) - n_c)
+        is_in_eclipse.append(n_ec)
+
+    ana_df = pd.DataFrame(
+        {
+            "Time[s]": t,
+            "# of Standby": standby,
+            "# of Processing": processing,
+            "# in Eclipse": is_in_eclipse,
+            "# of " + df.known_actors.cat.categories[0]: comm_stat[0],
+            "# of " + df.known_actors.cat.categories[1]: comm_stat[1],
+            "# of " + df.known_actors.cat.categories[2]: comm_stat[2],
+            # "# of " + df.known_actors.cat.categories[3]: comm_stat[3],
+        }
+    )
+    ana_df["Completed orbits"] = ana_df["Time[s]"] / orbital_period
+    ana_df = ana_df.round({"Completed orbits": 2})
+    ana_df["Share Processing"] = ana_df["# of Processing"] / len(sats)
+    ana_df["Share in Eclipse"] = ana_df["# in Eclipse"] / len(sats)
+
+    return ana_df

examples/Constellation_example/constellation.ipynb

@@ -849,7 +849,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.10.8 | packaged by conda-forge | (main, Nov 22 2022, 08:16:33) [MSC v.1929 64 bit (AMD64)]"
+      "version": "3.11.6"
     },
     "vscode": {
       "interpreter": {

paseos/__init__.py

@@ -1,35 +1,43 @@
-from loguru import logger
-from dotmap import DotMap
 import pykep as pk
+from dotmap import DotMap
+from loguru import logger
 
-from .utils.load_default_cfg import load_default_cfg
-from .utils.check_cfg import check_cfg
-from .paseos import PASEOS
-from .actors.base_actor import BaseActor
 from .actors.actor_builder import ActorBuilder
+from .actors.base_actor import BaseActor
 from .actors.ground_station_actor import GroundstationActor
 from .actors.spacecraft_actor import SpacecraftActor
 from .central_body.central_body import CentralBody
-from .communication.get_communication_window import get_communication_window
 from .communication.find_next_window import find_next_window
+from .communication.get_communication_window import get_communication_window
+from .paseos import PASEOS
 from .power.power_device_type import PowerDeviceType
+from .utils.check_cfg import check_cfg
+from .utils.load_default_cfg import load_default_cfg
 from .utils.reference_frame import ReferenceFrame
 from .utils.set_log_level import set_log_level
 from .visualization.plot import plot, PlotType
 
-
 set_log_level("WARNING")
 
 logger.debug("Loaded module.")
 
 
-def init_sim(local_actor: BaseActor, cfg: DotMap = None, starting_epoch: pk.epoch = None):
+def init_sim(
+        local_actor: BaseActor,
+        cfg: DotMap = None,
+        starting_epoch: pk.epoch = None,
+        communication_links=None,
+):
     """Initializes PASEOS
 
     Args:
-        local_actor (BaseActor): The actor linked to the local device which is required to model anything.
-        cfg (DotMap, optional): Configuration file. If None, default configuration will be used. Defaults to None.
-        starting_epoch(pk.epoch): Starting epoch of the simulation. Will override cfg and local actor one.
+        local_actor (BaseActor): The actor linked to the local device which is required to model
+        anything.
+        cfg (DotMap, optional): Configuration file. If None, default configuration will be used.
+        Defaults to None.
+        starting_epoch(pk.epoch): Starting epoch of the simulation. Will override cfg and local
+        actor one.
+        communication_links: A list of links from this instance to others.
     Returns:
         PASEOS: Instance of the simulation (only one can exist, singleton)
     """
@@ -47,11 +55,14 @@ def init_sim(local_actor: BaseActor, cfg: DotMap = None, starting_epoch: pk.epoc
 
     if local_actor.local_time.mjd2000 * pk.DAY2SEC != cfg.sim.start_time:
         logger.warning(
-            "You provided a different starting epoch for PASEOS than the local time of the local actor."
+            "You provided a different starting epoch for PASEOS than the local time of the local "
+            "actor."
             + "starting_epoch will be used."
         )
 
-    sim = PASEOS(local_actor=local_actor, cfg=cfg)
+    sim = PASEOS(
+        local_actor=local_actor, cfg=cfg, communication_links=communication_links
+    )
     return sim