PyMHD 0.1.0__py3-none-any.whl

pymhd/preprocess/__init__.py

@@ -0,0 +1,69 @@
+# PyMHD: Python for Magnetohydrodynamic Turbulence.
+# Copyright (c) 2026 Yuyang Hua (华宇阳)
+# License: MIT
+
+"""
+pymhd/preprocess/__init__.py
+----------------------------
+
+Unified interface for extracting turbulence data from simulation outputs. Currently supports:
+    - Athena++/AthenaK/AthenaPK output files.
+"""
+
+from __future__ import annotations
+
+from typing import Sequence
+from pathlib import Path
+
+from ..turbulence import Turbulence
+
+def output2turbulence(
+    code     : str,
+    outputs  : str | Path | Sequence[str | Path] | None = None,
+    outn     : str | None = None,
+    inputfile: str | Path | None = None,
+    t1       : float | None = None,
+    t2       : float | None = None,
+    casename : str   | None = None,
+) -> Turbulence:
+    """Extract simulation output data and build a Turbulence object
+
+    Unified interface that dispatches to code-specific implementations.
+
+    Parameters
+    ----------
+    code      : simulation code name. Use 'Athena' for Athena++/AthenaK/AthenaPK.
+    outputs   : output file paths or glob pattern string
+                    e.g., ['HGB.prim.00000.athdf', 'HGB.prim.00001.athdf'] or './outputs/*.prim.*.athdf';
+                    If None, a default pattern inferred from the input file is adopted.
+    outn      : output ID for resolving output file pattern when 'outputs' is None.
+                    e.g., 'prim' for slice and spectra plots, 'nd' for numerical dissipation analysis.
+    inputfile : path to input parameter file, e.g. 'athinput.hgb', 'turb.athinput';
+                    If None, automatically detect default Athena(++/K/PK) input files.
+    t1        : start time for filtering, defaults to None (no lower limit)
+    t2        : end time for filtering, defaults to None (no upper limit)
+    casename  : case name, defaults to None (use parent directory name)
+
+    Returns
+    -------
+    Turbulence: Turbulence object containing extracted field data
+
+    Examples
+    --------
+    >>> from pymhd import output2turbulence
+    >>> turbulence = output2turbulence(code='Athena', t1=10.0, t2=20.0)
+
+    """
+    if code != "Athena":
+        raise ValueError(
+            f"Unsupported code: '{code}'. Use 'Athena' as unified entry for Athena++/AthenaK/AthenaPK."
+        )
+
+    from .Athena import output2turbulence as o2t
+
+    return o2t(casename=casename, outputs=outputs, outn=outn, inputfile=inputfile, t1=t1, t2=t2)
+
+
+__all__ = [
+    "output2turbulence"
+]

pymhd/preprocess/helper/NOTICE

@@ -0,0 +1,42 @@
+Third-Party Notice: AthenaK
+
+This directory includes code adapted from AthenaK:
+  - Upstream repository: https://github.com/IAS-Astrophysics/athenak
+  - License: BSD 3-Clause License
+  - Covered files:
+      * bin_convert.py
+      * make_athdf.py
+  - Modification notice:
+      * Adapted for integration in PyMHD.
+
+The following is the original BSD 3-Clause License:
+
+BSD 3-Clause License
+
+Copyright (c) 2020, Institute for Advanced Study / High-Performance Computing / jmstone / Athena-Parthenon
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.