simudyne-pulse 0.7.0.dev18__tar.gz → 0.7.0.dev19__tar.gz

{simudyne_pulse-0.7.0.dev18/src/simudyne_pulse.egg-info → simudyne_pulse-0.7.0.dev19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev18
+Version: 0.7.0.dev19
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/pyproject.toml

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

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/src/simudyne/resources/api_keys.py

@@ -44,6 +44,11 @@ class ApiKeysResource:
         PulseAPIError
             If the account has reached its key limit, or ``name`` is rejected.
 
+        See Also
+        --------
+        list : Every active key on the account.
+        revoke : Deactivate a key.
+
         Examples
         --------
         >>> new_key = client.api_keys.create(name="Training script")
@@ -76,6 +81,11 @@ class ApiKeysResource:
         PulseAPIError
             If the calling key is invalid or has been revoked.
 
+        See Also
+        --------
+        create : Issue a new key.
+        revoke : Deactivate a key.
+
         Examples
         --------
         >>> for key in client.api_keys.list():
@@ -104,6 +114,11 @@ class ApiKeysResource:
         PulseAPIError
             If ``key_id`` does not exist or does not belong to your account.
 
+        See Also
+        --------
+        list : Find the key id to revoke.
+        create : Issue a replacement key.
+
         Examples
         --------
         >>> new_key = client.api_keys.create(name="Training script")

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/src/simudyne/resources/data.py

@@ -306,6 +306,12 @@ class DataResource:
             If the key is not demo tier (403), or there is no raw market data
             for the symbol on ``cal_date`` (400).
 
+        See Also
+        --------
+        available_data : Days that exist and could be calibrated.
+        calibrated_data : Days already calibrated, where this one lands.
+        simudyne.resources.simulation.SimulationResource.run : Simulate a calibrated day.
+
         Notes
         -----
         Calibration is only needed for a symbol-day that is not already

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/src/simudyne/resources/fix.py

@@ -58,6 +58,10 @@ class FixResource:
             If ``user_id`` is given without an admin key, or names an account
             that does not exist.
 
+        See Also
+        --------
+        simudyne.resources.fm.FmResource.live : Start a live FIX-compatible stream.
+
         Examples
         --------
         >>> usage = client.fix.usage()

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/src/simudyne/resources/fm.py

@@ -82,6 +82,12 @@ class FmResource:
         PulseAPIError
             If the key is not pro tier — status 403.
 
+        See Also
+        --------
+        simudyne.resources.data.DataResource.available_data : Days a model will accept, via model_id.
+        simudyne.resources.simulation.SimulationResource.run : Run a model with engine="fm".
+        live : Stream a model live instead of in batch.
+
         Examples
         --------
         >>> for m in client.fm.models()["models"]:
@@ -132,6 +138,11 @@ class FmResource:
             If ``model_id`` is unknown (404), ``model_args`` holds an unknown
             or out-of-range key (400), or the key is not pro tier (403).
 
+        See Also
+        --------
+        models : Models and what each accepts.
+        simudyne.resources.fix.FixResource.usage : What a FIX session has run.
+
         Examples
         --------
         >>> session = client.fm.live(model_id="tradefm-hkex", horizon=5000)

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/src/simudyne/resources/profile.py

@@ -48,6 +48,12 @@ class ProfileResource:
         PulseAPIError
             If the key is invalid, revoked or expired — status 401.
 
+        See Also
+        --------
+        usage : Requests this month, by endpoint.
+        downloads : The download quota and what it has been spent on.
+        simudyne.resources.api_keys.ApiKeysResource.list : The account's API keys.
+
         Examples
         --------
         >>> me = client.profile.get()
@@ -86,6 +92,11 @@ class ProfileResource:
         PulseAPIError
             If the key is invalid, revoked or expired — status 401.
 
+        See Also
+        --------
+        get : The account itself.
+        downloads : The download quota.
+
         Examples
         --------
         >>> usage = client.profile.usage()
@@ -125,6 +136,12 @@ class ProfileResource:
             downloaded_group_details : list of dict or None
                 The same groups, each with a ``downloaded_at`` timestamp.
 
+        See Also
+        --------
+        usage : Requests this month, by endpoint.
+        simudyne.resources.simulation.SimulationResource.get_bulk_data : Download many runs at once.
+        simudyne.resources.simulation.SimulationResource.get_sim_data : Download one run's files.
+
         Notes
         -----
         A request that would exceed the allowance returns HTTP 429 without

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/src/simudyne/resources/simulation.py

@@ -415,6 +415,11 @@ class SimulationResource:
         PulseAPIError
             If the key is not pro tier (403), or ``limit`` is above 500 (400).
 
+        See Also
+        --------
+        get_job_status : Poll one job.
+        get_job_results : Read one job's results.
+
         Examples
         --------
         >>> result = client.simulation.get_jobs()
@@ -464,6 +469,12 @@ class SimulationResource:
             If ``job_id`` is unknown or belongs to another account (404), or
             the key is not pro tier (403).
 
+        See Also
+        --------
+        run : Submit a job.
+        get_job_results : Read results once the job completes.
+        get_job_logs : The run log, for a job that failed.
+
         Notes
         -----
         ``is_complete`` and ``has_errors`` are independent: a job where some
@@ -663,6 +674,10 @@ class SimulationResource:
             404 when the job does not exist, is not yours, or
             wrote no log.
 
+        See Also
+        --------
+        get_job_status : Where the job has got to.
+
         Examples
         --------
         >>> status = client.simulation.get_job_status(job_id)
@@ -731,6 +746,12 @@ class SimulationResource:
             ``strategy`` is not "vwap" or "twap", or the symbol has no
             calibration for ``cal_date`` (400).
 
+        See Also
+        --------
+        run : A single run, with any execution algos.
+        get_job_status : Poll the submitted job.
+        get_job_results : Read per-size results once complete.
+
         Notes
         -----
         ``order_sizes`` is in **lots**, not shares — unlike ``order_size`` on
@@ -814,6 +835,12 @@ class SimulationResource:
             If ``sim_id`` is unknown or belongs to another account — status
             404.
 
+        See Also
+        --------
+        get_sim_data : Download one of the listed files.
+        get_sim_params : The parameters the run used.
+        get_sim_metrics : The run's summary metrics.
+
         Examples
         --------
         >>> files = client.simulation.list_sim_files(sim_id)
@@ -853,6 +880,11 @@ class SimulationResource:
             If ``sim_id`` is unknown or belongs to another account — status
             404.
 
+        See Also
+        --------
+        get_sim_metrics : The run's summary metrics.
+        list_sim_files : Every file the run produced.
+
         Examples
         --------
         >>> params = client.simulation.get_sim_params(sim_id)
@@ -887,6 +919,11 @@ class SimulationResource:
             If ``sim_id`` is unknown, belongs to another account, or the
             simulation has not finished and so wrote no metrics — status 404.
 
+        See Also
+        --------
+        get_sim_params : The parameters the run used.
+        list_sim_files : Every file the run produced.
+
         Examples
         --------
         >>> metrics = client.simulation.get_sim_metrics(sim_id)
@@ -1014,6 +1051,11 @@ class SimulationResource:
         PulseAPIError
             If the key is invalid, revoked or expired — status 401.
 
+        See Also
+        --------
+        get_sim_data : Download a cached run's files.
+        get_sample_data : A small sample without spending download quota.
+
         Notes
         -----
         Available on every tier, and the way onto the platform without running
@@ -1082,6 +1124,11 @@ class SimulationResource:
             If no sample dataset has been published for this deployment — status
             404.
 
+        See Also
+        --------
+        list_cached : The cached library the sample comes from.
+        get_sim_data : The full files for one run.
+
         Notes
         -----
         Available on every tier and charged against nothing, so it is the

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/src/simudyne/resources/simulator_gym.py

@@ -69,6 +69,11 @@ class GymSession:
             ``RuntimeError`` rather than ``PulseAPIError`` — it speaks
             WebSocket, not HTTP.
 
+        See Also
+        --------
+        GymSession.step : Advance the episode.
+        GymSession.close : End the session.
+
         Examples
         --------
         >>> obs = env.reset(seed=42)
@@ -111,6 +116,11 @@ class GymSession:
             error. Note this resource raises ``RuntimeError`` rather than
             ``PulseAPIError`` — it speaks WebSocket, not HTTP.
 
+        See Also
+        --------
+        GymSession.reset : Start a new episode.
+        GymSession.close : End the session.
+
         Examples
         --------
         >>> result = env.step(0)
@@ -141,6 +151,10 @@ class GymSession:
 
         Called automatically when the session is used as a context manager.
 
+        See Also
+        --------
+        SimulatorGymResource.connect : Open a new session.
+
         Examples
         --------
         >>> env = client.simulator_gym.connect(
@@ -220,6 +234,12 @@ class SimulatorGymResource:
             often. This resource raises ``RuntimeError`` rather than
             ``PulseAPIError`` because it speaks WebSocket, not HTTP.
 
+        See Also
+        --------
+        GymSession.reset : Start an episode on the session.
+        GymSession.step : Advance it.
+        GymSession.close : End it.
+
         Notes
         -----
         ``exchange`` takes its display form here — ``"HKEX.Securities"`` — not

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19}/src/simudyne/resources/validation.py

@@ -368,6 +368,12 @@ class ValidationResource:
             ``sim_id`` is unknown, or the tier does not allow a requested
             area.
 
+        See Also
+        --------
+        get_job_status : Poll the job without fetching its result.
+        get_job : The result once the job completes.
+        list_jobs : Earlier validation jobs.
+
         Examples
         --------
         Platform simulations against the real day:
@@ -534,6 +540,11 @@ class ValidationResource:
             If ``job_id`` is unknown or belongs to another account — status
             404.
 
+        See Also
+        --------
+        run : Submit a validation job.
+        get_job_status : Poll without fetching the result.
+
         Examples
         --------
         >>> result = client.validation.get_job(job_id)
@@ -586,6 +597,11 @@ class ValidationResource:
         PulseAPIError
             If the job does not exist or belongs to another key — status 404.
 
+        See Also
+        --------
+        get_job : The result once the job completes.
+        run : Submit a validation job.
+
         Examples
         --------
         >>> import time
@@ -618,6 +634,11 @@ class ValidationResource:
         PulseAPIError
             If the key is invalid, revoked or expired — status 401.
 
+        See Also
+        --------
+        get_job : One job's result.
+        run : Submit a validation job.
+
         Examples
         --------
         >>> listing = client.validation.list_jobs(limit=10)

{simudyne_pulse-0.7.0.dev18 → simudyne_pulse-0.7.0.dev19/src/simudyne_pulse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simudyne-pulse
-Version: 0.7.0.dev18
+Version: 0.7.0.dev19
 Summary: Python SDK for the Simudyne Pulse synthetic market data API
 Author-email: Simudyne <support@simudyne.com>
 License-Expression: MIT