Skip to content

Commit 1442d4c

Browse files
committed
README format line length
1 parent 2560fcc commit 1442d4c

1 file changed

Lines changed: 36 additions & 18 deletions

File tree

README.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
[![Read the Docs](https://img.shields.io/readthedocs/sdf-xarray?logo=readthedocs&link=https%3A%2F%2Fsdf-xarray.readthedocs.io%2F)](https://sdf-xarray.readthedocs.io)
99
[![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)
1010

11-
12-
sdf-xarray provides a backend for [xarray](https://xarray.dev) to read SDF files as created by
13-
[EPOCH](https://epochpic.github.io) using the [SDF-C](https://github.com/epochpic/SDF_C) library.
14-
Part of [BEAM](#broad-epoch-analysis-modules-beam) (Broad EPOCH Analysis Modules).
11+
sdf-xarray provides a backend for [xarray](https://xarray.dev) to read SDF files
12+
as created by [EPOCH](https://epochpic.github.io) using the
13+
[SDF-C](https://github.com/epochpic/SDF_C) library. Part of
14+
[BEAM](#broad-epoch-analysis-modules-beam) (Broad EPOCH Analysis Modules).
1515

1616
## Installation
1717

@@ -59,9 +59,9 @@ print(df["Electric_Field_Ex"])
5959

6060
### Multi-file loading
6161

62-
You can open all the SDF files for a given simulation by calling the `open_mfdataset`
63-
function from `sdf_xarray`. This will additionally add a time dimension using the `"time"`
64-
value stored in each files attributes.
62+
You can open all the SDF files for a given simulation by calling the
63+
`open_mfdataset` function from `sdf_xarray`. This will additionally add
64+
a time dimension using the `"time"` value stored in each files attributes.
6565

6666
> [!IMPORTANT]
6767
> If your simulation has multiple `output` blocks so that not all variables are
@@ -86,34 +86,52 @@ print(ds)
8686

8787
## Citing
8888

89-
If sdf-xarray contributes to a project that leads to publication, please acknowledge this by citing sdf-xarray. This can be done by clicking the "cite this repository" button located near the top right of this page.
89+
If sdf-xarray contributes to a project that leads to publication, please acknowledge
90+
this by citing sdf-xarray. This can be done by clicking the "cite this repository"
91+
button located near the top right of this page.
9092

9193
## Contributing
9294

93-
We welcome contributions to the BEAM ecosystem! Whether it's reporting issues, suggesting features, or submitting pull requests, your input helps improve these tools for the community.
95+
We welcome contributions to the BEAM ecosystem! Whether it's reporting issues,
96+
suggesting features, or submitting pull requests, your input helps improve these
97+
tools for the community.
9498

9599
### How to Contribute
96100

97101
There are many ways to get involved:
98-
- **Report bugs**: Found something not working as expected? Open an issue with as much detail as possible.
99-
- **Request a feature**: Got an idea for a new feature or enhancement? Open a feature request on [GitHub Issues](https://github.com/epochpic/sdf-xarray/issues)!
100-
- **Improve the documentation**: We aim to keep our docs clear and helpful—if something's missing or unclear, feel free to suggest edits.
101-
- **Submit code changes**: Bug fixes, refactoring, or new features are welcome.
102102

103+
- **Report bugs**: Found something not working as expected? Open an issue with as
104+
much detail as possible.
105+
- **Request a feature**: Got an idea for a new feature or enhancement? Open a feature
106+
request on [GitHub Issues](https://github.com/epochpic/sdf-xarray/issues)!
107+
- **Improve the documentation**: We aim to keep our docs clear and helpful—if
108+
something's missing or unclear, feel free to suggest edits.
109+
- **Submit code changes**: Bug fixes, refactoring, or new features are welcome.
103110

104111
All code is automatically linted, formatted, and tested via GitHub Actions.
105112

106-
To run checks locally before opening a pull request, see [CONTRIBUTING.md](CONTRIBUTING.md) or [readthedocs documentation](https://sdf-xarray.readthedocs.io/en/latest/contributing.html)
113+
To run checks locally before opening a pull request, see
114+
[CONTRIBUTING.md](CONTRIBUTING.md) or [readthedocs documentation](https://sdf-xarray.readthedocs.io/en/latest/contributing.html)
107115

108116
## Broad EPOCH Analysis Modules (BEAM)
109117

110118
![BEAM logo](./BEAM.png)
111119

112-
**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:
113-
114-
- [sdf-xarray](https://github.com/epochpic/sdf-xarray): Reading and processing SDF files and converting them to [xarray](https://docs.xarray.dev/en/stable/).
120+
**BEAM** is a collection of independent yet complementary open-source tools for
121+
analysing EPOCH simulations, designed to be modular so researchers can adopt only
122+
the components they require without being constrained by a rigid framework. In
123+
line with the **FAIR principles — Findable**, **Accessible**, **Interoperable**,
124+
and **Reusable** — each package is openly published with clear documentation and
125+
versioning (Findable), distributed via public repositories (Accessible), designed
126+
to follow common standards for data structures and interfaces (Interoperable), and
127+
includes licensing and metadata to support long-term use and adaptation (Reusable).
128+
The packages are as follows:
129+
130+
- [sdf-xarray](https://github.com/epochpic/sdf-xarray): Reading and processing SDF
131+
files and converting them to [xarray](https://docs.xarray.dev/en/stable/).
115132
- [epydeck](https://github.com/epochpic/epydeck): Input deck reader and writer.
116-
- [epyscan](https://github.com/epochpic/epyscan): Create campaigns over a given parameter space using various sampling methods.
133+
- [epyscan](https://github.com/epochpic/epyscan): Create campaigns over a given
134+
parameter space using various sampling methods.
117135

118136
## PlasmaFAIR
119137

0 commit comments

Comments
 (0)