From be59c2e15c624f34ebb7180aa5cfe8d2b3719356 Mon Sep 17 00:00:00 2001 From: Joel Adams Date: Wed, 9 Apr 2025 15:22:54 +0100 Subject: [PATCH 1/3] migrate URLs to epochpic --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 23ea482..eca2998 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # epydeck ![PyPI](https://img.shields.io/pypi/v/epydeck?color=blue) -![Build/Publish](https://github.com/PlasmaFAIR/epydeck/actions/workflows/build_publish.yml/badge.svg) -![Tests](https://github.com/PlasmaFAIR/epydeck/actions/workflows/tests.yml/badge.svg) +![Build/Publish](https://github.com/epochpic/epydeck/actions/workflows/build_publish.yml/badge.svg) +![Tests](https://github.com/epochpic/epydeck/actions/workflows/tests.yml/badge.svg) -Epydeck is an [EPOCH](https://epochpic.github.io/) input file (deck) reader/writer. Part of [BEAM](#broad-epoch-analysis-modules-beam) (Broad EPOCH Analysis Modules). +Epydeck (short for *EPOCH Python deck*) is an [EPOCH](https://epochpic.github.io/) input file (deck) reader/writer. Part of [BEAM](#broad-epoch-analysis-modules-beam) (Broad EPOCH Analysis Modules). ## Installation @@ -17,7 +17,7 @@ pip install epydeck or from local checkout: ```bash -git clone https://github.com/PlasmaFAIR/epydeck.git +git clone https://github.com/epochpic/epydeck.git cd epydeck pip install . ``` @@ -160,7 +160,11 @@ If epydeck contributes to a project that leads to publication, please acknowledg ![BEAM logo](./BEAM.png) -BEAM is structured as a set of independent yet complementary open-source tools designed for analysing [EPOCH](https://epochpic.github.io/) simulations where researchers can adopt only the components they need, without being constrained by a rigid framework. The packages are as follows: +**BEAM** is a collection of independent yet complementary open-source tools for analysing EPOCH simulations, designed to be modular so researchers can adopt only the components they require without being constrained by a rigid framework. In line with the **FAIR principles — Findable**, **Accessible**, **Interoperable**, and **Reusable** — each package is openly published with clear documentation and versioning (Findable), distributed via public repositories (Accessible), designed to follow common standards for data structures and interfaces (Interoperable), and includes licensing and metadata to support long-term use and adaptation (Reusable). The packages are as follows: + +- [sdf-xarray](https://github.com/epochpic/sdf-xarray): Reading and processing SDF files and converting them to [xarray](https://docs.xarray.dev/en/stable/). +- [epydeck](https://github.com/epochpic/epydeck): Input deck reader and writer. +- [epyscan](https://github.com/epochpic/epyscan): Create campaigns over a given parameter space using various sampling methods. - [sdf-xarray](https://github.com/PlasmaFAIR/sdf-xarray): Reading and processing SDF files and converting them to [xarray](https://docs.xarray.dev/en/stable/). - [epydeck](https://github.com/PlasmaFAIR/epydeck): Input deck reader and writer. From 20f94803d9434d22966f6b807361b954ea5bd5fd Mon Sep 17 00:00:00 2001 From: Joel Adams Date: Wed, 9 Apr 2025 15:23:04 +0100 Subject: [PATCH 2/3] Add PlasmaFAIR section --- PlasmaFAIR.svg | 192 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 8 ++- 2 files changed, 197 insertions(+), 3 deletions(-) create mode 100644 PlasmaFAIR.svg diff --git a/PlasmaFAIR.svg b/PlasmaFAIR.svg new file mode 100644 index 0000000..95c4356 --- /dev/null +++ b/PlasmaFAIR.svg @@ -0,0 +1,192 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/README.md b/README.md index eca2998..18c60b0 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,8 @@ If epydeck contributes to a project that leads to publication, please acknowledg - [epydeck](https://github.com/epochpic/epydeck): Input deck reader and writer. - [epyscan](https://github.com/epochpic/epyscan): Create campaigns over a given parameter space using various sampling methods. -- [sdf-xarray](https://github.com/PlasmaFAIR/sdf-xarray): Reading and processing SDF files and converting them to [xarray](https://docs.xarray.dev/en/stable/). -- [epydeck](https://github.com/PlasmaFAIR/epydeck): Input deck reader and writer. -- [epyscan](https://github.com/PlasmaFAIR/epyscan): Create campaigns over a given parameter space using various sampling methods. +## PlasmaFAIR + +![PlasmaFAIR logo](PlasmaFAIR.svg) + +Originally developed by [PlasmaFAIR](https://plasmafair.github.io), EPSRC Grant EP/V051822/1 \ No newline at end of file From d3428b14dfbd9f3450a67ebc9b2f19be0137ebef Mon Sep 17 00:00:00 2001 From: Joel Adams Date: Wed, 9 Apr 2025 15:23:11 +0100 Subject: [PATCH 3/3] update citation --- CITATION.cff | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 4b3539f..0161920 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -2,7 +2,7 @@ cff-version: 1.2.0 title: 'epydeck: EPOCH input file reader/writer' message: 'If you use this software, please cite it using the metadata from this file.' type: software -repository-code: 'https://github.com/PlasmaFAIR/epydeck' +repository-code: 'https://github.com/epochpic/epydeck' authors: - family-names: Hill given-names: Peter @@ -12,5 +12,4 @@ authors: given-names: Joel L. orcid: 'https://orcid.org/0009-0005-4889-5231' affiliation: University of York -repository-code: 'https://github.com/PlasmaFAIR/epydeck' date-released: '2024-04-22'