#!/usr/bin/env python3
#
# chem_dryp.py --- Dry Deposition of Particles
#                  See HYSPLIT Tutorial Sec. 11.3
#
# Change history:
#  3 Nov 2025 (BB) - standard-aligned, cross-platform version
# 11 Dec 2025 (SZ) - minor edits for style consistency
#                  - add help text
#                  - create images when DSP=NO
# 18 Jun 2026 (SZ) - standardize code for run_cmd(), convert_html_to_img(),
#                    etc. across Python scripts
#                  - ensure encoding is specified when opening files

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 "chem_dryp.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 clean(pattern: str):
    """Delete files matching pattern in working directory."""
    for f in Path(".").glob(pattern):
        try:
            f.unlink()
        except:
            pass


def exe(pgm: Path, name: str, suffix: str):
    """Return full path to HYSPLIT executable."""
    return str(pgm / "exec" / f"{name}{suffix}")


def write_ascdata(pgm: Path):
    clean("ASCDATA.CFG")
    with open("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")


# CAPTEX constants from BAT
syr, smo, sda, shr = 83, 9, 25, 17
lat, lon, lvl = 39.90, -84.22, 10.0
run_hrs, top = 25, 10000.0

met_dir = TTR / "captex"
dat_name = "captex2_wrf27uw.bin"
map_path = PGM / "graphics" / "arlmap"
inp_name = "hysplit2.bin"

write_ascdata(PGM)


def write_control_dryp():
    with open("CONTROL", "w", encoding="ascii") as f:
        f.write(f"{syr:02d} {smo:02d} {sda:02d} {shr:02d}\n")
        f.write("1\n")
        f.write(f"{lat:.2f} {lon:.2f} {lvl:.1f}\n")
        f.write(f"{run_hrs}\n")
        f.write("0\n")
        f.write(f"{top:.1f}\n")
        f.write("1\n")
        f.write(f"{str(met_dir)}{os.sep}\n")
        f.write(f"{dat_name}\n")
        f.write("1\n")
        f.write("PMCH\n")
        f.write("67000.0\n")
        f.write("3.0\n")
        f.write("00 00 00 00 00\n")
        f.write("1\n")
        f.write("42.0 -78.0\n")
        f.write("0.25 0.25\n")
        f.write("15.0 25.0\n")
        f.write(f".{os.sep}\n")
        f.write(f"{inp_name}\n")
        f.write("2\n")
        f.write("0 100\n")
        f.write("83 09 25 18 00\n")
        f.write("83 09 28 15 00\n")
        f.write("00 03 00\n")
        f.write("1\n")
        f.write("1.0 1.0 1.0\n")
        f.write("0.01 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")


def write_setup(ichem: int=None):
    clean("SETUP.CFG")
    with open("SETUP.CFG", "w", encoding="ascii") as f:
        f.write("&SETUP\n")
        if ichem is not None:
            f.write(f"ichem = {ichem},\n")
        f.write("numpar = 20000,\n")
        f.write("maxpar = 100000,\n")
        f.write("/\n")


def label(title: str):
    with open("LABELS.CFG", "w", encoding="ascii") as f:
        f.write(f"'TITLE&','### chem_dryp.py: {title} ### &'\n")


# -------- Run 1: dry mass deposition (ichem default) --------
write_control_dryp()
write_setup(ichem=None)
clean(inp_name)

run_cmd([exe(PGM, "hycs_std", exe_suffix)],
        "Running hycs_std (dry particulate)")

msg = Path("MESSAGE")
msg_drypart = Path("MESSAGE_drypart.txt")
if msg.exists():
    msg_drypart.unlink(missing_ok=True)
    msg.rename(msg_drypart)

clean("plot_drypart.html")
label("1 cm/s dry mass dep")

run_cmd([exe(PGM, "concplot", exe_suffix),
         "+g1", f"-i{inp_name}", "-oplot_drypart",
         "-z80", "-x1.0E+12", "-y1.0E+12",
         "-upg", "-b0", "-t100", "-r3", f"-j{map_path}"],
        "Create plot_drypart")

html_file = OUT / "plot_drypart.html"
if html_file.exists():
    if DSP == "YES":
        webbrowser.open(html_file.resolve().as_uri())
        input("Press Enter to continue...")
else:
    print("WARNING: plot_drypart.html not generated.")

# -------- Run 2: dry “prob” option (ichem=5) --------
write_control_dryp()
write_setup(ichem=5)
clean(inp_name)

run_cmd([exe(PGM, "hycs_std", exe_suffix)],
        "Running hycs_std (ichem=5 dry prob)")

msg = Path("MESSAGE")
msg_dryprob = Path("MESSAGE_dryprob.txt")
if msg.exists():
    msg_dryprob.unlink(missing_ok=True)
    msg.rename(msg_dryprob)

clean("plot_dryprob.html")
label("1 cm/s dry part dep")

run_cmd([exe(PGM, "concplot", exe_suffix),
         "+g1", f"-i{inp_name}", "-oplot_dryprob",
         "-z80", "-x1.0E+12", "-y1.0E+12",
         "-upg", "-b0", "-t100", "-r3", f"-j{map_path}"],
        "Create plot_dryprob")

html_file = OUT / "plot_dryprob.html"
if html_file.exists():
    if DSP == "YES":
        webbrowser.open(Path("plot_dryprob.html").resolve().as_uri())
        input("Press Enter to continue...")
else:
    print("WARNING: plot_dryprob.html not generated.")

# ---------------- Print last 26 lines of MESSAGE files ----------------
if msg_drypart.exists():
    print("Last 26 lines of MESSAGE_drypart:")
    with msg_drypart.open(encoding="ascii", errors="ignore") as f:
        lines = f.readlines()[-26:]
        for line in lines:
            print(line, end="")
if msg_dryprob.exists():
    print("Last 26 lines of MESSAGE_dryprob:")
    with msg_dryprob.open(encoding="ascii", errors="ignore") as f:
        lines = f.readlines()[-26:]
        for line in lines:
            print(line, end="")

print("chem_dryp.py DONE.")