juice-spark 0.1.1__tar.gz

juice_spark-0.1.1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: juice-spark
+Version: 0.1.1
+Summary: 
+Author: Pilar Esquej
+Author-email: Pilar.Esquej@ext.esa.int
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: esac-juice-pyutils (>=0.3.2,<0.4.0)
+Requires-Dist: jupitermag (>=1.5.1,<2.0.0)
+Requires-Dist: kaleido (>=1.0.0)
+Requires-Dist: matplotlib (>=3.11.1,<4.0.0)
+Requires-Dist: mplcursors (>=0.7.1,<0.8.0)
+Requires-Dist: mysql-connector-python (>=26.7.0,<27.0.0)
+Requires-Dist: numpy (>=2.5.3,<3.0.0)
+Requires-Dist: pandas (>=3.0.5,<4.0.0)
+Requires-Dist: planetary-coverage (>=1.2.1,<2.0.0)
+Requires-Dist: plotly (>=7.0.0,<8.0.0)
+Requires-Dist: python-dotenv (>=1.2.3,<2.0.0)
+Requires-Dist: soa-report (>=1.2.7,<2.0.0)
+Requires-Dist: spiceypy (>=8.2.0,<9.0.0)
+Requires-Dist: tabulate (>=0.10.0,<0.11.0)
+Requires-Dist: wget (>=3.2,<4.0)
+Description-Content-Type: text/markdown
+
+# JUICE SPARK
+
+[![Python Version](https://img.shields.io/badge/Python-3.11%2B-blue)](https://www.python.org/downloads/)
+
+## Description
+
+JUICE SPARK is a Python project that provides tools and functionalities for visualizing and analyzing data related to the JUICE mission. It aims to facilitate the creation of plots and visualizations for various purposes, such as mission planning, data analysis, and scientific research.
+
+## Installation
+
+1. Clone the repository: `https://gitlab.esa.int/juice-soc/juice-uplink/auxiliary-tools/juice-spark.git`
+2. Install the dependencies: `poetry install`
+
+## Usage
+### Command Line Options
+
+To run JUICE Plots from the command line, use the following command:
+
+```bash
+
+TBD
+
+```
+
+#### Example
+
+TBD
+
+### Configuration
+
+TBD

juice_spark-0.1.1/README.md

@@ -0,0 +1,31 @@
+# JUICE SPARK
+
+[![Python Version](https://img.shields.io/badge/Python-3.11%2B-blue)](https://www.python.org/downloads/)
+
+## Description
+
+JUICE SPARK is a Python project that provides tools and functionalities for visualizing and analyzing data related to the JUICE mission. It aims to facilitate the creation of plots and visualizations for various purposes, such as mission planning, data analysis, and scientific research.
+
+## Installation
+
+1. Clone the repository: `https://gitlab.esa.int/juice-soc/juice-uplink/auxiliary-tools/juice-spark.git`
+2. Install the dependencies: `poetry install`
+
+## Usage
+### Command Line Options
+
+To run JUICE Plots from the command line, use the following command:
+
+```bash
+
+TBD
+
+```
+
+#### Example
+
+TBD
+
+### Configuration
+
+TBD

juice_spark-0.1.1/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "juice-spark"
+version = "0.1.1"
+description = ""
+authors = [
+    {name = "Pilar Esquej",email = "Pilar.Esquej@ext.esa.int"}
+]
+readme = "README.md"
+requires-python = ">=3.12,<4.0"
+dependencies = [
+    "numpy (>=2.5.3,<3.0.0)",
+    "pandas (>=3.0.5,<4.0.0)",
+    "spiceypy (>=8.2.0,<9.0.0)",
+    "matplotlib (>=3.11.1,<4.0.0)",
+    "plotly (>=7.0.0,<8.0.0)",
+    "tabulate (>=0.10.0,<0.11.0)",
+    "wget (>=3.2,<4.0)",
+    "python-dotenv (>=1.2.3,<2.0.0)",
+    "kaleido (>=1.0.0)",
+    "planetary-coverage (>=1.2.1,<2.0.0)",
+    "esac-juice-pyutils (>=0.3.2,<0.4.0)",
+    "soa-report (>=1.2.7,<2.0.0)",
+    "jupitermag (>=1.5.1,<2.0.0)",
+    "mysql-connector-python (>=26.7.0,<27.0.0)",
+    "mplcursors (>=0.7.1,<0.8.0)"
+]
+
+[tool.poetry]
+packages = [{include = "juice_spark", from = "src"}]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = [
+    "jupyter (>=1.1.1,<2.0.0)",
+    "nbconvert (>=7.17.1,<8.0.0)"
+]
+
+[tool.poetry.scripts]
+juice-spark = "juice_spark.cli.execute_spark:main"

juice_spark-0.1.1/src/juice_spark/.idea/.gitignore

@@ -0,0 +1,5 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/

juice_spark-0.1.1/src/juice_spark/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

juice_spark-0.1.1/src/juice_spark/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

juice_spark-0.1.1/src/juice_spark/.idea/juice_spark.iml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="jdk" jdkName="Python 3.14" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="PyDocumentationSettings">
+    <option name="format" value="PLAIN" />
+    <option name="myDocStringFormat" value="Plain" />
+  </component>
+</module>

juice_spark-0.1.1/src/juice_spark/.idea/misc.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value="Python 3.14" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.14" project-jdk-type="Python SDK" />
+</project>

juice_spark-0.1.1/src/juice_spark/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/juice_spark.iml" filepath="$PROJECT_DIR$/.idea/juice_spark.iml" />
+    </modules>
+  </component>
+</project>

juice_spark-0.1.1/src/juice_spark/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$/../.." vcs="Git" />
+  </component>
+</project>

juice_spark-0.1.1/src/juice_spark/cli/data/template.json

@@ -0,0 +1,128 @@
+{
+    "trajectory": "G_CREMA_5_2",
+    "api_url": "http://juiuldock01.evsp.lan:8080/rest_api",
+    "crema_name": "crema_5_2",
+    "mysql_host": "${HOST}",
+    "mysql_port": "${PORT}",
+    "mysql_db": "${MYSQL_DB_NAME}",
+    "mysql_user": "${MYSQL_DB_USER}",
+    "mysql_pass": "${MYSQL_PASS}",
+    "main_target": "Jupiter",
+    "input_conf_path": "${CONF_REPO}/internal",
+    "output_path": "${CONF_REPO}/internal/juice_spark/sap",
+    "plots": [
+        {
+            "plot_type": "dual_series_plot",
+            "left_data_source": {
+                "type": "restapi",
+                "location": "G_CREMA_5_2",
+                "series": "ssc_alt"
+            },
+            "right_data_source": {
+                "type": "restapi",
+                "location": "G_CREMA_5_2",
+                "series": "ssc_phase"
+            },
+            "title": "Spacecraft Altitude vs Phase",
+            "plot_id": "alt_vs_phase",
+            "background_ranges": [
+                {
+                    "label": "Science Blackout",
+                    "start": "2035-03-23T01:00:00",
+                    "end": "2035-04-01T13:00:00",
+                    "color": "#000000"
+                }
+            ]
+        },
+        
+        {
+            "plot_type": "event_duration_plot",
+            "title": "Sun Occultations",
+            "plot_id": "sun_occ",
+            "events": [
+                "SUN_OCC_BY_JUPITER",
+                "SUN_OCC_BY_GANYMEDE"
+            ]
+        },
+        {
+            "plot_type": "event_duration_plot",
+            "events": [
+                "OCC_EARTH_000"
+            ],
+            "background_events": ["SUN_CONJUNCTION_SUP"],
+            "title": "Earth Occultations",
+            "plot_id": "earth_occ"
+        },
+        {
+            "plot_type": "dual_series_plot",
+            "left_data_source": {
+                "type": "brf",
+                "location": "/Users/randres/temp/juice-plots/tests/datasources/data/BRF_MLG_SGICD_2_2_300101_351005.brf",
+                "series": "HGAKA20"
+            },
+            "right_data_source": {
+                "type": "brf",
+                "location": "/Users/randres/temp/juice-plots/tests/datasources/data/BRF_MLG_SGICD_2_2_300101_351005.brf",
+                "series": "HGAX",
+                "dual": false
+            },
+            "title": "HGA Downlink data rates",
+            "y_left_title": "bits/s",
+            "plot_id": "bitrate",
+            "background_ranges": [
+                {
+                    "label": "Science Blackout",
+                    "start": "2035-03-23T01:00:00",
+                    "end": "2035-04-01T13:00:00",
+                    "color": "#000000"
+                }
+            ]
+        },
+        {
+            "plot_type": "dual_series_plot",
+            "left_data_source": {
+                "type": "osve",
+                "location": "/Users/randres/temp/juice-plots/sandbox/GAN_5_2_341030_351011/OUTPUT/osve_datapack.csv",
+                "series": "EPS_SA_AVAIL_POWER"
+            },
+            "right_data_source": {
+                "type": "osve",
+                "location": "/Users/randres/temp/juice-plots/sandbox/GAN_5_2_341030_351011/OUTPUT/osve_datapack.csv",
+                "series": "EPS_SA_ANGLE"
+            },
+            "background_ranges": [
+                {
+                    "label": "Science Blackout",
+                    "start": "2035-03-23T01:00:00",
+                    "end": "2035-04-01T13:00:00",
+                    "color": "#000000"
+                }
+            ],
+            "title": "Solar Array Available Power",
+            "y_left_title": "Available power (W)",
+            "y_right_title": "Solar Array Angle (deg)",
+            "y_left_range": [1320, 1370],
+            "plot_id": "power"
+        },
+        {
+            "plot_type": "dw_plot",
+            "left_data_source": {
+                "type": "brf",
+                "location": "/Users/randres/temp/juice-plots/tests/datasources/data/BRF_MLG_SGICD_2_2_300101_351005.brf",
+                "series": "HGAKA20"
+            },
+            "title": "Science Downlink Capacity Band-Ka HGAKA20",
+            "plot_id": "dw_hga_ka"
+        },
+        {
+            "plot_type": "dw_plot",
+            "left_data_source": {
+                "type": "brf",
+                "location": "/Users/randres/temp/juice-plots/tests/datasources/data/BRF_MLG_SGICD_2_2_300101_351005.brf",
+                "series": "HGAX"
+            },
+            "title": "Science Downlink Capacity Band-X HGAX",
+            "plot_id": "dw_hga_x"
+        }
+    ]
+}

juice_spark-0.1.1/src/juice_spark/cli/execute_spark.py

@@ -0,0 +1,159 @@
+import json
+import os
+import argparse
+from pathlib import Path
+from dotenv import load_dotenv
+
+from juice_spark.plots.PJ_AJ_Phase_4_pipeline import plot_PJ_AJ_Phase_4
+from juice_spark.plots.ROI_inter_gt_flybys_illum_pipeline import plot_ROI_inter_gt_flybys_illum
+from juice_spark.plots.PEP_NIM_all_flybys_pipeline import plot_PEP_NIM_all_flybys
+from juice_spark.plots.MTP_periods_SAP_pipeline import table_mtp_periods
+from juice_spark.plots.ansa_1_2_phase_vs_RJ_pipeline import plot_ansa_1_2_phase_vs_dist
+from juice_spark.plots.datas_flybys_csv_pipeline import table_datas_flybys
+from juice_spark.plots.visibility_during_earth_occ_pipeline import plot_visibility_during_earth_occ
+from juice_spark.plots.station_visibility_timeline_pipeline import plot_station_visibility_timeline
+from juice_spark.plots.power_during_flybys_pipeline import plot_power_during_flybys
+
+from juice_spark.plots.juice_tour_flybys import tour_flybys
+from juice_spark.plots.juice_trajectory_summary import perijove_plots, trajectory_summary, trajectory_plots
+from juice_spark.plots.juice_wg4_trajectory_plots import wg4_plots
+from juice_spark.plots.juice_dv_per_pass_simplified import dv_per_pass
+
+
+def load_config(config_file):
+    load_dotenv()
+
+    with open(config_file) as f:
+        config = json.load(f)
+
+    return _expand_environment_variables(config)
+
+
+def _expand_environment_variables(value):
+    if isinstance(value, dict):
+        return {
+            key: _expand_environment_variables(item)
+            for key, item in value.items()
+        }
+
+    if isinstance(value, list):
+        return [_expand_environment_variables(item) for item in value]
+
+    if isinstance(value, str):
+        return os.path.expandvars(value)
+
+    return value
+
+
+def run_reports(config, report=None):
+
+    crema_name = config["crema_name"]
+    main_target = config["main_target"]
+    target = main_target.lower()
+    #mission_timeline = config["mission_timeline"]
+    _, crema_num = crema_name.split("_", 1)
+    if target == "ganymede":
+        mission_timeline_file = f"mission_timeline_event_file_{target.lower()}_phase_{crema_num}.csv"
+    elif target == "jupiter" or target is None:
+        mission_timeline_file = f"mission_timeline_event_file_{crema_num}.csv"
+
+    meta_kernel = f"juice_{crema_name}_local.tm"
+    sql_earth_occs_by_jupiter = f"Juice_earth_occs_by_jupiter_{crema_name}"
+    sql_table_segments_opp = f"Juice_segments_opportunities_{crema_name}"
+    sql_table_flybys_science = f"juice_flybys_science_phase_{crema_name}"
+
+    mission_phases = (
+            Path(config["input_conf_path"])
+            / "geopipeline"
+            / "output"
+            / config["crema_name"]
+            / "Mission_Phases.csv"
+    )
+
+    mission_timeline = (
+            Path(config["input_conf_path"])
+            / "geopipeline"
+            / "output"
+            / config["crema_name"]
+            / mission_timeline_file
+    )
+
+    output_geopipeline = (
+            Path(config["input_conf_path"])
+            / "geopipeline"
+            / "output"
+    )
+
+    output_figures = (
+            Path(config["output_path"])
+            / config["crema_name"]
+            / "figures"
+    )
+
+    output_tables = (
+            Path(config["output_path"])
+            / config["crema_name"]
+            / "tables"
+    )
+
+    config_sql = {
+        'user': config["mysql_user"],
+        'password': config["mysql_pass"],
+        'host': config["mysql_host"],
+        'port': config["mysql_port"],
+        'database': config["mysql_db"],
+        'raise_on_warnings': True
+    }
+
+
+    reports = {
+        "pj-aj": (plot_PJ_AJ_Phase_4, (meta_kernel, crema_name, mission_timeline, mission_phases, output_figures / "mission/jupiter")),
+        "mtp-periods": (
+            table_mtp_periods,
+            (meta_kernel, crema_name, mission_timeline, mission_phases, output_tables / "mission", config_sql,
+             sql_earth_occs_by_jupiter),
+        ),
+        "power_flybys": (plot_power_during_flybys,
+                         (config_sql, sql_table_flybys_science, output_figures / "mission/power")),
+        "roi": (plot_ROI_inter_gt_flybys_illum, (meta_kernel, output_figures / "opportunities/flybys")),
+        "pep-nim": (plot_PEP_NIM_all_flybys, (meta_kernel, output_figures / "opportunities/flybys")),
+        "ansa": (plot_ansa_1_2_phase_vs_dist, (config_sql, meta_kernel, sql_table_segments_opp, output_figures / "opportunities/rings-and-moons")),
+        "vis_earth": (
+           plot_visibility_during_earth_occ,
+           (meta_kernel, config_sql, sql_earth_occs_by_jupiter, sql_table_segments_opp,
+           output_figures / "opportunities/jupiter"),
+       ),
+       "vis_flybys": (plot_station_visibility_timeline, (meta_kernel, output_figures / "appendix/visibilities")),
+        "table_flybys": (table_datas_flybys, (config_sql, meta_kernel, sql_table_flybys_science, output_tables / "appendix")),
+        "tour_flybys": (tour_flybys, (meta_kernel, mission_phases, output_figures / "mission/flybys")),
+        "jupiter_pj": (perijove_plots, (crema_name, output_figures / "mission/jupiter")),
+        #"summary": (trajectory_summary, (crema_name, output_figures  / "mission/jupiter")),
+        "trajectory": (trajectory_plots, (meta_kernel, mission_timeline, mission_phases, output_figures  / "mission/jupiter")),
+        "wg4_plots": (wg4_plots, (crema_name, meta_kernel, mission_timeline, mission_phases, output_figures / "mission/jupiter")),
+        "dv_pass": (dv_per_pass, (crema_name, meta_kernel, mission_phases, output_geopipeline, output_figures / "mission/downlink")),
+    }
+
+    if report is None:
+        for name, (function, args) in reports.items():
+            print(f"Running report: {name}")
+            function(*args)
+    else:
+        try:
+            function, args = reports[report]
+        except KeyError:
+            raise ValueError(f"Unknown report: {report}")
+
+        print(f"Running report: {report}")
+        function(*args)
+
+
+def main():
+    parser = argparse.ArgumentParser(description="Generate JUICE reporting products.")
+    parser.add_argument("config", help="Path to the configuration JSON file.")
+    parser.add_argument("--report", help="Run only the specified report.")
+
+    args = parser.parse_args()
+    run_reports(load_config(args.config), args.report)
+
+if __name__ == "__main__":
+    main()

juice_spark-0.1.1/src/juice_spark/cli/sapy.py

@@ -0,0 +1,56 @@
+from importlib import resources
+import logging
+import sys
+import json
+import argparse
+
+from juice_plots.sap_plotter import SapProcessor
+
+logging.getLogger("kaleido").setLevel(logging.WARNING)
+logging.getLogger("choreographer").setLevel(logging.WARNING)
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s | %(levelname)s | %(name)s | %(message)s",
+    stream=sys.stdout,
+)
+
+
+def dump_template():
+    logging.basicConfig(level=logging.INFO, format="%(message)s", stream=sys.stdout)
+    template = resources.files(__package__) / "data" / "template.json"
+    logging.info(template.read_text())
+
+def main():
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument("configuration", type=argparse.FileType("r"), help="json configuration file", nargs='?')
+    parser.add_argument("-d", "--debug", action="store_true", help="enable debug logging")
+    parser.add_argument("-t", "--template", action="store_true", help="dump template configuration")
+    args = parser.parse_args()
+
+    logging.basicConfig(level=logging.DEBUG if args.debug else logging.INFO)
+
+    if args.template:
+        dump_template()
+        sys.exit(0)
+
+    if args.configuration is None:
+        logging.error("No configuration file provided")
+        sys.exit(1)
+
+    try:
+        conf = json.load(args.configuration)
+    except json.JSONDecodeError as e:
+        logging.error(f"Error parsing configuration file: {e}")
+        sys.exit(1)
+
+    trajectory_id = conf.get("trajectory")
+    api_url = conf.get("api_url")
+
+    jp = SapProcessor(api_url, trajectory_id)
+    jp.plot_configuration(conf.get("plots"))
+
+
+if __name__ == "__main__":
+    main()

juice_spark-0.1.1/src/juice_spark/core/sht.py

@@ -0,0 +1,59 @@
+from pathlib import Path
+
+import requests
+
+REQUEST_TIMEOUT = 120
+
+
+def get_trajectory_ptr(crema_id, output_folder):
+    """Downloads the PTR associated to the trajectory and stores it in the
+    output folder
+
+    Args:
+        crema_id (str): _description_
+        output_folder (str | path): target folder
+
+    Returns:
+        str: file path of the PTR associated to the trajectory
+    """
+    response = requests.get(
+        f"https://juicesoc.esac.esa.int/rest_api/trajectory/{crema_id}/ptr",
+        timeout=REQUEST_TIMEOUT)
+    if response.status_code == requests.codes.ok:
+        ptr_url = response.json().get("ptr_file")
+        download = requests.get(ptr_url, timeout=REQUEST_TIMEOUT)
+        if download.status_code == requests.codes.ok:
+            ptr_path = Path(output_folder, f"{crema_id}.ptx")
+            with ptr_path.open("wb") as file:
+                file.write(download.content)
+            return ptr_path
+    return None
+
+def get_trajectory_phases(crema_id):
+    response = requests.get(f"https://juicesoc.esac.esa.int/rest_api/trajectory/{crema_id}/", timeout=REQUEST_TIMEOUT)
+    trajectory = response.json()
+    return trajectory.get("phases")
+
+
+def __get_sht_config():
+    response = requests.get("https://juicesoc.esac.esa.int/rest_api/config/", timeout=REQUEST_TIMEOUT)
+    return response.json()
+
+def get_targets():
+    """Returns the target mnemonics available in SHT
+
+    Returns:
+        list of str: list of targets
+    """
+    config = __get_sht_config()
+    return [item.get("mnemonic") for item in config.get("targets")]
+
+
+def get_instrument_types():
+    """Returns the instrument types mnemonics available in SHT
+
+    Returns:
+        list of str: list of instrument types
+    """
+    config = __get_sht_config()
+    return [item.get("mnemonic") for item in config.get("instrument_types")]