Merge branch 'main' into feature/app-setting-secret

Author: cleemansen

.env

@@ -1,4 +1,4 @@
-SOURCE_FILE=./resources/samples/input1_LatLon.pickle
+SOURCE_FILE=./resources/samples/input4_LatLon.pickle
 # development settings
 CONFIGURATION_FILE=./app-configuration.json
 PRINT_CONFIGURATION=yes

.gitignore

@@ -7,9 +7,10 @@
 
 # User-specific stuff
 .idea/**/workspace.xml
+.idea/**/misc.xml
+.idea/**/*.iml
 .idea/**/tasks.xml
 .idea/**/usage.statistics.xml
-.idea/**/misc.xml
 .idea/**/dictionaries
 .idea/**/shelf
 

.idea/python-sdk.iml

@@ -4,9 +4,17 @@
 
 - introduce app-setting-type `SECRET`
 
+## 2024-xx
+
+- addition of examples in app.py of importing functions from other .py files, creating artifacts, translating result back to a TrajectoryCollection
+
+## 2024-09 `v2.2.1`
+
+- exchange samples: generated by next MoveApps move2 to movingpandas translator app
+
 ## 2024-09 `v2.2.1`
 
-- switch to [miniforge](https://github.com/conda-forge/miniforge)
+- switch build from `micromamba` to [miniforge](https://github.com/conda-forge/miniforge)
 
 ## 2024-03 `v2.1.0`
 

CHANGELOG_SDK.md

@@ -31,4 +31,4 @@ COPY --chown=$UID:$GID . $PROJECT_DIR
 RUN conda env create --prefix $ENV_PREFIX --file $PROJECT_DIR/environment.yml && \
     conda clean --all --yes
 
-ENTRYPOINT [ "conda", "run", "--prefix", "${ENV_PREFIX}", "python3", "sdk.py" ]
+ENTRYPOINT [ "conda", "run", "--no-capture-output", "--prefix", "${ENV_PREFIX}", "python3", "sdk.py" ]

Dockerfile_smoketest

@@ -15,4 +15,4 @@ COPY app/ ./app/
 RUN conda env create --prefix ${ENV_PREFIX}  --file environment.yml && \
     conda clean --all --yes
 
-RUN conda run --prefix ${ENV_PREFIX} python3 -m unittest
+RUN conda run --no-capture-output --prefix ${ENV_PREFIX} python3 -m unittest

Dockerfile_unittest

@@ -1,3 +1,4 @@
 {
-  "app-name": "MoveApps Python SDK"
+  "app-name": "MoveApps Python SDK",
+  "year": 2014
 }

app-configuration.json

@@ -2,6 +2,10 @@
 from sdk.moveapps_io import MoveAppsIo
 from movingpandas import TrajectoryCollection
 import logging
+import matplotlib.pyplot as plt
+
+# showcase for importing functions from another .py file (in this case from "./app/getGeoDataFrame.py")
+from app.getGeoDataFrame import get_GDF
 
 
 class App(object):
@@ -11,12 +15,42 @@ def __init__(self, moveapps_io):
 
     @hook_impl
     def execute(self, data: TrajectoryCollection, config: dict) -> TrajectoryCollection:
-        """Your app code goes here"""
+
         logging.info(f'Welcome to the {config}')
 
+        """Your app code goes here"""
+
+        # showcase injecting App settings (parameter `year`)
+        data_gdf = get_GDF(data)  # translate the TrajectoryCollection to a GeoDataFrame
+        logging.info(f'Subsetting data for {config["year"]}')
+        # subset the data to only contain the specified year
+        if config["year"] in data_gdf.index.year:
+            result = data_gdf[data_gdf.index.year == config["year"]]
+        else:
+            result = None
+
+        # showcase creating an artifact
+        if result is not None:
+            result.plot(column=data.get_traj_id_col(), alpha=0.5)
+            plot_file = self.moveapps_io.create_artifacts_file("plot.png")
+            plt.savefig(plot_file)
+            logging.info(f'saved plot to {plot_file}')
+        else:
+            logging.warning("Nothing to plot")
+
+        # showcase accessing auxiliary files
         auxiliary_file_a = MoveAppsIo.get_auxiliary_file_path("auxiliary-file-a")
         with open(auxiliary_file_a, 'r') as f:
             logging.info(f.read())
 
-        # return some useful data for next apps in the workflow
-        return data
+        # Translate the result back to a TrajectoryCollection
+        if result is not None:
+            result = TrajectoryCollection(
+                result,
+                traj_id_col=data.get_traj_id_col(),
+                t=data.to_point_gdf().index.name,
+                crs=data.get_crs()
+            )
+
+        # return the resulting data for next Apps in the Workflow
+        return result

app/app.py

@@ -0,0 +1,15 @@
+# showcase for defining functions in a file other than ./app/app.py 
+
+import logging
+from movingpandas import TrajectoryCollection
+from geopandas.geodataframe import GeoDataFrame
+
+def get_GDF(data: TrajectoryCollection) -> GeoDataFrame:
+
+    logging.info("Translating to GeoDataFrame")
+      
+    # Transfer the data to a GeoDataFrame
+    data_gdf = data.to_point_gdf()
+    
+    # Return the data
+    return data_gdf

app/getGeoDataFrame.py

@@ -8,6 +8,13 @@
       "default": "Python SDK",
       "type": "STRING"
     },
+    {
+      "id": "year",
+      "name": "The year",
+      "description": "Enter the year for which you want to keep the data",
+      "defaultValue": 1960,
+      "type": "INTEGER"
+    },
     {
       "id": "auxiliary-file-a",
       "name": "Your message",