JOSS Submission#122
Draft
JoelLucaAdams wants to merge 26 commits into
Draft
Conversation
Co-authored-by: Liam Pattinson <[email protected]>
Co-authored-by: ShaunD137 <[email protected]>
ZedThree
reviewed
Jun 15, 2026
ZedThree
left a comment
ZedThree
left a comment
Collaborator
There was a problem hiding this comment.
Some other things that I didn't see that are worth mentioning or making explicit:
sdf-xarrayis a wrapper over SDF-C, just likesdf_helper- this means we also have compiled components
- we use a modern Python backend (
scikit-build-core) to simplify the building process, even for local builds - we distribute pre-built binaries, built using
cibuildwheelto build on multiple platforms
Co-authored-by: Peter Hill <[email protected]>
Co-authored-by: ZedThree <[email protected]>
Collaborator
Author
|
@ZedThree Thanks for the useful feedback! I have updated the paper to also include the bullet points you've mentioned in the |
| On top of it's adoption by researchers at the University of York, Strathclyde University, Queens University Belfast, First Light Fusion and a few government entities, it is also being used in teaching materials for a course on PIC codes delivered to undergraduate students at the University of York. The library was also used as the primary interfacing tool in the EPOCH 2025 and 2026 workshops. | ||
| Beyond its foundational deployment at the University of York, `sdf-xarray` has achieved broader institutional adoption, seeing active use by researchers at the University of Strathclyde, Queen's University Belfast, First Light Fusion, and several government entities. In addition to driving primary research, the library serves a distinct educational role; it has been integrated into a course on PIC codes delivered to undergraduate students at the University of York and served as the primary data-interfacing utility for both the 2025 and 2026 international EPOCH user workshops. | ||
|
|
||
| By adhering strictly to FAIR (Findable, Accessible, Interoperable, and Reusable) data principles, `sdf-xarray` alongside it's sister BEAM packages, `epyscan` and `epydeck` [@hill:2024b] maintains a transparent, community-driven developement model that encourages external contributions. In recognition of this commitment to open science and its measurable impact on the plasma physics community, the BEAM project was awarded the [2025 University of York Open Research Award in the Postgraduate Researcher (Sciences) category](https://uoy.atlassian.net/wiki/spaces/YorkOpenResearch/pages/995426305/York+Open+Research+Awards+2025#BEAM%3A-Broad-Epoch-Analysis-Modules). |
Collaborator
There was a problem hiding this comment.
I doubt you can depend on this URL being persistent, so you may have to exclude the link.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I think it's high time we publish a paper on sdf-xarray in JOSS as it's currently in a good state. Please can everyone tagged here read through the paper. It would be nice to have a polished draft complete within the next few weeks so that we can submit a draft to JOSS before EPS-PP 2026!
For those unfamiliar this is quite different to the traditional physics journal publication route. Please read this section of their documentation to understand the section titles and the expected format. The paper is meant to be on the shorter side and be complimentary to the existing documentation.
Document format
This document is written using a flavour of Markdown provided by JOSS, please see their documentation for details.
Authorship
I have added anyone who has contributed to the project using the GitHub contributors statistics. If you think I've missed someone please let me know. If you would prefer to have your name retracted from the paper please also let me know.
With that being said, I have added the following authors to the paper in the following order:
I have attempted to get all of your Orcid's correct, please do check them!
Citations
This is the first paper I have written so I might have not got the citations completely right, especially when it comes to citing software projects where there is no clear
CITATION.cffor bibtex entry. Any suggestions here would be appreciated.Building the paper
I have not managed to build the PDF locally (might be an M-series MacOS thing) but feel free to try yourself.
Everytime a new change to
paper.mdis pushed to GitHub, the GitHub action gets triggered. You can view the compiled PDF by clicking on the latest commit that's worked, then the "paper draft", then click on the "upload" section in the main window and click on the link at the end which should download a.zipfile with the pdf.