simudyne-pulse 0.6.0.dev2__tar.gz → 0.7.0__tar.gz

{simudyne_pulse-0.6.0.dev2/src/simudyne_pulse.egg-info → simudyne_pulse-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.6.0.dev2
+Version: 0.7.0
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT
@@ -57,7 +57,7 @@ pip install --pre simudyne-pulse
 ```
 
 Only use dev builds for testing unreleased changes; they are not guaranteed
-stable. Merge `dev` into `main` to promote those changes to a stable release.
+stable. Merge `dev` into `prod` to promote those changes to a stable release.
 
 ## Quick start
 

{simudyne_pulse-0.6.0.dev2 → simudyne_pulse-0.7.0}/README.md

@@ -31,7 +31,7 @@ pip install --pre simudyne-pulse
 ```
 
 Only use dev builds for testing unreleased changes; they are not guaranteed
-stable. Merge `dev` into `main` to promote those changes to a stable release.
+stable. Merge `dev` into `prod` to promote those changes to a stable release.
 
 ## Quick start
 

{simudyne_pulse-0.6.0.dev2 → simudyne_pulse-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simudyne-pulse"
-version = "0.6.0-dev.2"
+version = "0.7.0"
 description = "Python SDK for the Simudyne Pulse synthetic market data API"
 readme = "README.md"
 license = "MIT"
@@ -50,11 +50,11 @@ version_toml = ["pyproject.toml:project.version"]
 changelog_file = "CHANGELOG.md"
 build_command = "pip install build && python -m build"
 
-# Release channels. `main` cuts stable versions (0.6.0); `dev` cuts
+# Release channels. `prod` cuts stable versions (0.6.0); `dev` cuts
 # prereleases (0.6.0-dev.1). Prerelease tags never collide with stable ones,
 # and `pip install git+...@dev` is how you pull a dev build.
-[tool.semantic_release.branches.main]
-match = "main"
+[tool.semantic_release.branches.prod]
+match = "prod"
 prerelease = false
 
 [tool.semantic_release.branches.dev]

{simudyne_pulse-0.6.0.dev2 → simudyne_pulse-0.7.0}/src/simudyne/resources/simulation.py

@@ -32,18 +32,25 @@ SCENARIOS = {
     "trending_down": "Small steady SELL flow producing a persistent downtrend",
 }
 
-# Scenario parameter defaults
+# Scenario parameter defaults.
+#
+# MUST mirror the builder signatures in the engine's EIB/calcs/scenarios.py —
+# SimulationRun backfills any omitted key from those defaults via
+# inspect.signature, so a stale copy here misreports what a run will actually
+# do. flash_crash/buy_panic drifted once already (22.0/0.19/500ms lingered here
+# after the engine moved to 150.0/0.02/100ms), so re-check both when either side
+# changes.
 SCENARIO_DEFAULTS = {
     "flash_crash": {
-        "impact_multiplier": 22.0,
-        "order_size_ratio": 0.19,
-        "order_freq": "500ms",
+        "impact_multiplier": 150.0,
+        "order_size_ratio": 0.02,
+        "order_freq": "100ms",
         "start_time": "10:30:00",
     },
     "buy_panic": {
-        "impact_multiplier": 22.0,
-        "order_size_ratio": 0.19,
-        "order_freq": "500ms",
+        "impact_multiplier": 150.0,
+        "order_size_ratio": 0.02,
+        "order_freq": "100ms",
         "start_time": "10:30:00",
     },
     "gradual_selloff": {
@@ -397,7 +404,7 @@ class SimulationResource:
         Example:
             >>> defaults = client.simulation.get_scenario_defaults("flash_crash")
             >>> print(defaults)
-            {'impact_multiplier': 22.0, 'order_size_ratio': 0.19, ...}
+            {'impact_multiplier': 150.0, 'order_size_ratio': 0.02, ...}
         """
         return SCENARIO_DEFAULTS.get(scenario, {}).copy()
 

{simudyne_pulse-0.6.0.dev2 → simudyne_pulse-0.7.0}/src/simudyne/resources/validation.py

@@ -30,9 +30,10 @@ class ValidationResource:
         date: str,
         sim_ids: list[str],
         ticksize: float = 1.0,
-        run_metrics: bool = True,
-        run_impact: bool = False,
-        run_fid: bool = False,
+        run_metrics: bool | None = None,
+        run_impact: bool | None = None,
+        run_fid: bool | None = None,
+        run_stylised_facts: bool | None = None,
         n_levels: int = 10,
         rescale_volumes: bool = True,
         lot_size: int = 1,
@@ -51,9 +52,15 @@ class ValidationResource:
             date: Calibration date in YYYY-MM-DD format (e.g. "2025-09-01")
             sim_ids: List of simulation IDs to validate (max 25)
             ticksize: Tick size for the symbol
-            run_metrics: Compute L1/Wasserstein distributional distances
-            run_impact: Compute impact response curves
-            run_fid: Compute Frechet Inception Distance
+            run_metrics: Compute L1/Wasserstein distributional distances.
+                Leave unset to use your tier's default.
+            run_impact: Compute impact response curves. Leave unset to use your
+                tier's default.
+            run_fid: Compute Frechet Inception Distance. Leave unset to use your
+                tier's default.
+            run_stylised_facts: Compute stylised facts (autocorrelation, heavy
+                tails, volatility clustering). Leave unset to use your tier's
+                default.
             n_levels: Number of L2 book levels to use
             rescale_volumes: Multiply simulated L2 size columns by lot_size
             lot_size: Lot size multiplier for volume rescaling
@@ -61,19 +68,30 @@ class ValidationResource:
         Returns:
             dict with job_id, status, message
         """
+        # A run_* flag left unset is omitted so the API applies your tier's
+        # default rather than an SDK-side one. Sending False for the optional
+        # passes would silently opt demo accounts out of the extra results that
+        # tier is meant to return by default.
+        config = {
+            "n_levels": n_levels,
+            "rescale_volumes": rescale_volumes,
+            "lot_size": lot_size,
+        }
+        for flag, value in (
+            ("run_metrics", run_metrics),
+            ("run_impact", run_impact),
+            ("run_fid", run_fid),
+            ("run_stylised_facts", run_stylised_facts),
+        ):
+            if value is not None:
+                config[flag] = value
+
         payload = {
             "symbol": symbol,
             "date": date,
             "sim_ids": sim_ids,
             "ticksize": ticksize,
-            "config": {
-                "run_metrics": run_metrics,
-                "run_impact": run_impact,
-                "run_fid": run_fid,
-                "n_levels": n_levels,
-                "rescale_volumes": rescale_volumes,
-                "lot_size": lot_size,
-            },
+            "config": config,
         }
         return self._client._request("POST", RUN_PATH, json=payload)
 
@@ -87,10 +105,17 @@ class ValidationResource:
             dict with:
             - status: "pending", "running", "completed", or "failed"
             - distances: dict of {metric: {l1: [...], w: [...]}} (when completed)
-            - fid_scores: list of floats (when completed and run_fid=True)
-            - plots: list of {name, content_base64} (when completed)
-            - metadata: dict with run parameters
+            - metadata: dict with run parameters, including which passes ran
             - error: error message (when failed)
+
+            Demo-tier accounts additionally receive the numbers derived from the
+            historical data, which are withheld at the pro tier:
+
+            - distributions: per-metric historical vs simulated histograms
+            - impact_response: impact response curves as numbers, historical and
+              one block per sim run
+            - stylised_facts: historical and one block per sim run
+            - fid_scores: one score per sim run (None where not computable)
         """
         return self._client._request("GET", f"{JOBS_PATH}/{job_id}")
 
@@ -111,9 +136,10 @@ class ValidationResource:
         date: str,
         sim_ids: list[str],
         ticksize: float = 1.0,
-        run_metrics: bool = True,
-        run_impact: bool = False,
-        run_fid: bool = False,
+        run_metrics: bool | None = None,
+        run_impact: bool | None = None,
+        run_fid: bool | None = None,
+        run_stylised_facts: bool | None = None,
         n_levels: int = 10,
         rescale_volumes: bool = True,
         lot_size: int = 1,
@@ -130,9 +156,15 @@ class ValidationResource:
             date: Calibration date in YYYY-MM-DD format
             sim_ids: List of simulation IDs to validate (max 25)
             ticksize: Tick size for the symbol
-            run_metrics: Compute L1/Wasserstein distributional distances
-            run_impact: Compute impact response curves
-            run_fid: Compute Frechet Inception Distance
+            run_metrics: Compute L1/Wasserstein distributional distances.
+                Leave unset to use your tier's default.
+            run_impact: Compute impact response curves. Leave unset to use your
+                tier's default.
+            run_fid: Compute Frechet Inception Distance. Leave unset to use your
+                tier's default.
+            run_stylised_facts: Compute stylised facts (autocorrelation, heavy
+                tails, volatility clustering). Leave unset to use your tier's
+                default.
             n_levels: Number of L2 book levels to use
             rescale_volumes: Multiply simulated L2 size columns by lot_size
             lot_size: Lot size multiplier for volume rescaling
@@ -156,6 +188,7 @@ class ValidationResource:
             run_metrics=run_metrics,
             run_impact=run_impact,
             run_fid=run_fid,
+            run_stylised_facts=run_stylised_facts,
             n_levels=n_levels,
             rescale_volumes=rescale_volumes,
             lot_size=lot_size,

{simudyne_pulse-0.6.0.dev2 → simudyne_pulse-0.7.0/src/simudyne_pulse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.6.0.dev2
+Version: 0.7.0
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT
@@ -57,7 +57,7 @@ pip install --pre simudyne-pulse
 ```
 
 Only use dev builds for testing unreleased changes; they are not guaranteed
-stable. Merge `dev` into `main` to promote those changes to a stable release.
+stable. Merge `dev` into `prod` to promote those changes to a stable release.
 
 ## Quick start