umfive 0.2.2__tar.gz → 0.4.0__tar.gz

umfive-0.4.0/.github/dependabot.yml

@@ -0,0 +1,20 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    # Workflow files stored in the default location of `.github/workflows`
+    # You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    cooldown:
+      default-days: 7
+    labels:
+      - dependencies
+      - github_actions
+      - automatedPR

{umfive-0.2.2 → umfive-0.4.0}/.github/workflows/build-and-deploy-wheels-on-pypi.yml

@@ -24,15 +24,15 @@ jobs:
 
     steps:
       - name: Checkout source
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v7
         with:
           python-version: "3.12"
 
       - name: Build wheels
-        uses: pypa/cibuildwheel@v3.2.1
+        uses: pypa/cibuildwheel@v4.2.1
         env:
           # Build CPython 3.11-3.14
           CIBW_BUILD: "cp311-* cp312-* cp313-* cp314-*"
@@ -41,7 +41,7 @@ jobs:
           # CIBW_TEST_COMMAND: "python -c \"import umfive; print('import ok')\""
 
       - name: Upload wheel artifacts
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: wheels-${{ matrix.os }}
           path: ./wheelhouse/*.whl
@@ -52,10 +52,10 @@ jobs:
 
     steps:
       - name: Checkout source
-        uses: actions/checkout@v4
+        uses: actions/checkout@v7
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v7
         with:
           python-version: "3.12"
 
@@ -66,7 +66,7 @@ jobs:
         run: python -m build --sdist
 
       - name: Upload sdist artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: sdist
           path: dist/*.tar.gz
@@ -85,7 +85,7 @@ jobs:
 
     steps:
       - name: Download all artifacts
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v8
         with:
           path: distfiles
 

{umfive-0.2.2 → umfive-0.4.0}/.github/workflows/pytest.yml

@@ -29,10 +29,10 @@ jobs:
         python-version: ["3.11", "3.12", "3.13", "3.14"]
 
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
-      - uses: conda-incubator/setup-miniconda@v3
+      - uses: conda-incubator/setup-miniconda@v4
         with:
           activate-environment: umfive
           environment-file: environment.yml
@@ -55,5 +55,5 @@ jobs:
           pip list
       - name: Test with pytest
         run: pytest -n 2
-      - name: Verify ppdump command
-        run: ppdump --help
+      - name: Verify umdump command
+        run: umdump

{umfive-0.2.2 → umfive-0.4.0}/.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
   # Use specific format-enforcing pre-commit hooks from the core library
   # with the default configuration (see pre-commit.com for documentation)
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v6.0.0
     hooks:
       - id: check-ast
       - id: debug-statements
@@ -23,7 +23,7 @@ repos:
   # (see https://black.readthedocs.io/en/stable/ for documentation and see
   # the cfdm pyproject.toml file for our custom black configuration)
   - repo: https://github.com/ambv/black
-    rev: 24.4.2
+    rev: 26.10.0
     hooks:
       - id: black
         language_version: python3
@@ -35,7 +35,7 @@ repos:
   # configuration as below)
 #  - repo: https://github.com/myint/docformatter
   - repo: https://github.com/PyCQA/docformatter
-    rev: v1.7.6
+    rev: v1.7.8
     hooks:
       - id: docformatter
         # These arguments act as the configuration for docformatter. They:
@@ -43,7 +43,7 @@ repos:
         # * ensure there is a blank line after the final non-empty line;
         # * wraps both summary and description at 72 characters (the latter
         #   by default).
-        args: [--in-place, --blank, --wrap-summaries=72]
+        args: [--in-place, --blank, --wrap-summaries=72, --wrap-descriptions=0]
 
   # Check the docstrings conforms to Google docstring format as much as can
   # be detected by the 'pydocstyle' checker
@@ -58,7 +58,7 @@ repos:
   # (see https://flake8.pycqa.org/en/latest/ for documentation and see
   # the cfdm .flake8 file for our custom flake8 configuration)
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.0
+    rev: 7.4.1
     hooks:
       - id: flake8
 
@@ -67,7 +67,7 @@ repos:
   # compatible with 'black' with the lines set to ensure so in the repo's
   # pyproject.toml. Other than that and the below, no extra config is required.
   - repo: https://github.com/PyCQA/isort
-    rev: 5.13.2
+    rev: 9.0.2
     hooks:
       - id: isort
         name: isort (python)

umfive-0.4.0/.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-lts-latest
+  tools:
+    # DO NOT use mambaforge-*; that is currently sunsetted
+    python: "miniforge3-latest"
+  jobs:
+    post_create_environment:
+      - conda run -n ${CONDA_DEFAULT_ENV} pip install . --no-deps
+      # example how to tweak pre-commands in RTD's weird conda env
+      # - conda run -n ${CONDA_DEFAULT_ENV} git clone https://github.com/NCAS-CMS/umfive.git
+      # - cd umfive && conda run -n ${CONDA_DEFAULT_ENV} pip install -e .
+
+# Declare the requirements required to build your docs
+conda:
+  environment:
+    environment.yml
+
+# Build documentation in the doc directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  fail_on_warning: true

umfive-0.4.0/Changelog.rst

@@ -0,0 +1,18 @@
+Version 0.4.0
+-------------
+
+**2026-10-13**
+
+* Add documentation pages
+  (https://github.com/NCAS-CMS/umfive/issues/34)
+* Fix vertical dimension for single-surface variables
+  (https://github.com/NCAS-CMS/umfive/issues/36)
+* Fix bug when creating bounds and orography for atmosphere hybrid
+  height coordinates (https://github.com/NCAS-CMS/umfive/issues/47)
+
+Version 0.3.0
+-------------
+
+**2026-08-14**
+
+* First public release.

{umfive-0.2.2/umfive.egg-info → umfive-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: umfive
-Version: 0.2.2
+Version: 0.4.0
 Summary: PP/Fields reader with pyfive-style high-level API
 Author: David Hassell, Alan Iwi, Bryan Lawrence, Valeriu Predoi - package
 License: MIT
@@ -8,20 +8,25 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cftime
-Requires-Dist: numpy>=1.24
-Requires-Dist: pyfive>=1.1.2
+Requires-Dist: numpy>=2
 Provides-Extra: io
 Requires-Dist: fsspec>=2024.3.0; extra == "io"
 Provides-Extra: test
 Requires-Dist: pytest>=8; extra == "test"
 Requires-Dist: pytest-cov>=5; extra == "test"
 Requires-Dist: pytest-xdist; extra == "test"
+Requires-Dist: xnetcdf; extra == "test"
 Dynamic: license-file
 
 # umfive
 
-A PP and Fields file reader that mimics relevant parts of the `pyfive` high-level API,
-with support for lazy metadata loading and parallel data loading when necessary.
+`umfive` is a Python open source library for representing [UK Met
+Office PP and UM fields file datasets](https://artefacts.ceda.ac.uk/badc_datadocs/um/umdp_F3-UMDPF3.pdf)
+with [CF-netCDF](https://cfconventions.org/)-like structures that
+follow the API of [pyfive](https://pyfive.readthedocs.io), an HDF5
+reader.
+
+### [Read the `umfive` documentation](https://umfive.readthedocs.io)
 
 This is NOT an alternative to pyfive, it is a package which makes pp and fields files
 look like and taste ("quack like") chunked HDF5 files written by a NetCDF library.

{umfive-0.2.2 → umfive-0.4.0}/README.md

@@ -1,7 +1,12 @@
 # umfive
 
-A PP and Fields file reader that mimics relevant parts of the `pyfive` high-level API,
-with support for lazy metadata loading and parallel data loading when necessary.
+`umfive` is a Python open source library for representing [UK Met
+Office PP and UM fields file datasets](https://artefacts.ceda.ac.uk/badc_datadocs/um/umdp_F3-UMDPF3.pdf)
+with [CF-netCDF](https://cfconventions.org/)-like structures that
+follow the API of [pyfive](https://pyfive.readthedocs.io), an HDF5
+reader.
+
+### [Read the `umfive` documentation](https://umfive.readthedocs.io)
 
 This is NOT an alternative to pyfive, it is a package which makes pp and fields files
 look like and taste ("quack like") chunked HDF5 files written by a NetCDF library.

umfive-0.4.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = umfive
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

umfive-0.4.0/docs/custom.css

@@ -0,0 +1,6 @@
+/* Force code block captions to be left-aligned */
+.rst-content .code-block-caption, 
+.rst-content p.caption {
+    text-align: left !important;
+    padding-left: 0px !important;
+}

