Merge branch 'main' into remove-wheel-pep517

SciTools · Apr 19, 2024 · 0af875c · 0af875c
2 parents 4019ad7 + 9caffa1
commit 0af875c
Show file tree

Hide file tree

Showing 33 changed files with 861 additions and 423 deletions.
diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
@@ -36,13 +36,14 @@ jobs:
       matrix:
         os: ["ubuntu-latest"]
         python-version: ["3.11"]
-        session: ["doctest"]
+        session: ["doctest", "linkcheck"]
         iris-source : ["conda-forge"]
         include:
           - os: "ubuntu-latest"
             python-version: "3.11"
             session: "tests"
             iris-source: "conda-forge"
+            coverage: "--coverage"
           - os: "ubuntu-latest"
             python-version: "3.11"
             session: "tests"
@@ -129,3 +130,7 @@ jobs:
           PY_VER: ${{ matrix.python-version }}
         run: |
           nox --session ${{ matrix.session }} -- --test-data-dir ${HOME}/iris-test-data/test_data
+
+      - name: "Upload coverage report"
+        uses: codecov/codecov-action@v4
+        if: ${{ matrix.coverage }}
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,8 @@
 *.py[co]
 
+# setuptools-scm
+_version.py
+
 # Packages
 *.egg
 *.egg-info

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -4,6 +4,19 @@ build:
   os: ubuntu-20.04
   tools:
     python: mambaforge-4.10
+  jobs:
+    post_checkout:
+      # The SciTools/iris-grib repository is shallow i.e., has a .git/shallow,
+      # therefore complete the repository with a full history in order
+      # to allow setuptools-scm to correctly auto-discover the version.
+      - git fetch --unshallow
+      - git fetch --all
+    # Need to stash the local changes that Read the Docs makes so that
+    #  setuptools_scm can generate the correct Iris-grib version.
+    pre_install:
+      - git stash
+    post_install:
+      - git stash pop
 
 conda:
   environment: requirements/readthedocs.yml

diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+<h4 align="center">
+    GRIB (GRIdded Binary) interface for Iris
+</h4>
+
+|                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ⚙️ CI            | [![ci-manifest](https://github.com/SciTools/iris-grib/actions/workflows/ci-manifest.yml/badge.svg)](https://github.com/SciTools/iris-grib/actions/workflows/ci-manifest.yml) [![ci-tests](https://github.com/SciTools/iris-grib/actions/workflows/ci-tests.yml/badge.svg)](https://github.com/SciTools/iris-grib/actions/workflows/ci-tests.yml) [![pre-commit](https://results.pre-commit.ci/badge/github/SciTools/iris-grib/main.svg)](https://results.pre-commit.ci/latest/github/SciTools/iris-grib/main)                                                        |
+| 💬 Community     | [![GH Discussions](https://img.shields.io/badge/github-discussions%20%F0%9F%92%AC-yellow?logo=github&logoColor=lightgrey)](https://github.com/SciTools/iris-grib/discussions)                                                                                                                                                                                                                                                                                                                                                                                        |
+| 📖 Documentation | [![rtd](https://readthedocs.org/projects/iris-grib/badge/?version=latest)](https://iris-grib.readthedocs.io/en/latest/?badge=latest)                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| 📈 Health        | [![coveralls](https://coveralls.io/repos/github/SciTools/iris-grib/badge.svg?branch=main)](https://coveralls.io/github/SciTools/iris-grib?branch=main)                                                                                                                                                                                                                                                                                                                                                                                                               |
+| ✨ Meta           | [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![NEP29](https://raster.shields.io/badge/follows-NEP29-orange.png)](https://numpy.org/neps/nep-0029-deprecation_policy.html) [![license - bds-3-clause](https://img.shields.io/github/license/SciTools/iris-grib)](https://github.com/SciTools/iris-grib/blob/main/LICENSE) [![conda platform](https://img.shields.io/conda/pn/conda-forge/iris-grib.svg)](https://anaconda.org/conda-forge/iris-grib) |
+| 📦 Package       | [![conda-forge](https://img.shields.io/conda/vn/conda-forge/iris-grib?color=orange&label=conda-forge&logo=conda-forge&logoColor=white)](https://anaconda.org/conda-forge/iris-grib) [![pypi](https://img.shields.io/pypi/v/iris-grib?color=orange&label=pypi&logo=python&logoColor=white)](https://pypi.org/project/iris-grib/) [![pypi - python version](https://img.shields.io/pypi/pyversions/iris-grib.svg?color=orange&logo=python&label=python&logoColor=white)](https://pypi.org/project/iris-grib/)                                                          |
+| 🧰 Repo          | [![commits-since](https://img.shields.io/github/commits-since/SciTools/iris-grib/latest.svg)](https://github.com/SciTools/iris-grib/commits/main) [![contributors](https://img.shields.io/github/contributors/SciTools/iris-grib)](https://github.com/SciTools/iris-grib/graphs/contributors) [![release](https://img.shields.io/github/v/release/scitools/iris-grib)](https://github.com/SciTools/iris-grib/releases)                                                                                                                                               |
+|                  |
+
+<p align="center">
+For documentation see the 
+<a href="https://iris-grib.readthedocs.io/en/latest/">latest</a>  
+developer version or the most recent released
+<a href="https://iris-grib.readthedocs.io/en/stable/">stable</a> version.
+</p>
+
+## [#ShowYourStripes](https://showyourstripes.info/s/globe)
+
+<h4 align="center">
+  <a href="https://showyourstripes.info/s/globe">
+    <img src="https://raw.githubusercontent.com/ed-hawkins/show-your-stripes/master/2021/GLOBE---1850-2021-MO.png"
+         height="50" width="800"
+         alt="#showyourstripes Global 1850-2021"></a>
+</h4>
+
+**Graphics and Lead Scientist**: [Ed Hawkins](https://www.met.reading.ac.uk/~ed/home/index.php), National Centre for Atmospheric Science, University of Reading.
+
+**Data**: Berkeley Earth, NOAA, UK Met Office, MeteoSwiss, DWD, SMHI, UoR, Meteo France & ZAMG.
+
+<p>
+<a href="https://showyourstripes.info/s/globe">#ShowYourStripes</a> is distributed under a
+<a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>
+<a href="https://creativecommons.org/licenses/by/4.0/">
+  <img src="https://i.creativecommons.org/l/by/4.0/80x15.png" alt="creative-commons-by" style="border-width:0"></a>
+</p>
+
diff --git a/README.rst b/README.rst