You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-18Lines changed: 36 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,10 @@
8
8
[](https://sdf-xarray.readthedocs.io)
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.
65
65
66
66
> [!IMPORTANT]
67
67
> If your simulation has multiple `output` blocks so that not all variables are
@@ -86,34 +86,52 @@ print(ds)
86
86
87
87
## Citing
88
88
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.
90
92
91
93
## Contributing
92
94
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.
94
98
95
99
### How to Contribute
96
100
97
101
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.
102
102
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.
103
110
104
111
All code is automatically linted, formatted, and tested via GitHub Actions.
105
112
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)
107
115
108
116
## Broad EPOCH Analysis Modules (BEAM)
109
117
110
118

111
119
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/).
115
132
-[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
0 commit comments