Skip to content

Update citation and add BEAM section to README #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZedThree merged 6 commits into from
Feb 6, 2025
Merged

Update citation and add BEAM section to README #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
da7fb14
Update CITATION.cff
JoelLucaAdams Feb 5, 2025
630a9e4
Update README with BEAM
JoelLucaAdams Feb 5, 2025
411126f
Add open-source to README
JoelLucaAdams Feb 5, 2025
3faf911
Change wikilinks to regular markdown
JoelLucaAdams Feb 6, 2025
f7a5c36
Update CITATION.cff
JoelLucaAdams Feb 6, 2025
b5b1ed3
Update README.md
JoelLucaAdams Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added BEAM.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 2 additions & 3 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
cff-version: 1.2.0
title: >-
epydeck - An EPOCH plasma PIC code input file (deck)
reader/writer
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'
authors:
- family-names: Hill
given-names: Peter
Expand Down
34 changes: 28 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# epydeck

An EPOCH plasma PIC code input file (deck) reader/writer.
![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)

> [!IMPORTANT]
> Plain numbers and bools are converted directly, everything else is
> represented as a string. Note that floating point numbers may have
> their exact form changed.
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).

## Installation

Expand All @@ -27,6 +26,11 @@ We recommend switching to [uv](https://docs.astral.sh/uv/) to manage packages.

## Usage

> [!IMPORTANT]
> Plain numbers and bools are converted directly, everything else is
> represented as a string. Note that floating point numbers may have
> their exact form changed.

The interface follows the standard Python
[`json`](https://docs.python.org/3/library/json.html) module:

Expand Down Expand Up @@ -66,7 +70,9 @@ print(epydeck.dumps(deck))
# ...
```

## Further Examples
<details>

<summary>Further details</summary>

Reads from file into a standard Python `dict`. Repeated blocks, such
as `species`, have an extra level of nesting using the block `name`.
Expand Down Expand Up @@ -143,3 +149,19 @@ is represented by the following `dict`:
}
}
```

</details>

## Citing

If epydeck contributes to a project that leads to publication, please acknowledge this by citing epydeck. This can be done by clicking the "cite this repository" button located near the top right of this page.

## Broad EPOCH Analysis Modules (BEAM)

![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:

- [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.