PyMHD 0.1.0__py3-none-any.whl

pymhd-0.1.0.dist-info/METADATA

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: PyMHD
+Version: 0.1.0
+Summary: A Python package for post-processing MHD turbulence simulations
+Project-URL: Homepage, https://github.com/PlasmaHua/PyMHD
+Project-URL: Repository, https://github.com/PlasmaHua/PyMHD.git
+Project-URL: Issues, https://github.com/PlasmaHua/PyMHD/issues
+Author-email: "Yuyang Hua (华宇阳)" <yuyanghua@stu.pku.edu.cn>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: h5py>=3.10
+Requires-Dist: jax>=0.4.26
+Requires-Dist: kdepy>=1.1
+Requires-Dist: matplotlib>=3.7
+Requires-Dist: numpy>=1.26
+Requires-Dist: yt>=4.2
+Description-Content-Type: text/markdown
+
+# PyMHD
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.20749062.svg)](https://doi.org/10.5281/zenodo.20749062)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/PlasmaHua/PyMHD/blob/main/LICENSE)
+
+
+A Python package for post-processing magnetohydrodynamic (MHD) turbulence simulations.
+
+## Features
+
+- [x] High-fidelity ***a posteriori* estimation of numerical dissipation** in MHD turbulence simulations;
+- [x] Computation and visualization of turbulent energy spectra;
+- [x] Visualization of 2D slices of MHD variables;
+- [x] Built-in support for simulations from the Athena family, including [Athena++](https://github.com/PrincetonUniversity/athena), [AthenaK](https://github.com/IAS-Astrophysics/athenak), and [AthenaPK](https://github.com/parthenon-hpc-lab/athenapk);
+- [x] Support for **driven MHD turbulence** (e.g., Alfvénic turbulence and small-scale dynamos), driven hydrodynamic turbulence, and **MRI-driven turbulence** (from shearing-box simulations) with triply periodic boundary conditions;
+- [ ] Support for adiabatic and isothermal equations of state (EoS); **TODO:** add support for incompressible EoS;
+- [ ] **TODO:** Computation and visualization of correlation functions;
+- [ ] **TODO:** Spectral energy transfer analysis following [Grete, Philipp, et al. Physics of Plasmas 24.9 (2017)](https://doi.org/10.1063/1.4990613).
+- [ ] **TODO:** Support JAX acceleration on GPUs and multi-node CPUs (currently, certain algorithms support parallelism on single-node, multi-core CPUs).
+
+
+## Quick Start
+
+### Installation
+
+Install **PyMHD** from [PyPI](https://pypi.org/) via:
+
+```bash
+pip install pymhd
+```
+
+This will automatically install PyMHD and its required dependencies, including:
+- [NumPy](https://github.com/numpy/numpy) for core computation;
+- [JAX](https://github.com/jax-ml/jax) for parallel acceleration on single-node, multi-core CPUs; therefore, [the CPU version of JAX](https://docs.jax.dev/en/latest/installation.html#pip-installation-cpu) is required;
+- [yt](https://github.com/yt-project/yt) and [h5py](https://github.com/h5py/h5py) for extracting data from HDF5 output files, specifically Athena++ `.athdf` files, AthenaK `.bin` files, and AthenaPK `.phdf` files;
+- [Matplotlib](https://github.com/matplotlib/matplotlib) for plotting functionality in the `pymhd.plot` modules;
+- [KDEpy](https://github.com/tommyod/KDEpy) for plotting smoothed histograms of numerical dissipation data in the `pymhd.plot.nd` module.
+
+### Built-in Examples
+
+For a quick start, clone the source repository, for example:
+
+```bash
+git clone https://github.com/PlasmaHua/PyMHD.git
+```
+
+Then navigate to the `./examples` subdirectory using `cd PyMHD/examples`, where two AthenaK simulation examples are provided.
+
+Under construction.
+
+### Analyze Your Own Athena Simulations
+
+PyMHD natively supports simulations from Athena++, AthenaK, and AthenaPK. Use the `pymhd.output2turbulence` function to extract output data and input-file metadata, then construct a PyMHD `Turbulence` object for further analysis.
+
+## API Documentation
+
+Under construction.
+
+## Citation
+
+If PyMHD contributes to your work in any way, please consider citing the package via:
+
+```bibtex
+@misc{Hua2026,
+  doi = {10.5281/zenodo.20749062},
+  url = {https://zenodo.org/doi/10.5281/zenodo.20749062},
+  author = {Hua, Yuyang},
+  title = {PyMHD: Python package for post-processing MHD turbulence simulations},
+  publisher = {Zenodo},
+  year = {2026},
+  copyright = {MIT License}
+}
+```
+
+If you specifically use the framework for numerical dissipation estimation, please cite our method paper via:
+
+```bibtex
+
+```

pymhd-0.1.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+pymhd/__init__.py,sha256=OpJDchlMN8WR0qLv40h6UZ8tJbP8h6DwrSWsgHgC68E,817
+pymhd/numdiss.py,sha256=6O2j_lb0V1bdClRNzaU_OGeMVX8PgexyoRGruBqIlaY,21197
+pymhd/spectra.py,sha256=ZrrWMPsuKg1TiDRo4e_IpgZD1TQ-h-NABzklLvmP4Ts,12672
+pymhd/turbulence.py,sha256=a1Ua1-JSw0YeZrWu3wNfvAPKK2hKpHFboSFZAXi2jS0,30684
+pymhd/derivatives/TENO.py,sha256=vKu3ClHzfemVgojU2BGg429D09WmhsMVGEnDCTLtau0,9252
+pymhd/derivatives/WENO.py,sha256=0Y76rfB4M5nNFZf82L88jcy41s6RvoTg7tooNIyF1DQ,11000
+pymhd/derivatives/__init__.py,sha256=utUSSfp-P23mmOCgnf3j-qBhV-f-BbMwgXwbEMcpw5s,437
+pymhd/derivatives/compact.py,sha256=13SuYceV-lJgXEJKve_-b6g1IUCknU8kpNqjzlqr6Yo,12310
+pymhd/derivatives/derivative.py,sha256=F_u7D_LxPX8xphVRFdqFUk79rNp4D6AIfLlzz19MIzo,28060
+pymhd/plot/__init__.py,sha256=h26dka3hy3A9a8hWvnlvCB1CjFKE5D0OEJNbzLTqMXo,1338
+pymhd/plot/nd.py,sha256=nhP8pxNkLsS-h2lLgaeVj9KwA_cr_6p9lEZkjsXz2G8,59501
+pymhd/plot/slc.py,sha256=1BBHvkpf40ffyYmbRn4rWJzKAEpbuNBcCwV4T3rF4q4,24761
+pymhd/plot/spc.py,sha256=Ps-nE3GNdgXg1Mst5ATcqYZjABPZXe81no04xOGYuBs,9062
+pymhd/preprocess/Athena.py,sha256=LFYGTwmRW1VOMvJQKz8wW7h1DB-RYHnUu27jp4RwYDY,30864
+pymhd/preprocess/__init__.py,sha256=NpCBvvA64KI5xz4eDNf4-qnlHPEPLRzeJyZab3bmYsM,2435
+pymhd/preprocess/helper/NOTICE,sha256=tE7vFqwS-DSvKTjT_ALrGvuBRyI3-r8B0yJTzlP29eE,1953
+pymhd/preprocess/helper/bin_convert.py,sha256=DIQi28uyYbbbZcyzMMkBwyMIrXY1lfPWYHbyIiCzEzA,71336
+pymhd/preprocess/helper/make_athdf.py,sha256=m-lyU02UWfyEUXVZPFbrKmL9mbsvLNtmBPdxOwRk_do,1430
+pymhd-0.1.0.dist-info/METADATA,sha256=qMe9NXH1t-AXg62Xs2oau4nwRQLiHZjpODMmyX4Usq8,4371
+pymhd-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+pymhd-0.1.0.dist-info/licenses/LICENSE,sha256=s5k1ebx6U1pb4SHgd9TDmBrFbOYncQG6veiwJzP7Ksg,1067
+pymhd-0.1.0.dist-info/RECORD,,

pymhd-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

pymhd-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yuyang HUA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.