#!/usr/bin/env python3
#
# conc_view.py --- Single Particle Animation
#                  See HYSPLIT Tutorial Sec. 7.4
#
# Change history:
# 25 Aug 2025 (BB) - standard-aligned, cross-platform version
# 25 Aug 2025 (SZ) - use backward slash as directory separator for Windows PC.
#                  - change the image filenames.
#                  - use lowercase for variable names other than command-line arguments.
#                  - use os.sep for directory separator.
# 18 Jun 2026 (SZ) - standardize code for run_cmd(), convert_html_to_img(),
#                    etc. across Python scripts
#                  - ensure encoding is specified when opening files
#                  - correct convert_html_to_anim() for ImageMagick 7.x and later

import os
import sys
import platform
from pathlib import Path
import subprocess
import webbrowser

if sys.version_info < (3, 8):
    print("Please use Python 3.8 or higher.")
    sys.exit(1)

system = platform.system().lower()
if system == "windows":
    PGM = Path(sys.argv[1]) if len(sys.argv) > 1 else Path("C:\\hysplit")
    OUT = Path(sys.argv[2]) if len(sys.argv) > 2 else PGM / "working"
    DSP = sys.argv[3] if len(sys.argv) > 3 else "YES"
    TTR = Path(os.environ.get("TTR", "C:\\Tutorial"))
    exe_suffix = ".exe"
else:
    PGM = Path(sys.argv[1]) if len(sys.argv) > 1 else Path.home() / "hysplit"
    OUT = Path(sys.argv[2]) if len(sys.argv) > 2 else PGM / "working"
    DSP = sys.argv[3] if len(sys.argv) > 3 else "YES"
    TTR = Path(os.environ.get("TTR", Path.home() / "tutorial"))
    exe_suffix = ""

if not PGM.exists():
    script = Path(__file__).name if "__file__" in globals() else "conc_view.py"
    print(f"ERROR: HYSPLIT not found at {PGM}")
    print(f"""
Please specify the path to your HYSPLIT installation using a command-line argument:

python {script} YOUR_HYSPLIT_DIRECTORY [OUT] [DSP (YES|NO)]

Example:
    python {script} C:\\hysplit C:\\hysplit\\working YES
""")
    sys.exit(1)

if not TTR.exists():
    print(f"ERROR: HYSPLIT tutorial not found at {TTR}")
    print("""
Please set the TTR environment variable to point to your HYSPLIT tutorial directory.

For Windows users (Command Prompt):
   SET TTR=YOUR_HYSPLIT_TUTORIAL_DIRECTORY

For Linux users (bash shell):
   export TTR='YOUR_HYSPLIT_TUTORIAL_DIRECTORY'

For Linux users (csh or tcsh shell):
   setenv TTR 'YOUR_HYSPLIT_TUTORIAL_DIRECTORY'""")
    sys.exit(1)

os.chdir(OUT)


# ------------------------------------------------------------------
# Helper functions
# ------------------------------------------------------------------

def run_cmd(cmd, desc="", allow_fail=False, stdout_file=None, append=False):
    if desc:
        print(f"{desc}...")

    exitcode = 0
    with subprocess.Popen(cmd,
                         stdout=subprocess.PIPE,
                         stderr=subprocess.STDOUT,
                         text=True) as p:
        if stdout_file:
            mode="a" if append else "w"
            with open(stdout_file, mode, encoding="utf-8") as f_out:
                for ln in p.stdout:
                    print(ln, end="")
                    f_out.write(ln)
        else:
            with p.stdout as f:
                for ln in iter(f.readline, b'\n'):
                    if len(ln) == 0:
                        break
                    print(ln.rstrip())

        done = False
        while not done:
            try:
                exitcode = p.wait(timeout=1)
                done = True
            except subprocess.TimeoutExpired:
                print("WARN: subprocess timed out.")

    if exitcode != 0:
        if allow_fail:
            print(f"WARN: command failed with exit code {exitcode} -> {' '.join(cmd)}")
        else:
            print(f"ERROR: command failed with exit code {exitcode} -> {' '.join(cmd)}")
            sys.exit(1)


