processforge 0.2.22__tar.gz → 0.2.24__tar.gz

{processforge-0.2.22/src/processforge.egg-info → processforge-0.2.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: processforge
-Version: 0.2.22
+Version: 0.2.24
 Summary: A Python-based process simulation framework for chemical engineering applications.
 Author-email: Process Forge Team <team@processforge.dev>
 License-Expression: BSD-3-Clause
@@ -415,13 +415,15 @@ Run a simulation and map an output folder:
 
 ```Bash
   docker run -p 8080:8080 \
-    -e AWS_ACCESS_KEY_ID=... \
-    -e AWS_SECRET_ACCESS_KEY=... \
-    -e AWS_DEFAULT_REGION=us-east-1 \
+    -e S3_ACCESS_KEY='XXXXXX' \
+    -e S3_SECRET_KEY='YYYYYYYYY' \
+    -e S3_ENDPOINT_URL='https://processforge-files.ams3.s3.com' \
+    -e S3_REGION_NAME='ams3' \
+    -e S3_BUCKET_NAME='Dev' \
     ghcr.io/urjanova/processforge:latest \
     pf-serve
 ```
-(The -v flag ensures the .h5 or .xdmf files generated by OpenMC/FESTIM are saved to your actual hard drive, not lost inside the container.)
+(Ensure you provide your S3-compatible credentials and endpoint URL; output and results will be synced directly to the specified bucket.)
 ## Logo credit
 Google Gemini / Nano Banana
 

{processforge-0.2.22 → processforge-0.2.24}/README.md

@@ -354,13 +354,15 @@ Run a simulation and map an output folder:
 
 ```Bash
   docker run -p 8080:8080 \
-    -e AWS_ACCESS_KEY_ID=... \
-    -e AWS_SECRET_ACCESS_KEY=... \
-    -e AWS_DEFAULT_REGION=us-east-1 \
+    -e S3_ACCESS_KEY='XXXXXX' \
+    -e S3_SECRET_KEY='YYYYYYYYY' \
+    -e S3_ENDPOINT_URL='https://processforge-files.ams3.s3.com' \
+    -e S3_REGION_NAME='ams3' \
+    -e S3_BUCKET_NAME='Dev' \
     ghcr.io/urjanova/processforge:latest \
     pf-serve
 ```
-(The -v flag ensures the .h5 or .xdmf files generated by OpenMC/FESTIM are saved to your actual hard drive, not lost inside the container.)
+(Ensure you provide your S3-compatible credentials and endpoint URL; output and results will be synced directly to the specified bucket.)
 ## Logo credit
 Google Gemini / Nano Banana
 

{processforge-0.2.22 → processforge-0.2.24}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "processforge"
-version = "0.2.22"
+version = "0.2.24"
 description = "A Python-based process simulation framework for chemical engineering applications."
 readme = "README.md"
 license = "BSD-3-Clause"

{processforge-0.2.22 → processforge-0.2.24}/src/processforge/api/app.py

@@ -19,6 +19,20 @@ app = FastAPI(title="ProcessForge API", version=_version)
 _jobs: dict[str, dict] = {}
 
 
+@app.on_event("startup")
+async def startup_event():
+    import os
+    required_env_vars = [
+        "S3_ACCESS_KEY",
+        "S3_SECRET_KEY",
+        "S3_ENDPOINT_URL",
+        "S3_BUCKET_NAME",
+    ]
+    missing = [v for v in required_env_vars if not os.environ.get(v)]
+    if missing:
+        raise RuntimeError(f"Missing required S3 environment variables: {', '.join(missing)}")
+
+
 async def _run_job_in_thread(
     job_id: str,
     flowsheet: dict,

{processforge-0.2.22 → processforge-0.2.24}/src/processforge/api/models.py

@@ -1,13 +1,18 @@
 from __future__ import annotations
 
+import os
 from typing import Literal
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
+
+
+def _get_default_bucket() -> str:
+    return os.environ.get("S3_BUCKET_NAME", "")
 
 
 class RunRequest(BaseModel):
     flowsheet: dict
-    s3_bucket: str
+    s3_bucket: str = Field(default_factory=_get_default_bucket)
     s3_prefix: str | None = None
 
 

{processforge-0.2.22 → processforge-0.2.24}/src/processforge/api/runner.py

@@ -6,8 +6,11 @@ from pathlib import Path
 import boto3
 from loguru import logger
 
+import os
+import shutil
+import tempfile
 from processforge.provenance import build_dynamic_x0, build_run_info
-from processforge.result import save_results_zarr_s3
+from processforge.result import save_results_zarr
 from processforge.utils.validate_flowsheet import validate_flowsheet_dict
 
 
@@ -60,6 +63,12 @@ def run_job_sync(
     This is called from an async background task via asyncio.to_thread so
     the FastAPI event loop remains free to handle status-poll requests.
     """
+
+    log_file = tempfile.NamedTemporaryFile(delete=False, suffix=".log")
+    log_file.close()
+
+    logger_id = logger.add(log_file.name)
+
     jobs_store[job_id]["status"] = "running"
     jobs_store[job_id]["started_at"] = datetime.datetime.utcnow().isoformat() + "Z"
 
@@ -67,13 +76,36 @@ def run_job_sync(
         validate_flowsheet_dict(flowsheet)
         results, run_info = _run_simulation(flowsheet)
 
-        zarr_uri = f"s3://{s3_bucket}/{s3_prefix}/results.zarr"
-        save_results_zarr_s3(results, zarr_uri, run_info=run_info)
-        logger.info(f"[{job_id}] Zarr written to {zarr_uri}")
+        s3_client = boto3.client(
+            "s3",
+            aws_access_key_id=os.environ.get("S3_ACCESS_KEY"),
+            aws_secret_access_key=os.environ.get("S3_SECRET_KEY"),
+            endpoint_url=os.environ.get("S3_ENDPOINT_URL"),
+            region_name=os.environ.get("S3_REGION_NAME", "ams3"),
+        )
+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            local_zarr_path = os.path.join(tmpdir, "results.zarr")
+            save_results_zarr(results, local_zarr_path, run_info=run_info)
+
+            zip_base_name = os.path.join(tmpdir, "results")
+            shutil.make_archive(zip_base_name, "zip", root_dir=tmpdir, base_dir="results.zarr")
+            zip_path = f"{zip_base_name}.zip"
 
-        s3_client = boto3.client("s3")
+            zip_s3_key = f"{s3_prefix}/results.zip"
+            s3_client.upload_file(zip_path, s3_bucket, zip_s3_key)
+            zarr_uri = f"s3://{s3_bucket}/{zip_s3_key}"
+
+        logger.info(f"[{job_id}] Zipped Zarr written to {zarr_uri}")
         output_urls = _upload_outputs_dir(s3_client, s3_bucket, s3_prefix)
 
+        logger.remove(logger_id)
+
+        log_s3_key = f"{s3_prefix}/run.log"
+        s3_client.upload_file(log_file.name, s3_bucket, log_s3_key)
+        log_uri = f"s3://{s3_bucket}/{log_s3_key}"
+        os.unlink(log_file.name)
+
         jobs_store[job_id].update(
             {
                 "status": "complete",
@@ -81,11 +113,14 @@ def run_job_sync(
                 "s3_urls": {
                     "zarr": zarr_uri,
                     "outputs": output_urls,
+                    "log": log_uri,
                 },
             }
         )
     except Exception as exc:
         logger.exception(f"[{job_id}] Job failed: {exc}")
+        logger.remove(logger_id)
+
         jobs_store[job_id].update(
             {
                 "status": "failed",
@@ -93,3 +128,21 @@ def run_job_sync(
                 "error": str(exc),
             }
         )
+
+        try:
+            log_s3_key = f"{s3_prefix}/run.log"
+            s3_client = boto3.client(
+                "s3",
+                aws_access_key_id=os.environ.get("S3_ACCESS_KEY"),
+                aws_secret_access_key=os.environ.get("S3_SECRET_KEY"),
+                endpoint_url=os.environ.get("S3_ENDPOINT_URL"),
+                region_name=os.environ.get("S3_REGION_NAME", "ams3"),
+            )
+            s3_client.upload_file(log_file.name, s3_bucket, log_s3_key)
+            log_uri = f"s3://{s3_bucket}/{log_s3_key}"
+            jobs_store[job_id].setdefault("s3_urls", {})["log"] = log_uri
+        except Exception as e:
+            logger.error(f"Failed to upload log file: {e}")
+        finally:
+            if os.path.exists(log_file.name):
+                os.unlink(log_file.name)

{processforge-0.2.22 → processforge-0.2.24}/src/processforge/api/serve.py

@@ -3,13 +3,13 @@
 Usage::
 
     # Via registered script
-    pf-serve [--host 0.0.0.0] [--port 8080]
+    pf-serve [--host 0.0.0.0] [--port 9000]
 
     # Or directly
-    python -m processforge.api.serve [--host 0.0.0.0] [--port 8080]
+    python -m processforge.api.serve [--host 0.0.0.0] [--port 9000]
 
     # Or via Docker (override entrypoint)
-    docker run -p 8080:8080 ghcr.io/urjanova/processforge:latest pf-serve
+    docker run -p 9000:9000 ghcr.io/urjanova/processforge:latest pf-serve
 
 AWS credentials are read from the standard environment variables
 (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION) or from an
@@ -21,19 +21,19 @@ from __future__ import annotations
 import argparse
 
 
+import uvicorn
+
+from processforge.api.app import app
+
+
 def main() -> None:
     parser = argparse.ArgumentParser(
         description="Start the ProcessForge FastAPI server",
         formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     parser.add_argument("--host", default="0.0.0.0", help="Bind host")
-    parser.add_argument("--port", type=int, default=8080, help="Bind port")
+    parser.add_argument("--port", type=int, default=9000, help="Bind port")
     args = parser.parse_args()
-
-    import uvicorn
-
-    from processforge.api.app import app
-
     uvicorn.run(app, host=args.host, port=args.port, workers=1)
 
 

{processforge-0.2.22 → processforge-0.2.24}/src/processforge/result.py

@@ -140,8 +140,23 @@ def save_results_zarr_s3(results, s3_uri: str, run_info: RunInfo | dict | None =
         run_info: Optional provenance metadata (same as :func:`save_results_zarr`).
     """
     import s3fs  # noqa: F401 – registers the s3:// protocol with fsspec
+    import os
 
-    store = zarr.storage.FsspecStore.from_url(s3_uri)
+    storage_options = {
+        "key": os.environ.get("S3_ACCESS_KEY"),
+        "secret": os.environ.get("S3_SECRET_KEY"),
+    }
+
+    client_kwargs = {}
+    if endpoint := os.environ.get("S3_ENDPOINT_URL"):
+        client_kwargs["endpoint_url"] = endpoint
+    if region := os.environ.get("S3_REGION_NAME", "ams3"):
+        client_kwargs["region_name"] = region
+
+    if client_kwargs:
+        storage_options["client_kwargs"] = client_kwargs
+
+    store = zarr.storage.FsspecStore.from_url(s3_uri, storage_options=storage_options)
     root = zarr.group(store=store, overwrite=True)
     mode = "dynamic" if _is_dynamic(results) else "steady"
     root.attrs["mode"] = mode

{processforge-0.2.22 → processforge-0.2.24/src/processforge.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: processforge
-Version: 0.2.22
+Version: 0.2.24
 Summary: A Python-based process simulation framework for chemical engineering applications.
 Author-email: Process Forge Team <team@processforge.dev>
 License-Expression: BSD-3-Clause
@@ -415,13 +415,15 @@ Run a simulation and map an output folder:
 
 ```Bash
   docker run -p 8080:8080 \
-    -e AWS_ACCESS_KEY_ID=... \
-    -e AWS_SECRET_ACCESS_KEY=... \
-    -e AWS_DEFAULT_REGION=us-east-1 \
+    -e S3_ACCESS_KEY='XXXXXX' \
+    -e S3_SECRET_KEY='YYYYYYYYY' \
+    -e S3_ENDPOINT_URL='https://processforge-files.ams3.s3.com' \
+    -e S3_REGION_NAME='ams3' \
+    -e S3_BUCKET_NAME='Dev' \
     ghcr.io/urjanova/processforge:latest \
     pf-serve
 ```
-(The -v flag ensures the .h5 or .xdmf files generated by OpenMC/FESTIM are saved to your actual hard drive, not lost inside the container.)
+(Ensure you provide your S3-compatible credentials and endpoint URL; output and results will be synced directly to the specified bucket.)
 ## Logo credit
 Google Gemini / Nano Banana