prisma-api 0.4.4__tar.gz → 0.4.6__tar.gz

{prisma_api-0.4.4 → prisma_api-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prisma_api
-Version: 0.4.4
+Version: 0.4.6
 Summary: A package for interacting with PrISMa Platform APIs. PrISMa is a holistic system for numerical synthesis and assessment of Metal-Organic Frameworks and their applications, for Direct Air Capture of CO2. For more information, see: https://prisma.hw.ac.uk.
 Author-email: RCCS-CaptureTeam <team@prisma-platform.org>
 License: GNUv3
@@ -165,7 +165,7 @@ The main client exposes these v1 methods:
 - `get_materials_data(payload={}, separate_experimental=True)`
 - `update_adsorption_singlepoint(df)`
 - `update_heat_capacity_all_tidy(df)`
-- `update_isotherm_h2(df)`
+- `update_isotherm_h2(df)` — deprecated; still works (the server stores its rows in `adsorption_isotherm`)
 - `update_mofchecker(df)`
 - `update_zeopp_metrics(df)`
 
@@ -213,6 +213,15 @@ All methods below are available on `api.v2`.
 - `build_case_pack(case_id, scenario_id=None)`
 - `list_case_packs(source=None, sink=None, region=None, study=None, include_scenarios=False, limit=100, offset=0)`
 
+### Case-study library (PrISMa_Platform sync)
+
+- `upsert_case_study_library(document, dry_run=False, max_request_bytes=2_400_000, raise_on_error=False, timeout=600)` — sends a `prisma_v2.case_study_library.bundle.v1` document, split into requests if needed; replaces the pipeline 11 ZIP upload
+- `get_case_study_library_bundle(sections=None, timeout=300)`
+- `get_case_study_bundle(case_id, timeout=120)`
+- `latest_case_study_library_sync()` — `None` before the first sync
+- `list_case_study_library_sync_runs(status=None, limit=50, git_commit=None, offset=0)`
+- `list_stale_case_study_library_records()`
+
 ### Catalog and reference data
 
 - `get_molecules(name=None, limit=500, offset=0)`
@@ -273,11 +282,15 @@ All methods below are available on `api.v2`.
 - `upsert_computation_runs(payload, timeout=None, raise_on_error=False)`
 - `get_adsorption_singlepoint(...)` / `get_adsorption_singlepoint_item(row_id)` / `upsert_adsorption_singlepoint(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
 - `get_heat_capacity(...)` / `get_heat_capacity_item(row_id)` / `upsert_heat_capacity(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
-- `get_isotherm_h2(...)` / `get_isotherm_h2_item(row_id)` / `upsert_isotherm_h2(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — H2 only
-- `get_adsorption_isotherm(structure=None, isotherm_id=None, component=None, temperature_K=None, pressure_bar=None, limit=500, offset=0, md5=None)` / `get_adsorption_isotherm_item(row_id)` / `upsert_adsorption_isotherm(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — every gas except H2; needs prisma_cloud **>= 0.6.16** (older servers return 404)
+- `get_isotherm_h2(...)` / `get_isotherm_h2_item(row_id)` / `upsert_isotherm_h2(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — deprecated; use the `adsorption_isotherm` methods with `component='H2'`
+- `get_adsorption_isotherm(structure=None, isotherm_id=None, component=None, temperature_K=None, pressure_bar=None, limit=500, offset=0, md5=None, match=None)` / `get_adsorption_isotherm_item(row_id)` / `upsert_adsorption_isotherm(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — every gas, H2 included; needs prisma_cloud **>= 0.6.16** (older servers return 404)
 - `get_mofchecker(...)` / `get_mofchecker_item(row_id)` / `upsert_mofchecker(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
 - `get_zeopp_metrics(...)` / `get_zeopp_metrics_item(row_id)` / `upsert_zeopp_metrics(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
-- `get_autoprism_collection(...)` / `upsert_autoprism_collection(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `upsert_autoprism_cifs(cifs, tags=None, create_materials=True, batch_size=50, raise_on_error=False, timeout=300)` — AutoPrism's own CIFs, stored as `{structure}__autoprism_{md5[:12]}.cif`
+- `get_autoprism_collection(...)` / `upsert_autoprism_collection(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True, cif_tags=None)`
+
+The getters take `match="exact"` for an exact (case-insensitive) name match
+instead of the default substring match.
 
 Rejected rows (HTTP 207, or 400 when nothing is stored) raise
 `PrismaUpsertError` with `raise_on_error=True`, else emit
@@ -403,3 +416,5 @@ pytest tests/ -v --cov=prisma_api --cov-report=term-missing
 - Authentication header: `X-API-Key`
 - Local development routing is selected with `prisma_api.init(local_dev=True)`; the default targets production
 - 0.4.4: the `adsorption-isotherm` endpoints and the 400/notice handling need prisma_cloud >= 0.6.16
+- 0.4.5: H2 isotherms go through `upsert_adsorption_isotherm` (prisma_cloud >= 0.6.16); the H2-only methods and the `isotherm_H2s` collection key are deprecated. New `upsert_autoprism_cifs` uses the existing bundle upsert endpoint. AutoPrism getters take `match="exact"`.
+- 0.4.6: case-study library sync methods (`upsert_case_study_library` and the export, sync-run and stale-record readers) for the prisma_cloud `case-study-library` endpoints, which replace ingest pipeline 11.

{prisma_api-0.4.4 → prisma_api-0.4.6}/README.md

@@ -145,7 +145,7 @@ The main client exposes these v1 methods:
 - `get_materials_data(payload={}, separate_experimental=True)`
 - `update_adsorption_singlepoint(df)`
 - `update_heat_capacity_all_tidy(df)`
-- `update_isotherm_h2(df)`
+- `update_isotherm_h2(df)` — deprecated; still works (the server stores its rows in `adsorption_isotherm`)
 - `update_mofchecker(df)`
 - `update_zeopp_metrics(df)`
 
@@ -193,6 +193,15 @@ All methods below are available on `api.v2`.
 - `build_case_pack(case_id, scenario_id=None)`
 - `list_case_packs(source=None, sink=None, region=None, study=None, include_scenarios=False, limit=100, offset=0)`
 
+### Case-study library (PrISMa_Platform sync)
+
+- `upsert_case_study_library(document, dry_run=False, max_request_bytes=2_400_000, raise_on_error=False, timeout=600)` — sends a `prisma_v2.case_study_library.bundle.v1` document, split into requests if needed; replaces the pipeline 11 ZIP upload
+- `get_case_study_library_bundle(sections=None, timeout=300)`
+- `get_case_study_bundle(case_id, timeout=120)`
+- `latest_case_study_library_sync()` — `None` before the first sync
+- `list_case_study_library_sync_runs(status=None, limit=50, git_commit=None, offset=0)`
+- `list_stale_case_study_library_records()`
+
 ### Catalog and reference data
 
 - `get_molecules(name=None, limit=500, offset=0)`
@@ -253,11 +262,15 @@ All methods below are available on `api.v2`.
 - `upsert_computation_runs(payload, timeout=None, raise_on_error=False)`
 - `get_adsorption_singlepoint(...)` / `get_adsorption_singlepoint_item(row_id)` / `upsert_adsorption_singlepoint(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
 - `get_heat_capacity(...)` / `get_heat_capacity_item(row_id)` / `upsert_heat_capacity(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
-- `get_isotherm_h2(...)` / `get_isotherm_h2_item(row_id)` / `upsert_isotherm_h2(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — H2 only
-- `get_adsorption_isotherm(structure=None, isotherm_id=None, component=None, temperature_K=None, pressure_bar=None, limit=500, offset=0, md5=None)` / `get_adsorption_isotherm_item(row_id)` / `upsert_adsorption_isotherm(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — every gas except H2; needs prisma_cloud **>= 0.6.16** (older servers return 404)
+- `get_isotherm_h2(...)` / `get_isotherm_h2_item(row_id)` / `upsert_isotherm_h2(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — deprecated; use the `adsorption_isotherm` methods with `component='H2'`
+- `get_adsorption_isotherm(structure=None, isotherm_id=None, component=None, temperature_K=None, pressure_bar=None, limit=500, offset=0, md5=None, match=None)` / `get_adsorption_isotherm_item(row_id)` / `upsert_adsorption_isotherm(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)` — every gas, H2 included; needs prisma_cloud **>= 0.6.16** (older servers return 404)
 - `get_mofchecker(...)` / `get_mofchecker_item(row_id)` / `upsert_mofchecker(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
 - `get_zeopp_metrics(...)` / `get_zeopp_metrics_item(row_id)` / `upsert_zeopp_metrics(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
-- `get_autoprism_collection(...)` / `upsert_autoprism_collection(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True)`
+- `upsert_autoprism_cifs(cifs, tags=None, create_materials=True, batch_size=50, raise_on_error=False, timeout=300)` — AutoPrism's own CIFs, stored as `{structure}__autoprism_{md5[:12]}.cif`
+- `get_autoprism_collection(...)` / `upsert_autoprism_collection(payload, meta_provenance=None, repo_dir=None, timeout=None, raise_on_error=False, check_ids=True, cif_tags=None)`
+
+The getters take `match="exact"` for an exact (case-insensitive) name match
+instead of the default substring match.
 
 Rejected rows (HTTP 207, or 400 when nothing is stored) raise
 `PrismaUpsertError` with `raise_on_error=True`, else emit
@@ -383,3 +396,5 @@ pytest tests/ -v --cov=prisma_api --cov-report=term-missing
 - Authentication header: `X-API-Key`
 - Local development routing is selected with `prisma_api.init(local_dev=True)`; the default targets production
 - 0.4.4: the `adsorption-isotherm` endpoints and the 400/notice handling need prisma_cloud >= 0.6.16
+- 0.4.5: H2 isotherms go through `upsert_adsorption_isotherm` (prisma_cloud >= 0.6.16); the H2-only methods and the `isotherm_H2s` collection key are deprecated. New `upsert_autoprism_cifs` uses the existing bundle upsert endpoint. AutoPrism getters take `match="exact"`.
+- 0.4.6: case-study library sync methods (`upsert_case_study_library` and the export, sync-run and stale-record readers) for the prisma_cloud `case-study-library` endpoints, which replace ingest pipeline 11.

prisma_api-0.4.6/prisma_api/__init__.py

@@ -0,0 +1,31 @@
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as _version
+
+try:
+    __version__ = _version("prisma_api")
+except PackageNotFoundError:  # running from a source tree without installing
+    __version__ = "0+unknown"
+
+
+from prisma_api.config import locate_config, update_dev_host_port, update_dev_mode
+from prisma_api.prisma_api import prisma_api as init  # main client
+from prisma_api.prisma_api_v2 import (  # v2 client (also api.v2) and upsert failure signals
+    PrismaAPIv2,
+    PrismaNewStructureWarning,
+    PrismaRowErrorWarning,
+    PrismaUnknownFieldsWarning,
+    PrismaUpsertError,
+)
+
+__all__ = [
+    "PrismaAPIv2",
+    "PrismaNewStructureWarning",
+    "PrismaRowErrorWarning",
+    "PrismaUnknownFieldsWarning",
+    "PrismaUpsertError",
+    "__version__",
+    "init",
+    "locate_config",
+    "update_dev_host_port",
+    "update_dev_mode",
+]

{prisma_api-0.4.4 → prisma_api-0.4.6}/prisma_api/config.py

@@ -1,11 +1,10 @@
 import os
 import sys
 from pathlib import Path
+
 import pandas as pd
-import yaml
 import platformdirs
-
-
+import yaml
 
 ### Helper functions for config management
 
@@ -42,7 +41,7 @@ def load_config():
     return cfg
 
 # Internal function to create config.yaml
-def create_config_file(api_key: str = None):
+def create_config_file(api_key: str | None = None):
     """
     Create config.yaml. If api_key is None, prompt via CLI.
 

{prisma_api-0.4.4 → prisma_api-0.4.6}/prisma_api/prisma_api.py

@@ -1,14 +1,15 @@
+import math
 import os
 import warnings
-from .config import get_or_create_config, update_dev_mode as _update_dev_mode
-from .prisma_api_v2 import PrismaAPIv2
-from pathlib import Path
+
+import numpy as np
 import pandas as pd
 import requests
 
-import numpy as np
-import json
-import math
+from .config import get_or_create_config
+from .config import update_dev_mode as _update_dev_mode
+from .prisma_api_v2 import PrismaAPIv2
+
 
 def _safe_nan_check(x):
     if x is None:
@@ -23,7 +24,7 @@ def _safe_nan_check(x):
   
 
 # prisma_api main class
-class prisma_api():
+class prisma_api:
 
     def __init__(self, use_config_file=True, local_dev: bool = False,
                  upload_timeout: int = 120):
@@ -91,7 +92,7 @@ class prisma_api():
         )
         return _update_dev_mode(dev)
         
-    def get_mofs(self, payload={}):
+    def get_mofs(self, payload: dict | None = None):
 
         api = self
 
@@ -105,7 +106,7 @@ class prisma_api():
             "Content-Type": "application/json"
         }
 
-        response = requests.post(url, json=payload, headers=headers, timeout=60)
+        response = requests.post(url, json=payload or {}, headers=headers, timeout=60)
         data = response.json()['data']
 
         data = pd.DataFrame.from_dict(data)
@@ -113,7 +114,7 @@ class prisma_api():
         return data
     
     
-    def get_carbon_isotherms(self, payload={}):
+    def get_carbon_isotherms(self, payload: dict | None = None):
 
         api = self
 
@@ -128,7 +129,7 @@ class prisma_api():
         }
 
         try:
-            response = requests.post(url, json=payload, headers=headers, timeout=60)
+            response = requests.post(url, json=payload or {}, headers=headers, timeout=60)
             data = response.json()['data']
 
             data = pd.DataFrame.from_dict(data)
@@ -147,11 +148,11 @@ class prisma_api():
 
             return data
         
-        except Exception as e:
+        except Exception:  # noqa: BLE001 - v1 contract: print and return empty
             print("Error retrieving carbon isotherms: check that the query parameter names are correct.")
             return pd.DataFrame()
     
-    def get_carbon_data_nested(self, payload={}, safe_names=False):
+    def get_carbon_data_nested(self, payload: dict | None = None, safe_names=False):
         """
         Get carbon data with nested structure, returned as separate DataFrames.
 
@@ -180,7 +181,7 @@ class prisma_api():
         }
 
         try:
-            response = requests.post(url, json=payload, headers=headers, timeout=60)
+            response = requests.post(url, json=payload or {}, headers=headers, timeout=60)
             data = response.json()
 
             col_names_carbon = data.get('meta', {}).get('original_column_names', {})
@@ -234,11 +235,11 @@ class prisma_api():
                 }
             }
 
-        except Exception as e:
+        except Exception as e:  # noqa: BLE001 - v1 contract: print and return empty
             print(f"Error retrieving carbon data nested: {e}")
             return {}
     
-    def get_materials_data(self, payload={}, separate_experimental=True):
+    def get_materials_data(self, payload: dict | None = None, separate_experimental=True):
         """
         Args:
             payload:                 Dictionary containing query parameters for filtering.
@@ -279,12 +280,12 @@ class prisma_api():
             source_key = None
             for name, endpoint in urls.items():
                 try:
-                    response = requests.post(endpoint, json=payload, headers=headers, timeout=60)
+                    response = requests.post(endpoint, json=payload or {}, headers=headers, timeout=60)
                     data_raw = response.json()
                     if data_raw.get('data'):
                         source_key = name
                         break
-                except Exception:
+                except Exception:  # noqa: BLE001, S112 - endpoint fallback: try the next one
                     continue
             
             if data_raw is None:
@@ -406,7 +407,7 @@ class prisma_api():
                     'meta': {'source': source_key},
                 }
 
-        except Exception as e:
+        except Exception as e:  # noqa: BLE001 - v1 contract: print and return empty
             print(f"Error retrieving materials data: {e}")
             return {}
     
@@ -446,8 +447,6 @@ class prisma_api():
         if df.empty:
             return "[]"
         
-        import numpy as np
-        import json
         
         # Use pandas to_json which handles NaN properly, then parse back
         df_clean = df.copy()