def convert_html_to_img(html_file, img_name_frame_nums):
    # Split SVG into Linux-consistent naming: F00-sec71_001.svg, etc.
    temp_img_name = "temp"
    run_cmd([str(PGM / "exec" / f"splitsvg{exe_suffix}"),
             f"-i{html_file}", f"-o{temp_img_name}.svg"])

    # Locate ImageMagick for cross-platform conversion
    if system == "windows":
        convert_exe = None
        imgk_dir = next(
            (k for k in os.environ.get('PATH', '').split(os.pathsep)
             if "ImageMagick" in k),
            None
        )
        if imgk_dir:
            # Use magick.exe for ImageMagick 7.x and later. Use convert.exe for earlier versions.
            for cmd in ('magick', 'convert'):
                candidate = os.path.join(imgk_dir, f'{cmd}{exe_suffix}')
                if os.path.exists(candidate):
                    convert_exe = candidate
                    break
    else:
        convert_exe = "convert"

    if convert_exe:
        # Match Linux naming for DSP=NO mode exactly
        for img_name, frame_num in img_name_frame_nums:
            svg = Path(f"F{frame_num:02d}-{temp_img_name}.svg")
            run_cmd([convert_exe, str(svg), img_name])
            print(f"Converted {svg} -> {img_name}")
            svg.unlink()
    else:
        print("ImageMagick not found — skipping .svg conversion")


def convert_html_to_anim(input_html, output_gif="output.gif", img_prefix="temp"):
    # Delete files matching the "F??-{img_prefix}.svg" pattern
    for file in OUT.glob(f"F??-{img_prefix}.svg"):
        file.unlink()

    run_cmd([str(PGM / "exec" / f"splitsvg{exe_suffix}"),
             f"-i{input_html}", f"-o{img_prefix}.svg"])

    # Locate ImageMagick
    convert_exe = None
    v7_or_later = False
    if system == "windows":
        imgk_dir = next(
            (k for k in os.environ.get('PATH', '').split(os.pathsep)
             if "ImageMagick" in k),
            None
        )
        if imgk_dir:
            # Use magick.exe for ImageMagick 7.x and later. Use convert.exe for earler versions.
            for cmd in ('magick', 'convert'):
                candidate = os.path.join(imgk_dir, f'{cmd}{exe_suffix}')
                if os.path.exists(candidate):
                    convert_exe = candidate
                    if cmd == 'magick':
                        v7_or_later = True
                    break
    else:
        convert_exe = "convert"

    if convert_exe:
        if v7_or_later:
            # place -trim and +repage after the input files for ImageMagick 7.x and later
            cmd = [
                convert_exe,
                "-density", "150",
                "-loop", "100",
                "-delay", "50",
                "-background", "white",
                "-dispose", "Background",
                f"F??-{img_prefix}.svg",
                "-trim",
                "+repage",
                output_gif
            ]
        else:
            cmd = [
                convert_exe,
                "-trim",
                "+repage",
                "-density", "150",
                "-loop", "100",
                "-delay", "50",
                "-background", "white",
                "-dispose", "Background",
                f"F??-{img_prefix}.svg",
                output_gif
            ]
        run_cmd(cmd)
        print(f"{output_gif} created successfully")
    else:
        print("ImageMagick not found — GIF not generated")


def find_met_dir(dat_name: str) -> Path:
    env_override = os.environ.get("METDIR")
    candidates = []
    if env_override:
        candidates.append(Path(env_override))
    candidates += [
        wrk / "captex",
        TTR / "captex",
        TTR,
        PGM / "tutorial" / "captex",
        PGM / "tutorial",
        OUT / "captex",
        PGM / "met",
        PGM / "meteorology",
    ]
    for base in candidates:
        if base and (base / dat_name).exists():
            return base
    for root in [TTR, wrk, PGM]:
        try:
            for p in Path(root).rglob(dat_name):
                return p.parent
        except Exception:
            pass
    return None


# ---------- Mirror BAT variables ----------
wrk = OUT.parent
syr, smo, sda, shr = 83, 9, 25, 17
lat, lon, lvl = 39.90, -84.22, 10.0
run, top = 12, 10000.0
dat = "captex2_wrf27uw.bin"


# --------- Locate meteorology dynamically ---------
met = find_met_dir(dat)
if met is None:
    print(f"ERROR: Meteorological file not found for {dat}")
    print("Set METDIR or move CAPTEX under the parent of OUT.")
    sys.exit(1)

# --------- Cleanup ---------
for fname in ["ASCDATA.CFG", "LABELS.CFG", "SETUP.CFG", "cdump", "CONTROL"]:
    f = OUT / fname
    if f.exists():
        f.unlink()

# --------- ASCDATA.CFG ---------
with open(OUT / "ASCDATA.CFG", "w", encoding="ascii") as f:
    f.write("-90.0   -180.0  lat/lon of lower left corner  \n")
    f.write("1.0     1.0     lat/lon spacing in degrees    \n")
    f.write("180     360     lat/lon number of data points \n")
    f.write("2               default land use category     \n")
    f.write("0.2             default roughness length (m)  \n")
    f.write(f"'{PGM / 'bdyfiles'}{os.sep}'  directory of files \n")

# --------- CONTROL ---------
odir = f".{os.sep}"
with open(OUT / "CONTROL", "w", encoding="ascii") as f:
    f.write(f"{syr} {smo} {sda} {shr}\n")
    f.write("1\n")
    f.write(f"{lat} {lon} {lvl}\n")
    f.write(f"{run}\n")
    f.write("0\n")
    f.write(f"{top}\n")
    f.write("1\n")
    f.write(f"{met}{os.sep}\n")
    f.write(f"{dat}\n")
    f.write("1\n")
    f.write("TEST\n")
    f.write("100.0\n")
    f.write("0.01\n")
    f.write("00 00 00 00 00\n")
    f.write("1\n")
    f.write("0.0 0.0\n")
    f.write("0.05 0.05\n")
    f.write("30.0 30.0\n")
    f.write(f"{odir}\n")
    f.write("cdump\n")
    f.write("1\n")
    f.write("5000\n")
    f.write("00 00 00 00 00\n")
    f.write("00 00 00 00 00\n")
    f.write("01 01 00\n")
    f.write("1\n")
    f.write("0.0 0.0 0.0\n")
    f.write("0.0 0.0 0.0 0.0 0.0\n")
    f.write("0.0 0.0 0.0\n")
    f.write("0.0\n")
    f.write("0.0\n")

# --------- SETUP.CFG ---------
with open(OUT / "SETUP.CFG", "w", encoding="ascii") as f:
    f.write("&SETUP\n")
    f.write(" numpar = 1,\n")
    f.write("/\n")

# --------- Run model ---------
run_cmd([str(PGM / "exec" / f"hycs_std{exe_suffix}")], "Running hycs_std")

# --------- LABELS.CFG ---------
(OUT / "LABELS.CFG").write_text(f"'TITLE&','### {Path(sys.argv[0]).name} ### &'\n",
                                encoding="ascii")

# --------- Plot results ---------
run_cmd([
    str(PGM / "exec" / f"concplot{exe_suffix}"),
    "+g1", "-icdump", "-z80",
    f"-j{PGM / 'graphics' / 'arlmap'}"
], "Plotting concentration")

html_file = OUT / "concplot.html"
if html_file.exists():
    if DSP == "YES":
        webbrowser.open(str(html_file.resolve()))
    else:
        convert_html_to_img(str(html_file), [("cbase011.png", 1)])
        convert_html_to_anim(str(html_file), "cbase012.gif")
else:
    print("Warning: concplot.html not generated")

print("\nScript completed successfully!")