From 7aeae2d59a36c8dc3126916abe110171c090c30b Mon Sep 17 00:00:00 2001 From: JoelLucaAdams Date: Thu, 14 Nov 2024 14:23:56 +0000 Subject: [PATCH] Add readme badges --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index beddc2f..c68718a 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,12 @@ # sdf-xarray +![PyPI](https://img.shields.io/pypi/v/sdf-xarray?color=blue) +![Build/Publish](https://github.com/PlasmaFAIR/sdf-xarray/actions/workflows/build_publish.yml/badge.svg) +![Tests](https://github.com/PlasmaFAIR/sdf-xarray/actions/workflows/tests.yml/badge.svg) + `sdf-xarray` provides a backend for [xarray](https://xarray.dev) to read SDF files as created by the [EPOCH](https://epochpic.github.io) -plasma PIC code. - -`sdf-xarray` uses the [SDF-C](https://github.com/Warwick-Plasma/SDF_C) library. - -> [!IMPORTANT] -> All variable names now use snake_case to align with Epoch’s `sdf_helper` -> conventions. For example, `Electric Field/Ex` has been updated to -> `Electric_Field_Ex`. +plasma PIC code. It also uses the [SDF-C](https://github.com/Warwick-Plasma/SDF_C) library. ## Installation