umfive-0.4.0/docs/make.bat

@@ -0,0 +1,23 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=umfive
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

umfive-0.4.0/docs/requirements.txt

@@ -0,0 +1 @@
+sphinx

umfive-0.4.0/docs/source/api_bytereader.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: umfive
+
+`umfive.ByteReader`
+-------------------
+
+.. autoclass:: ByteReader
+   :members:
+   :inherited-members:

umfive-0.4.0/docs/source/api_datavariable.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: umfive
+
+`umfive.DataVariable`
+---------------------
+
+.. autoclass:: DataVariable
+   :members:
+   :inherited-members:

umfive-0.4.0/docs/source/api_dimensionscale.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: umfive
+
+`umfive.DimensionScale`
+-----------------------
+
+.. autoclass:: DimensionScale
+   :members:
+   :inherited-members:

umfive-0.4.0/docs/source/api_file.rst

@@ -0,0 +1,10 @@
+.. currentmodule:: umfive
+
+.. _umfive.File:
+
+`umfive.File`
+-------------
+
+.. autoclass:: File
+   :members:
+   :inherited-members:

umfive-0.4.0/docs/source/api_fileobjreader.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: umfive
+
+`umfive.FileObjReader`
+----------------------
+
+.. autoclass:: FileObjReader
+   :members:
+   :inherited-members:

umfive-0.4.0/docs/source/api_localposixreader.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: umfive
+
+`umfive.LocalPosixReader`
+-------------------------
+
+.. autoclass:: LocalPosixReader
+   :members:
+   :inherited-members:

umfive-0.4.0/docs/source/api_recordinfo.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: umfive
+
+`umfive.RecordInfo`
+-------------------
+
+.. autoclass:: RecordInfo
+   :members:
+   :inherited-members:

umfive-0.4.0/docs/source/api_reference.rst

@@ -0,0 +1,15 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   api_file
+   api_datavariable
+   api_variable
+   api_dimensionscale
+   api_recordinfo
+   api_fileobjreader
+   api_localposixreader
+   api_bytereader
+

umfive-0.4.0/docs/source/api_variable.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: umfive
+
+`umfive.Variable`
+-----------------
+
+.. autoclass:: Variable
+   :members:
+   :inherited-members: