❯ NEOPAX - Neoclassical Transport Package in JAX

Table of Contents

• Overview
• Features
• Project Structure
• Getting Started
  • Prerequisites
  • Installation
    • From PyPI
    • From Source
• Usage
• Testing
• Project Roadmap
• Contributing
• License
• Acknowledgments

Overview

NEOPAX aims to be a simple JAX framework to solve radial transport equations for stellarators allowing for the optimization of different neoclassical quantities of interest.

Quick Start

To install NEOPAX you just need to:

git clone https://github.com/uwplasma/NEOPAX.git
cd NEOPAX 
pip install .

At the moment the code makes use of a Monkes-JAX monoenergetic database Dij(r,collisionality,Er). To obtain these you can use Monkes-JAX, see: https://github.com/monkes

Examples

To run an exanmple simply do:

''' python ./examples/Calculate_Fluxes/Fluxes_Calculation_comparison.py '''

Contributing