waveium 0.2.4__tar.gz → 0.4.0__tar.gz

{waveium-0.2.4 → waveium-0.4.0}/.gitignore

@@ -3,6 +3,9 @@
 .DS_Store
 Thumbs.db
 
+# Claude Code local settings (absolute paths, permissions, local state)
+.claude/
+
 
 # ### Matlab
 # Windows default autosave extension

waveium-0.4.0/CHANGELOG.md

@@ -0,0 +1,109 @@
+# Changelog
+
+All notable changes to the Waveium Python SDK are documented here. The
+format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
+and the project adheres to [Semantic Versioning](https://semver.org/).
+
+## [0.4.0] - 2026-07-08
+
+Aligns the SDK with Waveium API contract `0.2.1`. Restores compatibility
+for the endpoints that broke between contracts `0.1.0` and `0.2.1`. New
+`0.2.1` capabilities (token scopes, `expand`, access-requests, etc.) are
+not yet surfaced and are planned for a later release.
+
+### Breaking
+
+- **`projects.update_member` and `projects.remove_member` now require a
+  `member_type` argument** (`"user"` or `"team"`), passed as a query
+  parameter. The API made `member_type` mandatory on both endpoints; calls
+  without it returned `422`. New signatures:
+  `update_member(project_id, member_type, member_id, role)` and
+  `remove_member(project_id, member_type, member_id)`.
+- **`environments.get` replaced its `sync` parameter with `expand`.** The
+  API removed the `sync` query parameter (it was silently ignored) and added
+  `expand` for inlining related resources (e.g. `scenes`, `creator`). Callers
+  passing `sync=` must remove it.
+- **`SceneParameters.trajectory_file_id` removed.** The contract dropped the
+  deprecated singular field; use `trajectory_file_ids` (list) instead. A
+  value set on the old field was silently discarded by the server.
+- **`SceneResponse.reused` removed.** The contract no longer returns this
+  field for scenes (it was reporting `False` for every scene). Scene reuse is
+  now conveyed by the server via `similar_scenes` (not yet surfaced by the
+  SDK). `EnvironmentResponse.reused` is unaffected and remains.
+
+### Changed
+
+- **`teams.list()` response items are now `TeamListItem`** instead of the
+  full `TeamResponse`. The list projection omits `organization_id` (and
+  `created_by_user_id`/`updated_at`); parsing full `TeamResponse` items raised
+  `ValidationError`. `teams.get()` still returns a full `TeamResponse`. New
+  `TeamListItem` model exported from `waveium.models`.
+- **Shares-list responses no longer carry `limit`/`offset`.**
+  `PaginatedShareResponse` now matches the API's `ShareListResponse`
+  (`resource_type`, `resource_id`, `shares`, `total`); the previous required
+  `limit`/`offset` fields caused every `list_shares()` call to raise
+  `ValidationError`. The `limit`/`offset` arguments on `list_shares()` remain
+  for source compatibility but are ignored by the server.
+
+## [0.3.0] - 2026-04-29
+
+Aligns the SDK with Waveium API contract `0.1.0`
+(see `waveium-api/docs/api/changelog.md`).
+
+### Breaking
+
+- **Delete methods return `None`.** Every `*.delete()`, `*.revoke_*()`,
+  and `*.remove_*()` method now returns `None` instead of a
+  `MessageResponse`. The API switched to `204 No Content` with empty
+  bodies, so the previous return type was no longer parseable. Code
+  that read `.message` off a delete result must be updated.
+- **`scenes.find_similar` signature changed.** Was
+  `find_similar(environment_id, parameters: SceneParameters | dict)`.
+  Now `find_similar(environment_id, stations: Sequence[str] | None,
+  trajectory_file_ids: Sequence[str] | None)`. The server now matches
+  by station-name set and trajectory-file-id set within an
+  environment; coordinate-level matching has been removed. Names
+  containing commas raise `ValueError`.
+
+### Added
+
+- `PreconditionFailedError` exception, raised on HTTP `412`. The
+  current ETag is exposed via `err.details["current_etag"]`.
+- `ProblemDetails` model in `waveium.models` for RFC 7807 error
+  bodies (`application/problem+json`).
+- Optional `idempotency_key` parameter on the seven endpoints the
+  API supports retry-safe replay for: `scenes.generate`,
+  `scenes.create_execution`, `scenes.complete_upload`,
+  `scenes.upload`, `environments.complete_upload`,
+  `environments.upload`, `executions.retry`,
+  `executions.submit_post_processing`,
+  `antenna_patterns.complete_upload`, `antenna_patterns.upload`
+  (sync and async).
+- Optional `if_match` parameter on `scenes.update`, `scenes.patch`,
+  and `environments.update` for optimistic concurrency. The `_etag`
+  private attribute on `SceneResponse` and `EnvironmentResponse` is
+  populated from the `ETag` response header on `get`/`update`/`patch`.
+- `Accept: application/json, application/problem+json` header on
+  every outgoing request.
+
+### Changed
+
+- Error parsing now consumes RFC 7807 problem+json bodies.
+  `WaveiumError.code` reads the `code` extension; the rest of the
+  problem body (including `errors`, `invalid_fields`, `current_etag`)
+  flows through as `details`.
+- HTTP `422` now maps to `ValidationError` (previously fell through
+  to `APIError`).
+- `update_me`, `update`, and partial-update calls on users,
+  organizations, teams, projects, environments, and executions now
+  use `PATCH` instead of `PUT` (transparent to callers).
+- Batch-download calls now use `GET` instead of `POST`
+  (transparent to callers): `_file_ops.download_batch`,
+  `executions.download_post_processing_batch`.
+- `204 No Content` responses short-circuit to `None` regardless of
+  the requested response model.
+
+### Removed
+
+- `ErrorDetail`, `ErrorResponse` from `waveium.models`. Replaced by
+  `ProblemDetails`. Direct importers must update.

waveium-0.4.0/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: waveium
+Version: 0.4.0
+Summary: Official Python SDK for the Waveium API
+Project-URL: Homepage, https://waveium.io
+Project-URL: Documentation, https://docs.waveium.io
+Project-URL: Repository, https://github.com/waveium/waveium-sdk
+Author: Waveium Team
+License: MIT
+License-File: LICENSE
+Keywords: api,environment,execution,rf-simulation,scene,sdk,waveium
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: anyio>=4.0.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: typing-extensions>=4.9.0
+Provides-Extra: dev
+Requires-Dist: black>=24.0.0; extra == 'dev'
+Requires-Dist: flake8>=7.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Provides-Extra: parquet
+Requires-Dist: pandas>=2.0.0; extra == 'parquet'
+Requires-Dist: pyarrow>=14.0.0; extra == 'parquet'
+Description-Content-Type: text/markdown
+
+# Waveium Python SDK
+
+Official Python client library for the [Waveium API](https://waveium.io).
+Build and run RF propagation simulations on top of a real environment
+model, stream progress via Server-Sent Events, and read the parquet
+results straight into a pandas DataFrame.
+
+**New here?** Start with the step-by-step walkthrough at
+[`docs/getting_started.md`](docs/getting_started.md).
+
+## Features
+
+- Full coverage of the **Environment -> Scene -> Execution** workflow.
+- Synchronous (`waveium.Client`) and asynchronous
+  (`waveium.AsyncClient`) clients.
+- Built-in SSE progress streaming with blocking `wait()` helpers and
+  a `create_and_run()` convenience for the common case.
+- `read_parquet()` streams result files straight into pandas without
+  writing to disk; `structured=True` merges xyz triplets and complex
+  re/im pairs for immediate analysis.
+- Pydantic v2 models throughout for type safety.
+- `.env` auto-loaded via `python-dotenv`.
+- Typed exception hierarchy for precise error handling.
+
+## Installation
+
+```bash
+pip install "waveium[parquet]"
+```
+
+The `[parquet]` extra pulls in `pandas` and `pyarrow`, which
+`client.executions.read_parquet()` requires. Drop it if you only need
+to drive simulations without reading results in-process.
+
+Python 3.9 or newer. Tested up to 3.13.
+
+## Quick start
+
+```python
+import waveium
+
+client = waveium.init()  # reads WAVEIUM_API_KEY from env / .env
+
+# 1. Create an environment (outdoor, route-based).
+env_resp = client.environments.create(
+    name="Stockholm Route",
+    environment_type="outdoor",
+    route={
+        "start": "Stockholm Central Station",
+        "end": "Gamla Stan",
+        "area": "Stockholm, Sweden",
+    },
+    stations={"BS1": [59.3293, 18.0686, 25.0]},
+)
+env = client.environments.wait(
+    env_resp.environment.environment_id, timeout=900
+)
+
+# 2. Create and generate a scene.
+scene = client.scenes.create(
+    environment_id=env.environment_id,
+    name="Default Scene",
+    parameters={
+        "stations": {"BS1": [59.3293, 18.0686, 25.0]},
+        "station_radio_config": {
+            "BS1": {"tx_power_dbm": 20.0, "noise_floor_dbm": -100.0}
+        },
+    },
+)
+client.scenes.generate(scene.scene_id)
+client.scenes.wait(scene.scene_id, timeout=3600)
+
+# 3. Run an execution and stream progress.
+execution = client.scenes.create_and_run(
+    scene.scene_id,
+    execution_name="Quick Start",
+    timeout=3600,
+)
+
+# 4. Read the parquet results into a DataFrame.
+df = client.executions.read_parquet(
+    execution.execution_id, structured=True
+)
+print(df.columns)
+client.close()
+```
+
+For a guided walkthrough -- including how to plot RSSI, SNR, and
+channel gain -- see [`docs/getting_started.md`](docs/getting_started.md).
+
+## Authentication
+
+The SDK reads the API key from the `WAVEIUM_API_KEY` (or
+`WAVEIUM_SDK_TOKEN`) environment variable. Create keys at
+<https://app.waveium.io>.
+
+### Using a `.env` file (recommended)
+
+```env
+WAVEIUM_API_KEY=wvx_paste_your_key_here
+```
+
+```python
+import waveium
+client = waveium.init()  # .env auto-loaded
+```
+
+### Passing the key explicitly
+
+```python
+client = waveium.init(api_key="wvx_...")
+```
+
+### Firebase JWT exchange
+
+If you already have a signed-in Firebase user, exchange the JWT for a
+long-lived API key in one call:
+
+```python
+client = waveium.auth(
+    firebase_token="eyJ...",      # or set FIREBASE_TOKEN
+    token_name="My Python App",
+    expires_days=30,
+)
+```
+
+Under the hood this POSTs the Firebase JWT to `/auth/tokens` with
+`Authorization: Bearer <jwt>` and returns a `Client` bound to the new
+`wvx_` key.
+
+## Async usage
+
+The `AsyncClient` mirrors the sync client one-for-one and works as an
+async context manager:
+
+```python
+import asyncio
+import waveium
+
+
+async def main() -> None:
+    async with waveium.AsyncClient() as client:
+        execution = await client.scenes.create_and_run(
+            "scn_xxx",
+            execution_name="Async run",
+            timeout=3600,
+        )
+        df = await client.executions.read_parquet(
+            execution.execution_id, structured=True
+        )
+        print(df.head())
+
+
+asyncio.run(main())
+```
+
+See `examples/async_streaming_usage.py` for the full set of async
+streaming patterns.
+
+## Available resources
+
+| Resource | Purpose |
+|---|---|
+| `client.environments` | Create / list / get / wait on environments. |
+| `client.scenes` | Scene lifecycle, `generate()`, `wait()`, `create_execution()`, `create_and_run()`, file upload. |
+| `client.executions` | Execution lifecycle, SSE streaming, `wait()`, `get()`, `progress()`, `read_parquet()`, `download_parquet()`, `download_archive()`, post-processing. |
+| `client.antenna_patterns` | List, upload, and manage antenna patterns. |
+| `client.auth` | Create, list, and revoke API tokens (Firebase exchange lives here). |
+| `client.users` | `me()` and admin user management. |
+| `client.organizations` | Organization admin. |
+| `client.teams` | Team membership management. |
+| `client.projects` | Project scoping for shared work. |
+| `client.roles` | RBAC role and permission queries. |
+
+## Error handling
+
+All SDK errors inherit from `waveium.WaveiumError`:
+
+```python
+from waveium import (
+    WaveiumError,           # Base class
+    AuthenticationError,    # 401
+    AuthorizationError,     # 403
+    NotFoundError,          # 404
+    ConflictError,          # 409 (e.g. scene not completed yet)
+    ValidationError,        # 400
+    RateLimitError,         # 429
+    APIError,               # 5xx
+    NetworkError,           # connection / DNS / timeout
+    FileUploadError,
+    FileDownloadError,
+    ConfigurationError,
+    StreamError,
+    StreamTimeoutError,
+    StreamReconnectError,
+    ExecutionFailedError,   # terminal "failed" SSE event
+)
+
+try:
+    client.scenes.create_and_run(scene_id, timeout=3600)
+except ExecutionFailedError as e:
+    print(f"Execution {e.execution_id} failed: {e.error_message}")
+except ConflictError:
+    print("Scene is not in completed state yet")
+except WaveiumError as e:
+    print(f"SDK error: {e}")
+```
+
+## Configuration
+
+| Variable | Meaning | Default |
+|---|---|---|
+| `WAVEIUM_API_KEY` | API key (starts with `wvx_`) | -- |
+| `WAVEIUM_SDK_TOKEN` | Alias for `WAVEIUM_API_KEY` | -- |
+| `FIREBASE_TOKEN` | Firebase JWT for `waveium.auth()` | -- |
+| `WAVEIUM_BASE_URL` | API base URL | `https://api.waveium.io` |
+| `WAVEIUM_TIMEOUT` | HTTP timeout in seconds | `60` |
+| `WAVEIUM_MAX_RETRIES` | Retry budget for idempotent requests | `3` |
+
+Override programmatically:
+
+```python
+client = waveium.init(
+    api_key="wvx_...",
+    base_url="https://api.waveium.io",
+    timeout=120.0,
+    max_retries=5,
+)
+```
+
+## Examples
+
+See the `examples/` directory for runnable scripts. Each reads
+`WAVEIUM_API_KEY` from the environment (or a `.env` file).
+
+| Script | What it shows |
+|---|---|
+| `basic_usage.py` | Full Env -> Scene -> Execution pipeline, synchronous. |
+| `streaming_usage.py` | Four tiers of SSE streaming (raw stream, blocking wait, create-and-run, environment wait). |
+| `async_usage.py` | Async environment creation. |
+| `async_streaming_usage.py` | Async counterparts of the streaming tiers. |
+| `load_and_plot.py` | Minimal results-only script: point it at an `execution_id` to plot channel power and CIR. |
+| `helsinki_usage.py` | Full outdoor Helsinki route: run the sim, download the parquet, and plot a 2D PDP. |
+| `helsinki_track_usage.py` | Outdoor bbox variant: generate/upload a GPX track with timestamps as the UE trajectory, run the sim, download the parquet, and plot a 2D PDP. |
+| `upload_download.py` | Scene file upload and execution result download. |
+| `underground_workflow.py` | Complex underground scenario driven by JSON tunnel graph and CSV stations/UE, using polling. |
+| `underground_workflow_sse.py` | Same scenario using SSE streaming instead of polling. |
+| `verify_sdk.py` | Quick smoke test: init, `users.me()`, list environments. |
+
+## Development
+
+```bash
+cd python313
+pip install -e ".[dev,parquet]"
+```
+
+Code quality gates (match the project's `pyproject.toml` and
+`setup.cfg`):
+
+```bash
+black src/ examples/ tests/
+flake8 src/ examples/ tests/
+mypy --strict src/
+pytest
+```
+
+## License
+
+MIT -- see [`LICENSE`](LICENSE).
+
+## Support
+
+- Dashboard: <https://app.waveium.io>
+- Documentation: <https://docs.waveium.io>
+- Issues: <https://github.com/waveium/waveium-sdk/issues>
+- Email: <support@waveium.io>

waveium-0.4.0/README.md

@@ -0,0 +1,276 @@
+# Waveium Python SDK
+
+Official Python client library for the [Waveium API](https://waveium.io).
+Build and run RF propagation simulations on top of a real environment
+model, stream progress via Server-Sent Events, and read the parquet
+results straight into a pandas DataFrame.
+
+**New here?** Start with the step-by-step walkthrough at
+[`docs/getting_started.md`](docs/getting_started.md).
+
+## Features
+
+- Full coverage of the **Environment -> Scene -> Execution** workflow.
+- Synchronous (`waveium.Client`) and asynchronous
+  (`waveium.AsyncClient`) clients.
+- Built-in SSE progress streaming with blocking `wait()` helpers and
+  a `create_and_run()` convenience for the common case.
+- `read_parquet()` streams result files straight into pandas without
+  writing to disk; `structured=True` merges xyz triplets and complex
+  re/im pairs for immediate analysis.
+- Pydantic v2 models throughout for type safety.
+- `.env` auto-loaded via `python-dotenv`.
+- Typed exception hierarchy for precise error handling.
+
+## Installation
+
+```bash
+pip install "waveium[parquet]"
+```
+
+The `[parquet]` extra pulls in `pandas` and `pyarrow`, which
+`client.executions.read_parquet()` requires. Drop it if you only need
+to drive simulations without reading results in-process.
+
+Python 3.9 or newer. Tested up to 3.13.
+
+## Quick start
+
+```python
+import waveium
+
+client = waveium.init()  # reads WAVEIUM_API_KEY from env / .env
+
+# 1. Create an environment (outdoor, route-based).
+env_resp = client.environments.create(
+    name="Stockholm Route",
+    environment_type="outdoor",
+    route={
+        "start": "Stockholm Central Station",
+        "end": "Gamla Stan",
+        "area": "Stockholm, Sweden",
+    },
+    stations={"BS1": [59.3293, 18.0686, 25.0]},
+)
+env = client.environments.wait(
+    env_resp.environment.environment_id, timeout=900
+)
+
+# 2. Create and generate a scene.
+scene = client.scenes.create(
+    environment_id=env.environment_id,
+    name="Default Scene",
+    parameters={
+        "stations": {"BS1": [59.3293, 18.0686, 25.0]},
+        "station_radio_config": {
+            "BS1": {"tx_power_dbm": 20.0, "noise_floor_dbm": -100.0}
+        },
+    },
+)
+client.scenes.generate(scene.scene_id)
+client.scenes.wait(scene.scene_id, timeout=3600)
+
+# 3. Run an execution and stream progress.
+execution = client.scenes.create_and_run(
+    scene.scene_id,
+    execution_name="Quick Start",
+    timeout=3600,
+)
+
+# 4. Read the parquet results into a DataFrame.
+df = client.executions.read_parquet(
+    execution.execution_id, structured=True
+)
+print(df.columns)
+client.close()
+```
+
+For a guided walkthrough -- including how to plot RSSI, SNR, and
+channel gain -- see [`docs/getting_started.md`](docs/getting_started.md).
+
+## Authentication
+
+The SDK reads the API key from the `WAVEIUM_API_KEY` (or
+`WAVEIUM_SDK_TOKEN`) environment variable. Create keys at
+<https://app.waveium.io>.
+
+### Using a `.env` file (recommended)
+
+```env
+WAVEIUM_API_KEY=wvx_paste_your_key_here
+```
+
+```python
+import waveium
+client = waveium.init()  # .env auto-loaded
+```
+
+### Passing the key explicitly
+
+```python
+client = waveium.init(api_key="wvx_...")
+```
+
+### Firebase JWT exchange
+
+If you already have a signed-in Firebase user, exchange the JWT for a
+long-lived API key in one call:
+
+```python
+client = waveium.auth(
+    firebase_token="eyJ...",      # or set FIREBASE_TOKEN
+    token_name="My Python App",
+    expires_days=30,
+)
+```
+
+Under the hood this POSTs the Firebase JWT to `/auth/tokens` with
+`Authorization: Bearer <jwt>` and returns a `Client` bound to the new
+`wvx_` key.
+
+## Async usage
+
+The `AsyncClient` mirrors the sync client one-for-one and works as an
+async context manager:
+
+```python
+import asyncio
+import waveium
+
+
+async def main() -> None:
+    async with waveium.AsyncClient() as client:
+        execution = await client.scenes.create_and_run(
+            "scn_xxx",
+            execution_name="Async run",
+            timeout=3600,
+        )
+        df = await client.executions.read_parquet(
+            execution.execution_id, structured=True
+        )
+        print(df.head())
+
+
+asyncio.run(main())
+```
+
+See `examples/async_streaming_usage.py` for the full set of async
+streaming patterns.
+
+## Available resources
+
+| Resource | Purpose |
+|---|---|
+| `client.environments` | Create / list / get / wait on environments. |
+| `client.scenes` | Scene lifecycle, `generate()`, `wait()`, `create_execution()`, `create_and_run()`, file upload. |
+| `client.executions` | Execution lifecycle, SSE streaming, `wait()`, `get()`, `progress()`, `read_parquet()`, `download_parquet()`, `download_archive()`, post-processing. |
+| `client.antenna_patterns` | List, upload, and manage antenna patterns. |
+| `client.auth` | Create, list, and revoke API tokens (Firebase exchange lives here). |
+| `client.users` | `me()` and admin user management. |
+| `client.organizations` | Organization admin. |
+| `client.teams` | Team membership management. |
+| `client.projects` | Project scoping for shared work. |
+| `client.roles` | RBAC role and permission queries. |
+
+## Error handling
+
+All SDK errors inherit from `waveium.WaveiumError`:
+
+```python
+from waveium import (
+    WaveiumError,           # Base class
+    AuthenticationError,    # 401
+    AuthorizationError,     # 403
+    NotFoundError,          # 404
+    ConflictError,          # 409 (e.g. scene not completed yet)
+    ValidationError,        # 400
+    RateLimitError,         # 429
+    APIError,               # 5xx
+    NetworkError,           # connection / DNS / timeout
+    FileUploadError,
+    FileDownloadError,
+    ConfigurationError,
+    StreamError,
+    StreamTimeoutError,
+    StreamReconnectError,
+    ExecutionFailedError,   # terminal "failed" SSE event
+)
+
+try:
+    client.scenes.create_and_run(scene_id, timeout=3600)
+except ExecutionFailedError as e:
+    print(f"Execution {e.execution_id} failed: {e.error_message}")
+except ConflictError:
+    print("Scene is not in completed state yet")
+except WaveiumError as e:
+    print(f"SDK error: {e}")
+```
+
+## Configuration
+
+| Variable | Meaning | Default |
+|---|---|---|
+| `WAVEIUM_API_KEY` | API key (starts with `wvx_`) | -- |
+| `WAVEIUM_SDK_TOKEN` | Alias for `WAVEIUM_API_KEY` | -- |
+| `FIREBASE_TOKEN` | Firebase JWT for `waveium.auth()` | -- |
+| `WAVEIUM_BASE_URL` | API base URL | `https://api.waveium.io` |
+| `WAVEIUM_TIMEOUT` | HTTP timeout in seconds | `60` |
+| `WAVEIUM_MAX_RETRIES` | Retry budget for idempotent requests | `3` |
+
+Override programmatically:
+
+```python
+client = waveium.init(
+    api_key="wvx_...",
+    base_url="https://api.waveium.io",
+    timeout=120.0,
+    max_retries=5,
+)
+```
+
+## Examples
+
+See the `examples/` directory for runnable scripts. Each reads
+`WAVEIUM_API_KEY` from the environment (or a `.env` file).
+
+| Script | What it shows |
+|---|---|
+| `basic_usage.py` | Full Env -> Scene -> Execution pipeline, synchronous. |
+| `streaming_usage.py` | Four tiers of SSE streaming (raw stream, blocking wait, create-and-run, environment wait). |
+| `async_usage.py` | Async environment creation. |
+| `async_streaming_usage.py` | Async counterparts of the streaming tiers. |
+| `load_and_plot.py` | Minimal results-only script: point it at an `execution_id` to plot channel power and CIR. |
+| `helsinki_usage.py` | Full outdoor Helsinki route: run the sim, download the parquet, and plot a 2D PDP. |
+| `helsinki_track_usage.py` | Outdoor bbox variant: generate/upload a GPX track with timestamps as the UE trajectory, run the sim, download the parquet, and plot a 2D PDP. |
+| `upload_download.py` | Scene file upload and execution result download. |
+| `underground_workflow.py` | Complex underground scenario driven by JSON tunnel graph and CSV stations/UE, using polling. |
+| `underground_workflow_sse.py` | Same scenario using SSE streaming instead of polling. |
+| `verify_sdk.py` | Quick smoke test: init, `users.me()`, list environments. |
+
+## Development
+
+```bash
+cd python313
+pip install -e ".[dev,parquet]"
+```
+
+Code quality gates (match the project's `pyproject.toml` and
+`setup.cfg`):
+
+```bash
+black src/ examples/ tests/
+flake8 src/ examples/ tests/
+mypy --strict src/
+pytest
+```
+
+## License
+
+MIT -- see [`LICENSE`](LICENSE).
+
+## Support
+
+- Dashboard: <https://app.waveium.io>
+- Documentation: <https://docs.waveium.io>
+- Issues: <https://github.com/waveium/waveium-sdk/issues>
+- Email: <support@waveium.io>