Skip to content

Add BEAM section #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 1 commit into from
Feb 10, 2025
Merged

Add BEAM section #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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.
4 changes: 2 additions & 2 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
cff-version: 1.2.0
title: >-
epyscan - Create campaigns of EPOCH runs over a given parameter space using various sampling methods
title: 'epyscan: Generate EPOCH campaigns over a parameter space using different sampling methods'
message: 'If you use this software, please cite it using the metadata from this file.'
type: software
repository-code: 'https://github.com/PlasmaFAIR/epyscan'
authors:
- family-names: Hill
given-names: Peter
Expand Down
23 changes: 20 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# epyscan

Create campaigns of EPOCH runs over a given parameter space using
various sampling methods
![PyPI](https://img.shields.io/pypi/v/epyscan?color=blue)
![Build/Publish](https://github.com/PlasmaFAIR/epyscan/actions/workflows/build_publish.yml/badge.svg)
![Tests](https://github.com/PlasmaFAIR/epyscan/actions/workflows/tests.yml/badge.svg)

Epyscan generates [EPOCH](https://epochpic.github.io/) campaigns over a parameter space using different sampling methods. Part of [BEAM](#broad-epoch-analysis-modules-beam) (Broad EPOCH Analysis Modules).

## Installation

Expand Down Expand Up @@ -74,5 +77,19 @@ with open("paths.txt", "w") as f:
# example_campaign/run_0_1000000/run_0_10000/run_0_100/run_0
# example_campaign/run_0_1000000/run_0_10000/run_0_100/run_1
# example_campaign/run_0_1000000/run_0_10000/run_0_100/run_2
# example_campaign/run_0_1000000/run_0_10000/run_0_100/run_3
# ...
```

## Citing

If epyscan contributes to a project that leads to publication, please acknowledge this by citing epyscan. 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.