test: update tests to use local data (#882)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Justin Winkler <[email protected]>

Author: 3 people

doc/source/changelog/882.test.md

@@ -485,13 +485,15 @@ def copy_examples_to_output_dir(app: sphinx.application.Sphinx, exception: Excep
     # TODO: investigate issues when using OUTPUT_EXAMPLES instead of SOURCE_EXAMPLES
     # https://github.com/ansys/pystk/issues/415
     OUTPUT_EXAMPLES = pathlib.Path(app.outdir) / "examples"
+    OUTPUT_DATA = OUTPUT_EXAMPLES / "data"
     OUTPUT_IMAGES = OUTPUT_EXAMPLES / "img"
-    for directory in [OUTPUT_EXAMPLES, OUTPUT_IMAGES]:
+    for directory in [OUTPUT_EXAMPLES, OUTPUT_DATA, OUTPUT_IMAGES]:
         if not directory.exists():
             directory.mkdir(parents=True, exist_ok=True)
 
     SOURCE_EXAMPLES = pathlib.Path(app.srcdir) / "examples"
     EXAMPLES_DIRECTORY = SOURCE_EXAMPLES.parent.parent.parent / "examples"
+    EXAMPLES_DATA_DIRECTORY = EXAMPLES_DIRECTORY / "data"
     IMAGES_DIRECTORY = EXAMPLES_DIRECTORY / "img"
 
     # Copy the examples
@@ -508,6 +510,20 @@ def copy_examples_to_output_dir(app: sphinx.application.Sphinx, exception: Excep
         destination_file = OUTPUT_EXAMPLES / file.name
         destination_file.write_text(file.read_text(encoding="utf-8"), encoding="utf-8")
 
+    # Copy the data files
+    all_data_files = list(EXAMPLES_DATA_DIRECTORY.glob("*.tle"))
+    data_files = [file for file in all_data_files]
+    for file in status_iterator(
+        data_files,
+        f"Copying example data to doc/_build/examples/data",
+        "green",
+        len(data_files),
+        verbosity=1,
+        stringify_func=(lambda x: x.name),
+    ):
+        destination_file = OUTPUT_DATA / file.name
+        destination_file.write_text(file.read_text(encoding="utf-8"), encoding="utf-8")
+
     # Copy the static images
     images = list(IMAGES_DIRECTORY.glob("*.png"))
     for file in status_iterator(
@@ -533,15 +549,17 @@ def copy_examples_files_to_source_dir(app: sphinx.application.Sphinx):
 
     """
     SOURCE_EXAMPLES = pathlib.Path(app.srcdir) / "examples"
+    SOURCE_DATA = SOURCE_EXAMPLES / "data"
     SOURCE_IMAGES = SOURCE_EXAMPLES / "img"
-    for directory in [SOURCE_EXAMPLES, SOURCE_IMAGES]:
+    for directory in [SOURCE_EXAMPLES, SOURCE_DATA, SOURCE_IMAGES]:
         if not directory.exists():
             directory.mkdir(parents=True, exist_ok=True)
 
     EXAMPLES_DIRECTORY = SOURCE_EXAMPLES.parent.parent.parent / "examples"
+    EXAMPLES_DATA_DIRECTORY = EXAMPLES_DIRECTORY / "data"
     IMAGES_DIRECTORY = EXAMPLES_DIRECTORY / "img"
 
-    # Copy the the examples
+    # Copy the examples
     all_examples = list(EXAMPLES_DIRECTORY.glob("*.py"))
     examples = [file for file in all_examples if f"{file.name}" not in exclude_examples]
     for file in status_iterator(
@@ -555,6 +573,20 @@ def copy_examples_files_to_source_dir(app: sphinx.application.Sphinx):
         destination_file = SOURCE_EXAMPLES / file.name
         destination_file.write_text(file.read_text(encoding="utf-8"), encoding="utf-8")
 
+    # Copy the data files
+    example_data_files = list(EXAMPLES_DATA_DIRECTORY.glob("*.tle"))
+    data_files = [file for file in example_data_files]
+    for file in status_iterator(
+        data_files,
+        f"Copying example data to doc/source/examples/data/",
+        "green",
+        len(data_files),
+        verbosity=1,
+        stringify_func=(lambda file: file.name),
+    ):
+        destination_file = SOURCE_DATA / file.name
+        destination_file.write_text(file.read_text(encoding="utf-8"), encoding="utf-8")
+
     # Copy the static images
     images = list(IMAGES_DIRECTORY.glob("*.png"))
     for file in status_iterator(

doc/source/conf.py

@@ -100,9 +100,10 @@
 satellite.set_propagator_type(PropagatorType.SGP4)
 propagator = satellite.propagator
 
-# Finally, use the propagator's `common_tasks` property to add the satellite's orbit from an online source, and propagate the satellite:
+# Finally, use the propagator's `common_tasks` property to add the satellite's orbit from a local file, and propagate the satellite:
 
-propagator.common_tasks.add_segments_from_online_source("31698")
+tle_file = pathlib.Path("data") / "TerraSarX_31698.tle"
+propagator.common_tasks.add_segments_from_file("31698", str(tle_file.resolve()))
 propagator.propagate()
 
 # ## Add the camp site

examples/communication-link-calculator.py

@@ -0,0 +1,3 @@
+1 31698U 07026A   24075.25000000  .00008923  00000-0  42574-3 0 00007
+2 31698 097.4466 083.7351 0001914 083.7701 301.0238 15.19143971928808
+

examples/data/TerraSarX_31698.tle

@@ -0,0 +1,2 @@
+1 25544U 98067A   22156.00000000  .00001944  00000-0  34115-4 0 00005
+2 25544 051.6451 036.9525 0004589 195.9534 179.2523 15.49879136343299

examples/data/iss_5Jun2022.tle

@@ -136,18 +136,19 @@
 
 # ### Add a satellite using the SPG4 propagator
 
-# **Note:** this portion requires internet access.
-
-# First, create the satellite using online data for the International Space Station (SSN number $25544$):
+# First, create the satellite using local data for the International Space Station (SSN number $25544$):
 
 # +
+import pathlib
+
 from ansys.stk.core.stkobjects import PropagatorType
 
 
 satellite = root.current_scenario.children.new(STKObjectType.SATELLITE, "MySatellite")
 satellite.set_propagator_type(PropagatorType.SGP4)
 propagator = satellite.propagator
-propagator.common_tasks.add_segments_from_online_source("25544")
+tle_file = pathlib.Path("data") / "iss_5Jun2022.tle"
+propagator.common_tasks.add_segments_from_file("25544", str(tle_file.resolve()))
 propagator.propagate()
 # -
 

examples/facility-to-satellite-access.py

@@ -0,0 +1,2 @@
+1 47954U 21022Y   20153.75000000  .00000000  00000-0  00000-0 0 00002
+2 47954 097.5686 057.1838 0018941 165.4562 124.5594 15.05622178000003

tests/doc_snippets_tests/data/KSU-CUBESAT_47954_1Jun2020.tle

@@ -23,6 +23,8 @@
 import os
 import sys
 
+from pathlib import Path
+
 
 # Add path to the parent directory to use some common utilities
 sys.path.insert(1, os.path.join(os.path.dirname(os.path.realpath(__file__)), ".."))
@@ -189,7 +191,8 @@ def _create_access_scenario(self):
         ksu_cubesat_propagator.ephemeris_interval.set_implicit_interval(
             root.current_scenario.analysis_workbench_components.time_intervals.item("AnalysisInterval")
         )
-        ksu_cubesat_propagator.common_tasks.add_segments_from_online_source("47954")
+        tle_file = Path(__file__).parent.parent / "data" / "KSU-CUBESAT_47954_1Jun2020.tle"
+        ksu_cubesat_propagator.common_tasks.add_segments_from_file("47954", str(tle_file.resolve()))
         ksu_cubesat_propagator.automatic_update_enabled = True
         ksu_cubesat_propagator.propagate()
 

tests/doc_snippets_tests/data_analysis/data_analysis_snippets.py

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 import os
+import pytest
 import sys
 
 from ansys.stk.core.stkobjects import (
@@ -244,6 +245,7 @@ def SPICESatelliteSnippet(self, root, satellite):
         propagator.step = 60.0
         propagator.propagate()
 
+    @pytest.mark.skip(reason="Temporarily disabled due to connectivity.")
     def test_SGP4SatelliteSnippet(self):
         try:
             satellite = self.get_scenario().children.new(STKObjectType.SATELLITE, "satellite")