xconv2 0.0.0__tar.gz

xconv2-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 NCAS University of Reading
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xconv2-0.0.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: xconv2
+Version: 0.0.0
+Summary: High-performance data viewer and simple data converter
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cf-plot>=3.5.0
+Requires-Dist: cf-python>=3.21.0
+Requires-Dist: fsspec
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: paramiko
+Requires-Dist: pillow
+Requires-Dist: prov
+Requires-Dist: pyfive>=1.2.0
+Requires-Dist: PySide6
+Requires-Dist: pystac-client
+Requires-Dist: rdflib
+Requires-Dist: s3fs
+Requires-Dist: setuptools>80
+Requires-Dist: superqt
+Requires-Dist: umfive>=0.2.2
+Requires-Dist: zarr
+Provides-Extra: test
+Requires-Dist: cryptography; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# xconv2
+
+xconv2 provides (or will provide) a graphical interface to local and remote weather and climate data.  It is a replacement for the venerable [xconv](https://ncas-cms.github.io/xconv-doc/html/index.html) package that has been supported by NCAS CMS for decades.
+
+<table>
+  <tr>
+    <td style="vertical-align: middle; padding: 2px;">
+      <img src="xconv2/assets/under-construction.svg" alt="Under construction icon" height="128px" />
+    </td>
+    <td style="vertical-align: middle;">
+      This version is under development. If you encounter something that looks like it should work, but doesn't, please
+      raise a bug issue at the address found in the About menu. If there is function that you would like to see, feel
+      free to raise an enhancement request at the same location.
+    </td>
+  </tr>
+</table>
+
+## Installation
+
+We intend to release this as a standalone executable for linux and macos, but for the moment you should use a Python 3.12 (or later) environment with
+udunits2 and cartopy installed (from conda-forge), then you can pip install from the source using one of these:
+
+### Alpha
+
+We intend to release this as a standalone application (an "app") eventually, but meanwhile, you will likely need a dedicated (or up-to-date) mamba environment with a Python 3.12 (or later) environment with `cartopy` and `udunits2` installed, then you can pip install from PyPI. Here's an example:
+
+```bash
+conda create -n xconv2
+conda activate xconv2
+mamba install -c conda-forge pip cartopy udunits2
+pip install xconv2
+```
+
+and then you should have `xconv2` available on your command line in that environment.  You could of course pip install into your own environment, but you will need to ensure it has cartopy and udunits2 in it (both via conda or mamba).
+
+### Conda Environments
+
+- `environment.yml`: base development/runtime environment.
+- `environment-integration.yml`: optional integration-test environment, including
+  pytest and cryptography for local HTTPS tests, and conda-forge SeaweedFS 4.48
+  (the native `weed` binary) for S3 integration tests. No Docker engine, CLI, or Python
+  Docker/MinIO packages are needed by the application or tests.
+
+See [Running tests](docs/dev_notes.md#running-tests) for setup and skip conditions.
+
+### Optional SSH support
+
+SSH browsing requires the optional `p5rem` package. It is not a dependency of
+the PyPI package or the base Conda environment. Install it explicitly into the
+environment used to run xconv2:
+
+```bash
+pip install p5rem
+```
+
+Without `p5rem`, the SSH tab is greyed out in the remote browsing and
+configuration dialogs. Clicking it displays installation guidance; S3 and
+HTTPS remain available.
+
+## Documentation
+
+No user documentation is yet available, but it is designed to be intuitive
+and basic usage should be possible without documentation once it is installed.
+
+### Raising issues
+
+Please raise any issues using the github link from the
+help menu. In doing so, it would be helpful to report
+the science stack used from the science stack report
+also available from the help menu.
+
+
+
+### Developer Documentation
+
+Limited developer documentation is available. For the moment it is
+limited to the following:
+
+#### UML Diagrams
+
+Rendered diagrams (GitHub-friendly):
+
+- `docs/uml/svg/CoreWindowCurrentClass.svg`
+- `docs/uml/svg/MainWindowComponentMap.svg`
+- `docs/uml/svg/CoreWindowGuiWorkerSignals.svg`
+- `docs/uml/svg/CoreWindowPhase3OptionsSequence.svg`
+- `docs/uml/svg/RemoteWorkerWarmupSequence.svg`
+- `docs/uml/svg/RemoteAccessModuleCurrent.svg`
+
+PlantUML sources:
+
+- `docs/uml/alpha_core_window.pu`
+- `docs/uml/main_window_component_map.pu`
+- `docs/uml/core_window_gui_worker_signals.puml`
+- `docs/uml/core_window_options_sequence.puml`
+- `docs/uml/remote_worker_warmup_sequence.puml`
+- `docs/uml/remote_access_module.puml`
+
+Regenerate SVGs after editing source diagrams:
+
+```bash
+./tools/generate_uml_svgs.sh
+```
+
+#### Architecture Notes
+
+- `docs/architecture/core_window_refactor.md`
+- `docs/architecture/remote_navigation_and_worker_warmup.md`
+
+## License
+
+This project is licensed under the MIT License. See `LICENSE`.

xconv2-0.0.0/README.md

@@ -0,0 +1,112 @@
+# xconv2
+
+xconv2 provides (or will provide) a graphical interface to local and remote weather and climate data.  It is a replacement for the venerable [xconv](https://ncas-cms.github.io/xconv-doc/html/index.html) package that has been supported by NCAS CMS for decades.
+
+<table>
+  <tr>
+    <td style="vertical-align: middle; padding: 2px;">
+      <img src="xconv2/assets/under-construction.svg" alt="Under construction icon" height="128px" />
+    </td>
+    <td style="vertical-align: middle;">
+      This version is under development. If you encounter something that looks like it should work, but doesn't, please
+      raise a bug issue at the address found in the About menu. If there is function that you would like to see, feel
+      free to raise an enhancement request at the same location.
+    </td>
+  </tr>
+</table>
+
+## Installation
+
+We intend to release this as a standalone executable for linux and macos, but for the moment you should use a Python 3.12 (or later) environment with
+udunits2 and cartopy installed (from conda-forge), then you can pip install from the source using one of these:
+
+### Alpha
+
+We intend to release this as a standalone application (an "app") eventually, but meanwhile, you will likely need a dedicated (or up-to-date) mamba environment with a Python 3.12 (or later) environment with `cartopy` and `udunits2` installed, then you can pip install from PyPI. Here's an example:
+
+```bash
+conda create -n xconv2
+conda activate xconv2
+mamba install -c conda-forge pip cartopy udunits2
+pip install xconv2
+```
+
+and then you should have `xconv2` available on your command line in that environment.  You could of course pip install into your own environment, but you will need to ensure it has cartopy and udunits2 in it (both via conda or mamba).
+
+### Conda Environments
+
+- `environment.yml`: base development/runtime environment.
+- `environment-integration.yml`: optional integration-test environment, including
+  pytest and cryptography for local HTTPS tests, and conda-forge SeaweedFS 4.48
+  (the native `weed` binary) for S3 integration tests. No Docker engine, CLI, or Python
+  Docker/MinIO packages are needed by the application or tests.
+
+See [Running tests](docs/dev_notes.md#running-tests) for setup and skip conditions.
+
+### Optional SSH support
+
+SSH browsing requires the optional `p5rem` package. It is not a dependency of
+the PyPI package or the base Conda environment. Install it explicitly into the
+environment used to run xconv2:
+
+```bash
+pip install p5rem
+```
+
+Without `p5rem`, the SSH tab is greyed out in the remote browsing and
+configuration dialogs. Clicking it displays installation guidance; S3 and
+HTTPS remain available.
+
+## Documentation
+
+No user documentation is yet available, but it is designed to be intuitive
+and basic usage should be possible without documentation once it is installed.
+
+### Raising issues
+
+Please raise any issues using the github link from the
+help menu. In doing so, it would be helpful to report
+the science stack used from the science stack report
+also available from the help menu.
+
+
+
+### Developer Documentation
+
+Limited developer documentation is available. For the moment it is
+limited to the following:
+
+#### UML Diagrams
+
+Rendered diagrams (GitHub-friendly):
+
+- `docs/uml/svg/CoreWindowCurrentClass.svg`
+- `docs/uml/svg/MainWindowComponentMap.svg`
+- `docs/uml/svg/CoreWindowGuiWorkerSignals.svg`
+- `docs/uml/svg/CoreWindowPhase3OptionsSequence.svg`
+- `docs/uml/svg/RemoteWorkerWarmupSequence.svg`
+- `docs/uml/svg/RemoteAccessModuleCurrent.svg`
+
+PlantUML sources:
+
+- `docs/uml/alpha_core_window.pu`
+- `docs/uml/main_window_component_map.pu`
+- `docs/uml/core_window_gui_worker_signals.puml`
+- `docs/uml/core_window_options_sequence.puml`
+- `docs/uml/remote_worker_warmup_sequence.puml`
+- `docs/uml/remote_access_module.puml`
+
+Regenerate SVGs after editing source diagrams:
+
+```bash
+./tools/generate_uml_svgs.sh
+```
+
+#### Architecture Notes
+
+- `docs/architecture/core_window_refactor.md`
+- `docs/architecture/remote_navigation_and_worker_warmup.md`
+
+## License
+
+This project is licensed under the MIT License. See `LICENSE`.

xconv2-0.0.0/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["setuptools>=80"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xconv2"
+description = "High-performance data viewer and simple data converter"
+requires-python = ">=3.12"
+dependencies = [
+    "cf-plot>=3.5.0",
+    "cf-python>=3.21.0",
+    "fsspec",
+    "numpy",
+    "pandas",
+    "paramiko",
+    "pillow",
+    "prov",
+    "pyfive>=1.2.0",
+    "PySide6",
+    "pystac-client",
+    "rdflib",
+    "s3fs",
+    "setuptools>80",  # cf-plot imports distutils
+    "superqt",
+    "umfive>=0.2.2",
+    "zarr",
+]
+dynamic = [
+    "readme",
+    "version",
+]
+
+[project.optional-dependencies]
+test = [
+    "cryptography",
+    "pytest",
+]
+
+[project.gui-scripts]
+# This creates an 'xconv2' command that launches your GUI
+xconv2 = "xconv2.gui:main"
+
+[project.scripts]
+# This creates a 'cf-worker' command for the backend process
+cf-worker = "xconv2.worker:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["xconv2*"]
+
+[tool.setuptools.package-data]
+xconv2 = ["assets/*.svg", "assets/*.png"]
+
+[tool.setuptools.dynamic]
+readme = {file = "README.md", content-type = "text/markdown"}
+
+[tool.setuptools_scm]
+version_scheme = "release-branch-semver"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+markers = [
+    "integration: tests exercising local HTTPS or native SeaweedFS S3 services (no Docker)",
+]
+filterwarnings = [
+    "ignore:distutils Version classes are deprecated. Use packaging.version instead.:DeprecationWarning:cfplot.cfplot",
+    "ignore:'maxsplit' is passed as positional argument:DeprecationWarning:cf.functions",
+]

xconv2-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

xconv2-0.0.0/tests/test_animation_protocol.py

@@ -0,0 +1,247 @@
+"""Tests for animation protocol encoding and decoding."""
+
+from __future__ import annotations
+
+import base64
+import pickle
+import time
+
+import pytest
+
+from xconv2.animation_protocol import (
+    AnimationEnd,
+    AnimationError,
+    AnimationFrame,
+    AnimationMetadata,
+    AnimationStart,
+    decode_payload,
+    encode_payload,
+)
+
+
+class TestAnimationMetadata:
+    """Tests for AnimationMetadata serialization."""
+
+    def test_metadata_to_dict(self) -> None:
+        meta = AnimationMetadata(
+            session_id="sess-123",
+            total_frames=10,
+            fps_hint=12.0,
+            title_template="{title} [{frame}]",
+            plot_kind="contour",
+            levels_locked=True,
+        )
+
+        data = meta.to_dict()
+
+        assert data["session_id"] == "sess-123"
+        assert data["total_frames"] == 10
+        assert data["fps_hint"] == 12.0
+        assert data["title_template"] == "{title} [{frame}]"
+        assert data["plot_kind"] == "contour"
+        assert data["levels_locked"] is True
+
+    def test_metadata_from_dict(self) -> None:
+        data = {
+            "session_id": "sess-123",
+            "total_frames": 10,
+            "fps_hint": 12.0,
+            "title_template": "{title} [{frame}]",
+            "plot_kind": "contour",
+            "levels_locked": True,
+        }
+
+        meta = AnimationMetadata.from_dict(data)
+
+        assert meta.session_id == "sess-123"
+        assert meta.total_frames == 10
+        assert meta.fps_hint == 12.0
+        assert meta.title_template == "{title} [{frame}]"
+        assert meta.plot_kind == "contour"
+        assert meta.levels_locked is True
+
+    def test_metadata_from_dict_partial(self) -> None:
+        data = {"session_id": "sess-123"}
+
+        meta = AnimationMetadata.from_dict(data)
+
+        assert meta.session_id == "sess-123"
+        assert meta.total_frames is None
+        assert meta.fps_hint is None
+        assert meta.plot_kind == "contour"
+        assert meta.levels_locked is False
+
+
+class TestAnimationFrame:
+    """Tests for AnimationFrame serialization."""
+
+    def test_frame_to_dict(self) -> None:
+        now = time.time()
+        png_data = b"PNG\x89\x01\x02\x03"
+
+        frame = AnimationFrame(
+            request_id="req-123",
+            session_id="sess-123",
+            frame_index=5,
+            total_frames=10,
+            png_bytes=png_data,
+            frame_value_label="frame 5",
+            emitted_at=now,
+        )
+
+        data = frame.to_dict()
+
+        assert data["request_id"] == "req-123"
+        assert data["session_id"] == "sess-123"
+        assert data["frame_index"] == 5
+        assert data["total_frames"] == 10
+        assert data["png_bytes"] == png_data
+        assert data["frame_value_label"] == "frame 5"
+        assert data["emitted_at"] == now
+
+    def test_frame_from_dict(self) -> None:
+        now = time.time()
+        png_data = b"PNG\x89\x01\x02\x03"
+
+        data = {
+            "request_id": "req-123",
+            "session_id": "sess-123",
+            "frame_index": 5,
+            "total_frames": 10,
+            "png_bytes": png_data,
+            "frame_value_label": "frame 5",
+            "emitted_at": now,
+        }
+
+        frame = AnimationFrame.from_dict(data)
+
+        assert frame.request_id == "req-123"
+        assert frame.session_id == "sess-123"
+        assert frame.frame_index == 5
+        assert frame.total_frames == 10
+        assert frame.png_bytes == png_data
+        assert frame.frame_value_label == "frame 5"
+        assert frame.emitted_at == now
+
+
+class TestAnimationStart:
+    """Tests for AnimationStart serialization."""
+
+    def test_start_to_dict(self) -> None:
+        now = time.time()
+
+        start = AnimationStart(
+            request_id="req-123",
+            session_id="sess-123",
+            total_frames=10,
+            fps_hint=12.0,
+            title_template="{title} [{frame}]",
+            started_at=now,
+        )
+
+        data = start.to_dict()
+
+        assert data["request_id"] == "req-123"
+        assert data["session_id"] == "sess-123"
+        assert data["total_frames"] == 10
+        assert data["fps_hint"] == 12.0
+        assert data["title_template"] == "{title} [{frame}]"
+        assert data["started_at"] == now
+
+    def test_start_from_dict(self) -> None:
+        now = time.time()
+
+        data = {
+            "request_id": "req-123",
+            "session_id": "sess-123",
+            "total_frames": 10,
+            "fps_hint": 12.0,
+            "title_template": "{title} [{frame}]",
+            "started_at": now,
+        }
+
+        start = AnimationStart.from_dict(data)
+
+        assert start.request_id == "req-123"
+        assert start.session_id == "sess-123"
+        assert start.total_frames == 10
+        assert start.fps_hint == 12.0
+        assert start.title_template == "{title} [{frame}]"
+        assert start.started_at == now
+
+
+class TestAnimationEnd:
+    """Tests for AnimationEnd serialization."""
+
+    def test_end_to_dict(self) -> None:
+        now = time.time()
+
+        end = AnimationEnd(
+            request_id="req-123",
+            session_id="sess-123",
+            frames_emitted=10,
+            completed_at=now,
+        )
+
+        data = end.to_dict()
+
+        assert data["request_id"] == "req-123"
+        assert data["session_id"] == "sess-123"
+        assert data["frames_emitted"] == 10
+        assert data["completed_at"] == now
+
+
+class TestAnimationError:
+    """Tests for AnimationError serialization."""
+
+    def test_error_to_dict(self) -> None:
+        now = time.time()
+
+        error = AnimationError(
+            request_id="req-123",
+            session_id="sess-123",
+            frame_index=5,
+            error="Contour failed",
+            failed_at=now,
+        )
+
+        data = error.to_dict()
+
+        assert data["request_id"] == "req-123"
+        assert data["session_id"] == "sess-123"
+        assert data["frame_index"] == 5
+        assert data["error"] == "Contour failed"
+        assert data["failed_at"] == now
+
+
+class TestPayloadEncoding:
+    """Tests for payload encoding and decoding."""
+
+    def test_encode_decode_roundtrip(self) -> None:
+        payload = {
+            "request_id": "req-123",
+            "session_id": "sess-123",
+            "frame_index": 5,
+            "data": "test",
+        }
+
+        encoded = encode_payload(payload)
+
+        assert isinstance(encoded, str)
+        assert encoded == base64.b64encode(pickle.dumps(payload)).decode("ascii")
+
+        decoded = decode_payload(encoded)
+
+        assert decoded == payload
+
+    def test_encode_with_binary_data(self) -> None:
+        payload = {
+            "png_bytes": b"PNG\x89\x01\x02\x03",
+            "request_id": "req-123",
+        }
+
+        encoded = encode_payload(payload)
+        decoded = decode_payload(encoded)
+
+        assert decoded["png_bytes"] == b"PNG\x89\x01\x02\x03"
+        assert decoded["request_id"] == "req-123"