Metadata-Version: 2.4
Name: petram_rfp
Version: 26.9.20
Summary: Plasma wave physics for RF module
Author: S. Shiraiwa
Maintainer-email: "S. Shiraiwa" <shiraiwa@princeton.edu>
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://github.com/piScope/Petra-M--RFP
Project-URL: Download, https://github.com/piScope/Petra-M--RFP
Keywords: scientific computing,waves in plasmas
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: petram_rf>=26.1.0
Requires-Dist: numba>=0.59
Provides-Extra: test
Requires-Dist: pytest>=7; extra == "test"
Requires-Dist: scipy; extra == "test"
Dynamic: license-file

## Petra-M(RFP)

Additional module for waves in plasmas

### Install
```bash
python -m pip install .
```

### EM3D : Frequency domain Maxwell equation in 3D
  Domain:   
 *    EM3D_ColdPlasma  : Cold magnetised plasma
 *    EM3D_LkPlasma    : local-K approx. plasma
 
### EM2Da : Frequency domain Maxwell equation in 2D axissymetric space
  Domain:   
 *    EM2Da_ColdPlasma  : Cold magnetised plasma
 *    EM2Da_LkPlasma    : local-K approx. plasma

### EM2D : Frequency domain Maxwell equation in 2D space
  Domain:   
 *    EM2D_ColdPlasma  : Cold magnetised plasma
 *    EM2D_LkPlasma    : local-K approx. plasma

### EM1D : Frequency domain Maxwell equation in 1D
  Domain:   
 *    EM1D_ColdPlasma  : Cold magnetised plasma
 *    EM1D_LkPlasma    : local-K approx. plasma 
 

### Dielectric backend
The dielectric kernel for cold and lkplasma model is provided by C extensions
or by Numba compiled functions. By default, C extensions are used, and selected
models are loaded to `petram.phys.common.coldplasma` and `petram.phys.common.lkplasma`.

To use the original Numba kernels, set the enviromental variable, before loading the
module. Both facades expose `BACKEND` (`"ext"` or `"numba"`).

```bash
export PETRAM_RFP_USE_NUMBA_DIELECTRIC=1
```
