PyGeoModel 1.0.10__tar.gz → 1.0.12__tar.gz

{pygeomodel-1.0.10 → pygeomodel-1.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyGeoModel
-Version: 1.0.10
+Version: 1.0.12
 Summary: A Python package for integrating OpenGMS geographic model services.
 Home-page: https://github.com/MpLebron/PyGeoModel
 Author: Peilong Ma
@@ -45,7 +45,7 @@ Dynamic: summary
 
 # PyGeoModel
 
-PyGeoModel is a Python package for integrating OpenGMS geographic model services into Python-based urban data science workflows. It provides programmatic access to model-service discovery, metadata inspection, service invocation, task records, and result management. For exploratory notebook-based analysis, PyGeoModel also provides an optional Jupyter interface built on the same core API.
+PyGeoModel is a Python package for integrating OpenGMS geographic model services into Python-based urban data science workflows. It provides programmatic access to model-service discovery, metadata inspection, service invocation, and result management. For exploratory notebook-based analysis, PyGeoModel also provides an optional Jupyter interface built on the same core API.
 
 ## Installation
 
@@ -81,36 +81,39 @@ result = modeler.invoke(
     "Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model",
     params={
         "system_efficiency": 0.8,
-        "start_time": 201801,
-        "end_time": 201812,
+        "start_time": "2018-01",
+        "end_time": "2018-12",
         "roof_vector_path": "data/rooftops.zip",
     },
 )
 
-result.to_json("execution_record.json")
+saved_files = result.save(output_dir="data/result/live_run")
 ```
 
+The model configuration is recorded directly in the Python cell through the explicit `params` dictionary, while `TaskResult.save()` stores the downloadable model outputs for subsequent analysis.
+
 ## Notebook Interface
 
 ```python
 modeler.show_models()
-modeler.invoke_model("SWAT_Model")
+modeler.invoke_model("Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model")
 ```
 
-The notebook interface renders model search, metadata inspection, parameter entry, task execution, and output display. It uses the same `search_models()`, `get_model()`, and `invoke()` functions as the programmatic API so GUI operations can be converted into Python dictionaries and execution records.
+The notebook interface renders model search, metadata inspection, parameter entry, task execution, and output display. It uses the same `search_models()`, `get_model()`, and `invoke()` functions as the programmatic API so GUI operations can be converted into explicit Python parameters and saved model outputs when needed.
 
-## Recommendation and Q&A Records
+## Recommendation and Q&A
 
 ```python
-recommendation = modeler.suggest_model(return_result=True)
-recommendation.to_json("recommendation_record.json")
+recommendation = modeler.suggest_model()
 
-answer = modeler.ask_model("SWAT_Model", "What input data are required?")
-answer.to_json("qa_record.json")
+answer = modeler.ask_model(
+    "Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model",
+    "What input data are required?",
+)
 ```
 
 The recommendation service automatically builds notebook/data context and calls the configured recommendation workflow. Q&A uses OpenGMS model metadata and an OpenAI-compatible web-enabled model. The main notebook workflow is designed to run out of the box for demonstration use.
 
 ## Relation to OpenGMS
 
-OpenGMS provides the model-service platform and online execution infrastructure. PyGeoModel is a Python client package that exposes OpenGMS model-service discovery, metadata inspection, task invocation, and result records to Python and notebook workflows.
+OpenGMS provides the model-service platform and online execution infrastructure. PyGeoModel is a Python client package that exposes OpenGMS model-service discovery, metadata inspection, task invocation, and result management to Python and notebook workflows.

{pygeomodel-1.0.10 → pygeomodel-1.0.12}/PyGeoModel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyGeoModel
-Version: 1.0.10
+Version: 1.0.12
 Summary: A Python package for integrating OpenGMS geographic model services.
 Home-page: https://github.com/MpLebron/PyGeoModel
 Author: Peilong Ma
@@ -45,7 +45,7 @@ Dynamic: summary
 
 # PyGeoModel
 
-PyGeoModel is a Python package for integrating OpenGMS geographic model services into Python-based urban data science workflows. It provides programmatic access to model-service discovery, metadata inspection, service invocation, task records, and result management. For exploratory notebook-based analysis, PyGeoModel also provides an optional Jupyter interface built on the same core API.
+PyGeoModel is a Python package for integrating OpenGMS geographic model services into Python-based urban data science workflows. It provides programmatic access to model-service discovery, metadata inspection, service invocation, and result management. For exploratory notebook-based analysis, PyGeoModel also provides an optional Jupyter interface built on the same core API.
 
 ## Installation
 
@@ -81,36 +81,39 @@ result = modeler.invoke(
     "Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model",
     params={
         "system_efficiency": 0.8,
-        "start_time": 201801,
-        "end_time": 201812,
+        "start_time": "2018-01",
+        "end_time": "2018-12",
         "roof_vector_path": "data/rooftops.zip",
     },
 )
 
-result.to_json("execution_record.json")
+saved_files = result.save(output_dir="data/result/live_run")
 ```
 
+The model configuration is recorded directly in the Python cell through the explicit `params` dictionary, while `TaskResult.save()` stores the downloadable model outputs for subsequent analysis.
+
 ## Notebook Interface
 
 ```python
 modeler.show_models()
-modeler.invoke_model("SWAT_Model")
+modeler.invoke_model("Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model")
 ```
 
-The notebook interface renders model search, metadata inspection, parameter entry, task execution, and output display. It uses the same `search_models()`, `get_model()`, and `invoke()` functions as the programmatic API so GUI operations can be converted into Python dictionaries and execution records.
+The notebook interface renders model search, metadata inspection, parameter entry, task execution, and output display. It uses the same `search_models()`, `get_model()`, and `invoke()` functions as the programmatic API so GUI operations can be converted into explicit Python parameters and saved model outputs when needed.
 
-## Recommendation and Q&A Records
+## Recommendation and Q&A
 
 ```python
-recommendation = modeler.suggest_model(return_result=True)
-recommendation.to_json("recommendation_record.json")
+recommendation = modeler.suggest_model()
 
-answer = modeler.ask_model("SWAT_Model", "What input data are required?")
-answer.to_json("qa_record.json")
+answer = modeler.ask_model(
+    "Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model",
+    "What input data are required?",
+)
 ```
 
 The recommendation service automatically builds notebook/data context and calls the configured recommendation workflow. Q&A uses OpenGMS model metadata and an OpenAI-compatible web-enabled model. The main notebook workflow is designed to run out of the box for demonstration use.
 
 ## Relation to OpenGMS
 
-OpenGMS provides the model-service platform and online execution infrastructure. PyGeoModel is a Python client package that exposes OpenGMS model-service discovery, metadata inspection, task invocation, and result records to Python and notebook workflows.
+OpenGMS provides the model-service platform and online execution infrastructure. PyGeoModel is a Python client package that exposes OpenGMS model-service discovery, metadata inspection, task invocation, and result management to Python and notebook workflows.

{pygeomodel-1.0.10 → pygeomodel-1.0.12}/README.md

@@ -1,6 +1,6 @@
 # PyGeoModel
 
-PyGeoModel is a Python package for integrating OpenGMS geographic model services into Python-based urban data science workflows. It provides programmatic access to model-service discovery, metadata inspection, service invocation, task records, and result management. For exploratory notebook-based analysis, PyGeoModel also provides an optional Jupyter interface built on the same core API.
+PyGeoModel is a Python package for integrating OpenGMS geographic model services into Python-based urban data science workflows. It provides programmatic access to model-service discovery, metadata inspection, service invocation, and result management. For exploratory notebook-based analysis, PyGeoModel also provides an optional Jupyter interface built on the same core API.
 
 ## Installation
 
@@ -36,36 +36,39 @@ result = modeler.invoke(
     "Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model",
     params={
         "system_efficiency": 0.8,
-        "start_time": 201801,
-        "end_time": 201812,
+        "start_time": "2018-01",
+        "end_time": "2018-12",
         "roof_vector_path": "data/rooftops.zip",
     },
 )
 
-result.to_json("execution_record.json")
+saved_files = result.save(output_dir="data/result/live_run")
 ```
 
+The model configuration is recorded directly in the Python cell through the explicit `params` dictionary, while `TaskResult.save()` stores the downloadable model outputs for subsequent analysis.
+
 ## Notebook Interface
 
 ```python
 modeler.show_models()
-modeler.invoke_model("SWAT_Model")
+modeler.invoke_model("Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model")
 ```
 
-The notebook interface renders model search, metadata inspection, parameter entry, task execution, and output display. It uses the same `search_models()`, `get_model()`, and `invoke()` functions as the programmatic API so GUI operations can be converted into Python dictionaries and execution records.
+The notebook interface renders model search, metadata inspection, parameter entry, task execution, and output display. It uses the same `search_models()`, `get_model()`, and `invoke()` functions as the programmatic API so GUI operations can be converted into explicit Python parameters and saved model outputs when needed.
 
-## Recommendation and Q&A Records
+## Recommendation and Q&A
 
 ```python
-recommendation = modeler.suggest_model(return_result=True)
-recommendation.to_json("recommendation_record.json")
+recommendation = modeler.suggest_model()
 
-answer = modeler.ask_model("SWAT_Model", "What input data are required?")
-answer.to_json("qa_record.json")
+answer = modeler.ask_model(
+    "Roof Photovoltaic Carbon Emission Reduction Potential Assessment Model",
+    "What input data are required?",
+)
 ```
 
 The recommendation service automatically builds notebook/data context and calls the configured recommendation workflow. Q&A uses OpenGMS model metadata and an OpenAI-compatible web-enabled model. The main notebook workflow is designed to run out of the box for demonstration use.
 
 ## Relation to OpenGMS
 
-OpenGMS provides the model-service platform and online execution infrastructure. PyGeoModel is a Python client package that exposes OpenGMS model-service discovery, metadata inspection, task invocation, and result records to Python and notebook workflows.
+OpenGMS provides the model-service platform and online execution infrastructure. PyGeoModel is a Python client package that exposes OpenGMS model-service discovery, metadata inspection, task invocation, and result management to Python and notebook workflows.

{pygeomodel-1.0.10 → pygeomodel-1.0.12}/pygeomodel/__init__.py

@@ -5,7 +5,7 @@ from .modeler import GeoModeler
 from .models import ModelInput, ModelOutput, ModelService, ModelSummary
 from .results import QAResult, RecommendationResult, TaskResult
 
-__version__ = "1.0.10"
+__version__ = "1.0.12"
 
 __all__ = [
     "GeoModeler",

{pygeomodel-1.0.10 → pygeomodel-1.0.12}/setup.py

@@ -11,7 +11,7 @@ def read_readme():
 
 setup(
     name="PyGeoModel",
-    version="1.0.10",
+    version="1.0.12",
     author="Peilong Ma",
     author_email="mpl_gis@nnu.edu.cn",
     description="A Python package for integrating OpenGMS geographic model services.",