JPEC.jl

A Julia implementation of the Generalized Perturbed Equilibrium Code suite

JPEC.jl is a work-in-progress Julia port of the Generalized Perturbed Equilibrium Code (GPEC) suite, providing tools for magnetohydrodynamic (MHD) equilibrium and stability analysis in fusion plasmas.

Overview

JPEC provides functionality for:

some stuff Fill this in later

Installation

using Pkg
Pkg.add("JPEC")

Quick Start

using JPEC

# Great question

Modules

Splines Module
Vacuum Module

Examples

The package includes several Jupyter notebook examples:

example.ipynb: Fill this in later

Developer Notes

Commit Messages

To assist with release note compilation, please follow the commit message format:

CODE - TAG - Detailed message

where CODE is EQUIL, DCON, VAC, etc. and TAGs are descriptors like WIP, MINOR, IMPROVEMENT, BUG FIX, NEW FEATURE, etc.

Additionally, please see this google doc for more details on using the GitHub.