Metadata-Version: 2.4
Name: epednn_mit
Version: 1.0.0
Summary: EPED network networks trained by MIT
Author-email: Aaron Ho <aaronkho@mit.edu>, Theo Brown <theo.brown@ukaea.uk>
License-Expression: MIT
Project-URL: Homepage, https://github.com/aaronkho/epednn_mit
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: <3.13,>=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pip
Requires-Dist: numpy
Provides-Extra: tensorflow
Requires-Dist: tensorflow>=2.18.1; extra == "tensorflow"
Provides-Extra: pytorch
Requires-Dist: torch>=2.4.0; extra == "pytorch"
Provides-Extra: jax
Requires-Dist: flax; extra == "jax"
Provides-Extra: torax
Requires-Dist: torax; extra == "torax"
Requires-Dist: epednn_mit[jax]; extra == "torax"
Dynamic: license-file

# epednn_mit
EPED neural networks trained at MIT

TORAX interfaces currently under development.

## Disclaimer

Any results of the EPEDNN models in this repository are **not** considered to be official EPED results,
due to the approximate nature of surrogate models. Usage of the NN results do not automatically
assume agreement from the authors of the original EPED model.

If these NN models are used for any work that is intended for publication or conference presentation,
its users are requested to verify the NN results against EPED itself and contact the original EPED authors
(P.B. Snyder or H.R. Wilson) to verify results prior to publication. More info on EPED can be found in the
citations below.

## Citations

EPED: [P.B. Snyder et al Nucl. Fusion 51 103016 (2011)](http://doi.org/10.1088/0029-5515/51/10/103016),
[P.B. Snyder et al Phys. Plasmas 19 056115 (2012)](https://doi.org/10.1063/1.3699623)

SPARC model: [M. Muraca et al Nucl. Fusion 65 096010 (2025)](https://doi.org/10.1088/1741-4326/adf656)
