simudyne-pulse 0.7.0.dev10__tar.gz → 0.7.0.dev11__tar.gz

{simudyne_pulse-0.7.0.dev10 → simudyne_pulse-0.7.0.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev10
+Version: 0.7.0.dev11
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT
@@ -85,8 +85,26 @@ population. `sim_files` groups the same way.
 A plain list is one unnamed population and keeps the flat shape exactly as
 before. The historical day is measured once however many groups there are.
 
-`plot_all=True` draws everything the enabled areas can draw, not just the
-summaries.
+`plots` is the only plot switch: unset draws nothing, `True` draws every
+figure the enabled areas can draw, and a list draws just those ids. An area
+switched off draws nothing either way.
+
+| id | figure |
+| --- | --- |
+| `statistical.radar` | distance spider, one polygon per population |
+| `statistical.distribution` | every metric's KDE |
+| `statistical.distribution.{metric}` | one metric, e.g. `.spread` |
+| `stylised_facts.overall` | the verdict table |
+| `stylised_facts.fact` | every fact |
+| `stylised_facts.fact.{name}` | one fact, e.g. `.heavy_tails` |
+| `impact.response` | impact response by event type |
+| `impact.event.{type}` | one event type |
+| `volume_correlation.levels` | level correlation heatmap |
+| `volume_correlation.changes` | change correlation heatmap |
+| `volume_correlation.overall` | both of the above |
+
+Each returned figure carries the `id` it was asked for — match on that, not on
+the filename.
 
 ### Working from a checkout
 

{simudyne_pulse-0.7.0.dev10 → simudyne_pulse-0.7.0.dev11}/README.md

@@ -59,8 +59,26 @@ population. `sim_files` groups the same way.
 A plain list is one unnamed population and keeps the flat shape exactly as
 before. The historical day is measured once however many groups there are.
 
-`plot_all=True` draws everything the enabled areas can draw, not just the
-summaries.
+`plots` is the only plot switch: unset draws nothing, `True` draws every
+figure the enabled areas can draw, and a list draws just those ids. An area
+switched off draws nothing either way.
+
+| id | figure |
+| --- | --- |
+| `statistical.radar` | distance spider, one polygon per population |
+| `statistical.distribution` | every metric's KDE |
+| `statistical.distribution.{metric}` | one metric, e.g. `.spread` |
+| `stylised_facts.overall` | the verdict table |
+| `stylised_facts.fact` | every fact |
+| `stylised_facts.fact.{name}` | one fact, e.g. `.heavy_tails` |
+| `impact.response` | impact response by event type |
+| `impact.event.{type}` | one event type |
+| `volume_correlation.levels` | level correlation heatmap |
+| `volume_correlation.changes` | change correlation heatmap |
+| `volume_correlation.overall` | both of the above |
+
+Each returned figure carries the `id` it was asked for — match on that, not on
+the filename.
 
 ### Working from a checkout
 

{simudyne_pulse-0.7.0.dev10 → simudyne_pulse-0.7.0.dev11}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simudyne-pulse"
-version = "0.7.0-dev.10"
+version = "0.7.0-dev.11"
 description = "Python SDK for the Simudyne Pulse synthetic market data API"
 readme = "README.md"
 license = "MIT"

{simudyne_pulse-0.7.0.dev10 → simudyne_pulse-0.7.0.dev11}/src/simudyne/resources/validation.py

@@ -64,8 +64,7 @@ _AREA_FLAGS = (
 #: needing the message stream; ``sample_period`` and ``match_generated_sample``
 #: set the grid the book is resampled onto; ``plots`` is False, True, or a list
 #: of plot ids.
-_EXTRA_FIELDS = ("lob", "sample_period", "match_generated_sample", "plots",
-                 "plot_all")
+_EXTRA_FIELDS = ("lob", "sample_period", "match_generated_sample", "plots")
 
 
 def _frame_to_parquet(entry, index: int):
@@ -173,7 +172,6 @@ class ValidationResource:
         match_generated_sample=None,
         n_levels: int = 10,
         plots=None,
-        plot_all: bool = False,
     ) -> dict:
         """Submit a validation job.
 
@@ -224,13 +222,22 @@ class ValidationResource:
         n_levels : int, default 10
             Book levels to measure over.
         plots : bool or list of str, optional
-            ``None`` or ``False`` for none, ``True`` for every figure, or plot
-            ids such as ``["statistical.radar", "stylised_facts.overall"]``.
-            Rendered server-side; :meth:`get_job` writes them to disk.
-        plot_all : bool, default False
-            Draw everything the enabled areas can draw — every distribution and
-            every stylised fact, not just the summaries. An area switched off
-            still draws nothing, so this means "all of what ran".
+            ``None`` or ``False`` draws nothing, ``True`` draws every figure
+            the enabled areas can draw, and a list draws just those ids.
+            An area switched off draws nothing either way. Rendered
+            server-side; :meth:`get_job` writes them to disk. The ids are
+
+            - ``statistical.radar`` — the distance spider, one polygon per
+              population
+            - ``statistical.distribution`` — every metric's KDE;
+              ``statistical.distribution.{metric}`` for one, e.g. ``.spread``
+            - ``stylised_facts.overall`` — the verdict table
+            - ``stylised_facts.fact`` — every fact;
+              ``stylised_facts.fact.{name}`` for one, e.g. ``.heavy_tails``
+            - ``impact.response`` — impact response by event type;
+              ``impact.event.{type}`` for one
+            - ``volume_correlation.levels``, ``volume_correlation.changes``,
+              or ``volume_correlation.overall`` for both
 
         Returns
         -------
@@ -274,7 +281,6 @@ class ValidationResource:
             sample_period=sample_period,
             match_generated_sample=match_generated_sample,
             plots=plots,
-            plot_all=plot_all or None,
         )
 
         if sim_ids is not None:

{simudyne_pulse-0.7.0.dev10 → simudyne_pulse-0.7.0.dev11}/src/simudyne_pulse.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev10
+Version: 0.7.0.dev11
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT
@@ -85,8 +85,26 @@ population. `sim_files` groups the same way.
 A plain list is one unnamed population and keeps the flat shape exactly as
 before. The historical day is measured once however many groups there are.
 
-`plot_all=True` draws everything the enabled areas can draw, not just the
-summaries.
+`plots` is the only plot switch: unset draws nothing, `True` draws every
+figure the enabled areas can draw, and a list draws just those ids. An area
+switched off draws nothing either way.
+
+| id | figure |
+| --- | --- |
+| `statistical.radar` | distance spider, one polygon per population |
+| `statistical.distribution` | every metric's KDE |
+| `statistical.distribution.{metric}` | one metric, e.g. `.spread` |
+| `stylised_facts.overall` | the verdict table |
+| `stylised_facts.fact` | every fact |
+| `stylised_facts.fact.{name}` | one fact, e.g. `.heavy_tails` |
+| `impact.response` | impact response by event type |
+| `impact.event.{type}` | one event type |
+| `volume_correlation.levels` | level correlation heatmap |
+| `volume_correlation.changes` | change correlation heatmap |
+| `volume_correlation.overall` | both of the above |
+
+Each returned figure carries the `id` it was asked for — match on that, not on
+the filename.
 
 ### Working from a checkout
 

{simudyne_pulse-0.7.0.dev10 → simudyne_pulse-0.7.0.dev11}/tests/test_validation.py

@@ -275,11 +275,17 @@ class TestNamedPopulations:
         assert "sim_groups" not in json.loads(client.calls[0][2]["data"]["config"])
 
 
-class TestPlotAll:
-    def test_it_is_forwarded(self):
-        client, _ = _run([{"job_id": "v1"}], plot_all=True)
-        assert client.calls[0][2]["json"]["config"]["plot_all"] is True
+class TestPlotEverything:
+    """plots says it all: there is no second way to ask for every figure."""
 
-    def test_it_is_omitted_when_not_asked_for(self):
+    def test_true_is_forwarded(self):
+        client, _ = _run([{"job_id": "v1"}], plots=True)
+        assert client.calls[0][2]["json"]["config"]["plots"] is True
+
+    def test_nothing_is_sent_when_not_asked_for(self):
         client, _ = _run([{"job_id": "v1"}])
-        assert "plot_all" not in client.calls[0][2]["json"]["config"]
+        assert "plots" not in client.calls[0][2]["json"]["config"]
+
+    def test_plot_all_is_gone(self):
+        with pytest.raises(TypeError):
+            _run([{"job_id": "v1"}], plot_all=True)