simstadt 0.2.2__tar.gz → 0.2.3__tar.gz

{simstadt-0.2.2 → simstadt-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: simstadt
-Version: 0.2.2
+Version: 0.2.3
 Summary: Python library for using and testing SimStadt workflows.
 Author: Eric Duminil
 Author-email: Eric Duminil <eric.duminil@hft-stuttgart.de>
@@ -20,7 +20,8 @@ SimStadt is a city simulation tool for energy and urban analysis developed at HF
 ## Requirements
 
 - Python 3.10+
-- [SimStadt](https://simstadt.hft-stuttgart.de/download/InstallFiles/SimStadt2_latest.zip) installed separately
+- Java 17+
+- [SimStadt](https://simstadt.hft-stuttgart.de/download/InstallFiles/SimStadt2_latest.zip) installed separately (or use `simstadt --install`)
 
 ## Installation
 
@@ -73,6 +74,9 @@ If no project path is specified, workflows are run in a temporary repository und
 # Print detected SimStadt installation path and version
 simstadt
 
+# Download and install the latest SimStadt release to ~/Desktop
+simstadt --install
+
 # Launch the SimStadt GUI
 simstadt --gui
 

{simstadt-0.2.2 → simstadt-0.2.3}/README.md

@@ -7,7 +7,8 @@ SimStadt is a city simulation tool for energy and urban analysis developed at HF
 ## Requirements
 
 - Python 3.10+
-- [SimStadt](https://simstadt.hft-stuttgart.de/download/InstallFiles/SimStadt2_latest.zip) installed separately
+- Java 17+
+- [SimStadt](https://simstadt.hft-stuttgart.de/download/InstallFiles/SimStadt2_latest.zip) installed separately (or use `simstadt --install`)
 
 ## Installation
 
@@ -60,6 +61,9 @@ If no project path is specified, workflows are run in a temporary repository und
 # Print detected SimStadt installation path and version
 simstadt
 
+# Download and install the latest SimStadt release to ~/Desktop
+simstadt --install
+
 # Launch the SimStadt GUI
 simstadt --gui
 

{simstadt-0.2.2 → simstadt-0.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simstadt"
-version = "0.2.2"
+version = "0.2.3"
 description = "Python library for using and testing SimStadt workflows."
 readme = "README.md"
 authors = [

{simstadt-0.2.2 → simstadt-0.2.3}/src/simstadt/cli.py

@@ -6,10 +6,10 @@ import re
 import subprocess
 import sys
 from pathlib import Path
+from .install import cmd_install
 from .utils import chdir
 
 
-
 def cmd_info(args: argparse.Namespace) -> None:
     from .runner import get_simstadt_folder, get_simstadt_output, _simstadt_script
 
@@ -82,6 +82,7 @@ def build_parser() -> argparse.ArgumentParser:
         description="simstadt - Python library for SimStadt workflows.",
     )
     parser.add_argument("--gui", action="store_true", help="Launch the SimStadt GUI.")
+    parser.add_argument("--install", action="store_true", help="Download and install the latest SimStadt release to ~/Desktop.")
     parser.add_argument("template", nargs="?", help="Template name (from SIMSTADT_TEMPLATE_PATH) or path to a .flow directory.")
     parser.add_argument("citygml", nargs="?", type=Path, help="Path to the CityGML input file.")
     parser.add_argument("-d", "--description", help="Human-readable label for the result.")
@@ -96,6 +97,10 @@ def build_parser() -> argparse.ArgumentParser:
 def app() -> None:
     parser = build_parser()
     args = parser.parse_args()
+
+    if args.install:
+        cmd_install()
+
     if args.template and args.citygml:
         cmd_run(args)
     else:

simstadt-0.2.3/src/simstadt/install.py

@@ -0,0 +1,117 @@
+"""Download and install SimStadt from the official release ZIP."""
+
+import io
+import re
+import shutil
+import subprocess
+import sys
+import tempfile
+import urllib.request
+import zipfile
+from pathlib import Path
+
+from .runner import SIMSTADT_VERSION_FORMAT
+
+
+def _parse_simstadt_name(manifest: str) -> str:
+    m = re.search(f"Implementation-Version: *{SIMSTADT_VERSION_FORMAT}", manifest)
+    if not m:
+        raise ValueError("Cannot parse Implementation-Version from MANIFEST.MF")
+    version, branch, rev, date = m.groups()
+    return f"SimStadt2_{version}_{branch}_{date}_{rev}"
+
+
+def _get_java_version() -> int | None:
+    try:
+        result = subprocess.run(["java", "-version"], capture_output=True, text=True)
+        m = re.search(r'version "(\d+)', result.stderr)
+        return int(m.group(1)) if m else None
+    except FileNotFoundError:
+        return None
+
+
+def cmd_install() -> None:
+    url = "https://simstadt.hft-stuttgart.de/download/InstallFiles/SimStadt2_latest.zip"
+    desktop = Path.home() / "Desktop"
+
+    if not desktop.exists():
+        print(f"Error: {desktop} not found", file=sys.stderr)
+        raise SystemExit(1)
+
+    print("Downloading SimStadt...", file=sys.stderr)
+    tmp = None
+    try:
+        with tempfile.NamedTemporaryFile(suffix=".zip", delete=False) as f:
+            tmp = Path(f.name)
+        try:
+            urllib.request.urlretrieve(url, tmp)
+        except Exception as e:
+            print(f"Error: Download failed: {e}", file=sys.stderr)
+            raise SystemExit(1)
+
+        try:
+            with zipfile.ZipFile(tmp) as zf:
+                jar_entry = next(
+                    (
+                        n
+                        for n in zf.namelist()
+                        if re.match(r"lib/simstadt-desktop-.*\.jar$", n)
+                    ),
+                    None,
+                )
+                if not jar_entry:
+                    print(
+                        "Error: simstadt-desktop JAR not found in ZIP", file=sys.stderr
+                    )
+                    raise SystemExit(1)
+                with zipfile.ZipFile(io.BytesIO(zf.read(jar_entry))) as jar:
+                    if "META-INF/MANIFEST.MF" not in jar.namelist():
+                        print("Error: MANIFEST.MF not found in JAR", file=sys.stderr)
+                        raise SystemExit(1)
+                    manifest = jar.read("META-INF/MANIFEST.MF").decode(errors="replace")
+                try:
+                    name = _parse_simstadt_name(manifest)
+                except ValueError as e:
+                    print(f"Error: {e}", file=sys.stderr)
+                    raise SystemExit(1)
+                dest = desktop / name
+                if dest.exists():
+                    print(f"Already installed: {name}")
+                    return
+                dest.mkdir()
+                try:
+                    for member in zf.infolist():
+                        member_path = (dest / member.filename).resolve()
+                        if not member_path.is_relative_to(dest.resolve()):
+                            print(
+                                f"Error: ZIP contains unsafe path: {member.filename}",
+                                file=sys.stderr,
+                            )
+                            raise SystemExit(1)
+                    zf.extractall(dest)
+                    for member in zf.infolist():
+                        mode = member.external_attr >> 16
+                        if mode:
+                            (dest / member.filename).chmod(mode)
+                except BaseException:
+                    shutil.rmtree(dest, ignore_errors=True)
+                    raise
+                print(f"Installed: {dest}")
+        except zipfile.BadZipFile as e:
+            print(f"Error: Invalid ZIP file: {e}", file=sys.stderr)
+            raise SystemExit(1)
+    finally:
+        if tmp and tmp.exists():
+            tmp.unlink()
+
+    java_version = _get_java_version()
+    if java_version is None:
+        print(
+            "Warning: Java not found. SimStadt requires Java 17. Download: https://bell-sw.com/pages/downloads/#jdk-17-lts",
+            file=sys.stderr,
+        )
+    elif java_version < 17:
+        print(
+            f"Warning: Java {java_version} found but SimStadt requires Java 17. Download: https://bell-sw.com/pages/downloads/#jdk-17-lts",
+            file=sys.stderr,
+        )

{simstadt-0.2.2 → simstadt-0.2.3}/src/simstadt/results/base.py

@@ -119,15 +119,22 @@ class SimStadtResults(ABC):
 
     @property
     def name(self) -> str:
-        return self._params_element(".//void[@property='name']/string").text or "Unknown"
+        return (
+            self._params_element(".//void[@property='name']/string").text or "Unknown"
+        )
 
     @property
     def short_name(self) -> str:
-        return self._params_element(".//void[@property='shortName']/string").text or "Unknown"
+        return (
+            self._params_element(".//void[@property='shortName']/string").text
+            or "Unknown"
+        )
 
     @property
     def workflow_provider(self) -> str:
-        return self._params_element(".//void[@property='workflowProvider']/object").get("class", "Unknown provider")
+        return self._params_element(".//void[@property='workflowProvider']/object").get(
+            "class", "Unknown provider"
+        )
 
     @property
     def workflow_path(self) -> Path:
@@ -136,7 +143,10 @@ class SimStadtResults(ABC):
 
     @property
     def citygml(self) -> str:
-        return self._params_element(".//void[@property='cityGmlFileNames']//string").text or "Unknown CityGML"
+        return (
+            self._params_element(".//void[@property='cityGmlFileNames']//string").text
+            or "Unknown CityGML"
+        )
 
     @property
     def project_path(self) -> Path:
@@ -170,13 +180,7 @@ class SimStadtResults(ABC):
 
     @property
     def csv_path(self) -> Path:
-        csvs = self.get_all_by_extension(".csv")
-        relevant_csvs = [csv for csv in csvs if self.csv_identifier in csv.name]
-        if len(relevant_csvs) == 0:
-            raise ValueError("Workflow didn't seem to have returned any CSV file!")
-        if len(relevant_csvs) > 1:
-            logger.warning("Too many CSV results found for %s", self)
-        return relevant_csvs[-1]
+        return self.get_unique_by_extension('.csv', self.csv_identifier)
 
     def csv_content(self) -> bytes:
         with open(self.csv_path, "rb") as f:
@@ -185,6 +189,16 @@ class SimStadtResults(ABC):
     def get_all_by_extension(self, ext: str) -> list[Path]:
         return [f for f in sorted(self.output_files) if f.suffix == ext]
 
+    def get_unique_by_extension(self, ext: str, filter: str | None = None) -> Path:
+        files_by_extension = self.get_all_by_extension(ext)
+        if filter:
+            files_by_extension = [f for f in files_by_extension if filter in f.name]
+        if len(files_by_extension) == 0:
+            raise ValueError(f"Workflow didn't seem to have returned any {ext} file!")
+        if len(files_by_extension) > 1:
+            raise ValueError(f"Too many {ext} results found for {self}!")
+        return files_by_extension[0]
+
     @property
     def diagrams(self) -> dict[str, Path]:
         return {}
@@ -243,6 +257,10 @@ class SimStadtResults(ABC):
     def create(cls, provider: str, **kwargs) -> "SimStadtResults":
         if provider not in cls._registry:
             from .unknown_workflow import UnknownWorkflowResults
-            logger.warning("Unknown workflow provider: %s. Returning UnknownWorkflowResults.", provider)
+
+            logger.warning(
+                "Unknown workflow provider: %s. Returning UnknownWorkflowResults.",
+                provider,
+            )
             return UnknownWorkflowResults(**kwargs)
         return cls._registry[provider](**kwargs)

{simstadt-0.2.2 → simstadt-0.2.3}/src/simstadt/results/energy_grid.py

@@ -19,9 +19,7 @@ class EnergyGridResults(SimStadtResults):
     csv_identifier = "json_only"
 
     def _parse_results(self) -> pd.DataFrame:
-        jsons = self.get_all_by_extension(".json")
-        assert len(jsons) == 1, f"Exactly one JSON file should have been written: {len(jsons)} were found."
-        json_output = jsons[0]
+        json_output = self.get_unique_by_extension(".json")
         with open(json_output, encoding="utf-8") as out:
             content = json.load(out)
         buildings = content["buildings"]

{simstadt-0.2.2 → simstadt-0.2.3}/src/simstadt/results/solar_potential.py

@@ -20,11 +20,9 @@ class SolarPotentialResults(SimStadtResults):
     csv_identifier = "_solar_potential"  # no CSV output; csv_path will raise if called
 
     def _parse_results(self) -> pd.DataFrame:
-        prn_paths = self.get_all_by_extension(".prn")
-        if len(prn_paths) != 1:
-            raise ValueError(f"Expected exactly one .prn file, found {len(prn_paths)}")
+        prn_path = self.get_unique_by_extension(".prn")
         return pd.read_csv(
-            prn_paths[0], sep=r"\s+", names=["GHI", "DHI", "Ta"], header=None
+            prn_path, sep=r"\s+", names=["GHI", "DHI", "Ta"], header=None
         )
 
     @property

{simstadt-0.2.2 → simstadt-0.2.3}/src/simstadt/runner.py

@@ -26,6 +26,7 @@ from .utils import chdir, random_id
 PARAMS = "params.xml"
 SIMSTADT2_GLOB = "SimStadt2_0.*/"
 SIMSTADT_TEMP_REPO = Path(tempfile.gettempdir()) / "simstadt_repo"
+SIMSTADT_VERSION_FORMAT = r"(\S+)\s*\((\w+), rev. (\w+), (\d+)\s*\)"
 
 load_dotenv()
 
@@ -69,9 +70,9 @@ def get_template_path() -> Path:
     )
 
 def get_version_and_date() -> tuple[str, str]:
-    SIMSTADT_VERSION_FORMAT = re.compile(r"Launching SimStadt (\S+) \((\w+), rev. (\w+), (\d+)\)")
+    SIMSTADT_VERSION_PATTERN = re.compile(f"Launching SimStadt {SIMSTADT_VERSION_FORMAT}")
     output = get_simstadt_output(get_simstadt_folder())
-    m = SIMSTADT_VERSION_FORMAT.search(output)
+    m = SIMSTADT_VERSION_PATTERN.search(output)
     if not m:
         raise ValueError(f"No SimStadt version string found in output:\n{output}")
     version, _branch, _commit, date = m.groups()