diff --git a/README.md b/README.md new file mode 100644 index 00000000..d6989dab --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +

+ GRIB (GRIdded Binary) interface for Iris +

+ +| | | +|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ⚙️ 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) | +| | + +

+For documentation see the +latest +developer version or the most recent released +stable version. +

+ +## [#ShowYourStripes](https://showyourstripes.info/s/globe) + +

+ + #showyourstripes Global 1850-2021 +

+ +**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. + +

+#ShowYourStripes is distributed under a +Creative Commons Attribution 4.0 International License + + creative-commons-by +

+ diff --git a/README.rst b/README.rst deleted file mode 100644 index fb0c6d94..00000000 --- a/README.rst +++ /dev/null @@ -1,29 +0,0 @@ -iris-grib -========= - -|CirrusCI|_ |Coveralls|_ |conda-forge|_ |pypi|_ |License|_ |Commits|_ |Contributors|_ - -GRIB interface for `Iris `_. - -iris-grib is licensed under the BSD-3 license. - -.. |CirrusCI| image:: https://api.cirrus-ci.com/github/SciTools/iris-grib.svg?branch=main -.. _CirrusCI: https://cirrus-ci.com/github/SciTools/iris-grib - -.. |Coveralls| image:: https://coveralls.io/repos/github/SciTools/iris-grib/badge.svg?branch=main -.. _Coveralls: https://coveralls.io/github/SciTools/iris-grib?branch=main - -.. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/iris-grib?color=orange&label=conda-forge&logo=conda-forge&logoColor=white -.. _conda-forge: https://anaconda.org/conda-forge/iris-grib - -.. |pypi| image:: https://img.shields.io/pypi/v/iris-grib?color=orange&label=pypi&logo=python&logoColor=white -.. _pypi: https://pypi.org/project/iris-grib - -.. |License| image:: https://img.shields.io/badge/BSD-3?style=plastic&label=License -.. _License: https://github.com/SciTools/iris-grib/blob/main/LICENSE - -.. |Contributors| image:: https://img.shields.io/github/contributors/SciTools/iris-grib?style=plastic -.. _Contributors: https://github.com/SciTools/iris-grib/graphs/contributors - -.. |Commits| image:: https://img.shields.io/github/commits-since/SciTools/iris-grib/latest.svg?style=plastic -.. _Commits: https://github.com/SciTools/iris-grib/commits/main diff --git a/docs/_static/iris-logo-title-dark.svg b/docs/_static/iris-logo-title-dark.svg new file mode 100644 index 00000000..44d8a3bb --- /dev/null +++ b/docs/_static/iris-logo-title-dark.svg @@ -0,0 +1,108 @@ + + \ No newline at end of file diff --git a/docs/_static/iris-logo-title.svg b/docs/_static/iris-logo-title.svg new file mode 100644 index 00000000..f1e7e236 --- /dev/null +++ b/docs/_static/iris-logo-title.svg @@ -0,0 +1,108 @@ + + \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index b4ef9cea..41cf7284 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -60,7 +60,7 @@ license-files = ["LICENSE"] [tool.setuptools.dynamic] dependencies = {file = "requirements/core.txt"} -readme = {file = "README.rst", content-type = "text/x-rst"} +readme = {file = "README.md", content-type = "text/markdown"} optional-dependencies.all = {file = "requirements/all.txt"} optional-dependencies.test = {file = "requirements/test.txt"}